在嵌入式开发乃至广泛的C/C++程序调试中，GDB作为调试利器的地位无可替代。它的强大之处不仅在于基础的断点、单步功能，更在于其出色的扩展能力——特别是对Python脚本的支持。通过Python脚本，我们可以极大地扩展GDB的功能，实现自动化调试、定制化输出等复杂场景，从而将调试效率提升到一个新的高度。
请注意，GDB需要在构建时配置 --with-python 选项才能支持Python脚本。不过，大多数现成的二进制发行版（如各种交叉编译工具链中的GDB）通常都已启用此选项。
GDB 中的 Python 基础
获取帮助
在GDB环境中，可以直接查看与Python相关的帮助信息。
输入 help python 会显示基本用法：
(gdb) help python
python, py
Evaluate a Python command.
The command can be given as an argument, for instance:
python print (23)
If no argument is given, the following lines are read and used
as the Python commands. Type a line containing “end” to indicate
the end of the command.
(gdb)
要查看更详细的Python API帮助，可以执行 python help (gdb)：
(gdb) python help (gdb)
Help on package gdb:
NAME
gdb - # Copyright (C) 2010-2020 Free Software Foundation, Inc.
PACKAGE CONTENTS
FrameDecorator
FrameIterator
command (package)
frames
function (package)
printer (package)
printing
prompt
types
unwinder
xmethod
SUBMODULES
events
Python 脚本的存放与自动导入
GDB有一个“数据目录”(data directory)，用于存放各种辅助文件。Python脚本的默认搜索路径就在这个目录下的 python 子目录中。
你可以通过以下命令查看和设置数据目录：
(gdb) show data-directory
GDB‘s data directory is “…/directory /opt/riscv-toolchain/10.2.0/share/gdb”.
(gdb) set data-directory /opt/riscv-toolchain/10.2.0/share/gdb
(gdb)
或者，在启动GDB时通过 --data-directory 选项指定：
riscv64-unknown-elf-gdb --data-directory=/opt/riscv-toolchain/10Quit/share/gdb
一个关键特性是：放置在 data-directory/python/gdb/command 或 data-directory/python/gdb/function 目录下的Python模块，会在GDB启动时被自动导入，无需手动 source。
执行 Python 脚本的几种方式
1. 直接在 GDB 命令行中输入
在GDB提示符下输入 python 并回车，即可进入多行Python输入模式。输入脚本后，以单独一行的 end 结束。
例如，定义一个加法函数并调用：
(gdb) python
>def add_function(a,b):
> c = a + b
> print(f“{a}+{b}={c}”)
>end
(gdb) python add_function(1,2)
1+2=3
(gdb)
2. 通过脚本文件导入
将Python代码保存为 .py 文件，在GDB中使用 source 命令加载。
创建一个 add.py 文件，内容如下：
def add_function(a,b):
c = a + b
print(f“{a}+{b}={c}”)
在GDB中导入并执行：
(gdb) source add.py
(gdb) python add_function(2,3)
2+3=5
(gdb) []
其他支持与参考
GDB内置了一些Python模块来辅助脚本编写，例如 gdb.printing（美化打印）、gdb.types（类型处理）等。更完整的API和模块说明，请直接查阅GDB官方文档：
核心实例：监控函数返回值并在特定条件下暂停
调试时，我们常常会遇到这样一种需求：希望当某个函数返回一个特定值（比如错误码 0，或者一个关键的阈值）时，程序能自动暂停下来，以便我们检查此时的调用栈、变量状态等。
手动操作非常繁琐：需要在函数返回处（或函数尾部）设置断点，然后反复 continue，并手动打印返回值判断。如果这个函数被频繁调用，而目标返回值又很少出现，这个过程无异于大海捞针。
使用Python脚本，我们可以轻松实现自动化监控。下面是一个完整的示例脚本 test.py：
import gdb
class FunctionFinishBreakpoint (gdb.FinishBreakpoint):
def __init__ (self):
gdb.FinishBreakpoint.__init__(self, gdb.newest_frame(),
internal=True)
self.silent = True
def stop(self):
print(“after: {}”.format(self.return_value))
return self.return_value == 5
class FunctionBreakpoint(gdb.Breakpoint):
def __init__ (self, spec):
gdb.Breakpoint.__init__(self, spec)
self.silent = True
def stop (self):
print(“before”)
FunctionFinishBreakpoint() # set breakpoint on function return
return False # do not stop at function entry
FunctionBreakpoint(“test”)
脚本原理分析：
FunctionBreakpoint(“test”)： 在名为 test 的函数入口处设置一个断点。这个断点是“沉默的”(silent=True)，意味着触发时不会在GDB界面产生常规断点中断。FunctionBreakpoint.stop 方法： 当 test 函数被调用时，此方法被触发。它打印“before”提示，然后创建一个 FunctionFinishBreakpoint 实例。最后返回 False，告诉GDB不要在函数入口处暂停程序。FunctionFinishBreakpoint 类： 继承自 gdb.FinishBreakpoint，这是一个特殊的断点类型，设置在即将被执行的函数的“返回点”上。它也是沉默的。FunctionFinishBreakpoint.stop 方法： 当 test 函数执行完毕，即将返回时，此方法被调用。它打印出返回值，并判断返回值是否等于 5。如果等于 5，则返回 True，GDB会在此处暂停；否则返回 False，程序继续运行。
相关API参考：
测试与效果
假设我们有如下测试代码（为了调试清晰，禁用优化）：
static __attribute__((optimize(“O0”))) int test(int i)
{
return i;
}
// ... 在某个循环中调用
for(int i=0;i<10;i++){
int res = test(i);
// ... 其他操作
}
在GDB中加载调试程序，并导入我们的脚本：
(gdb) source test.py
Breakpoint 1 at 0x1000ba: file main.c, line 89.
(gdb) c
Continuing.
before
after: 0
before
after: 1
before
after: 2
before
after: 3
before
after: 4
before
after: 5
(gdb) p i
$1 = 5
(gdb)
从输出可以看到，脚本忠实地记录了每次函数调用（before）和返回（after: x）的值。当 test 函数返回 5 时，GDB自动暂停了执行。此时我们检查循环变量 i，其值正是 5，完美地捕捉到了我们想要的瞬间。
总结
通过这个实例，我们可以看到使用Python扩展GDB所带来的强大灵活性。它让原本繁琐、重复的调试操作变得自动化、智能化。你可以根据自己的需求，修改判断条件（例如返回值是否为 NULL、是否大于某个阈值等），或扩展脚本功能（如记录日志、自动修改变量等）。
掌握GDB的Python脚本功能，就如同为你的调试工具箱增添了一把瑞士军刀。平时多积累一些实用的脚本片段，在遇到复杂的调试场景时，就能快速组合出高效的解决方案。如果你对这类调试技巧和自动化实践感兴趣，欢迎到云栈社区与更多开发者交流探讨，共同积累宝贵的实战经验。
发表于 9 小时前
|
查看: 3|
回复: 0
