GDB Python扩展：如何准确获取C++宏调用的代码行与文件信息

问题背景 #

通过GDB Python扩展在some_macro_break_point函数上设置自动断点，目标是触发断点时获取宏some_macro被调用的原始代码行与文件信息。但现有实现得到的行号存在偏移：受宏调用下方注释影响时，行号为「宏调用行号+注释行数」；无注释时也有1行偏移，无法准确定位到some_macro(x)的实际调用行。

相关代码文件 #

main.cpp

#include "a.h"
int main(){

    int x[3];
    some_macro(x)
    // comment
    // comment
    return x[2];
}

a.h

template <typename T>
inline void some_macro_break_point()
{
}

#define some_macro(name)                                         \
{                                                                \
    some_macro_break_point();                     \
}

当前GDB Python实现 #

frame = gdb.newest_frame()
frame = frame.older()
pc = frame.pc()
symtab_line = gdb.find_pc_line(pc)
print(">>>> ", symtab_line.symtab.fullname() + ":" + str(symtab_line.line), "<<<<"
)

解决方法 #

问题根源是宏展开后，some_macro_break_point()的机器指令被编译器关联到宏展开后的代码位置，而非宏调用的原始位置。以下两种方案可解决该问题：

方案1：利用GDB宏调试信息（无代码侵入） #

需确保编译时添加-g3 -gdwarf-4参数（保留宏调试信息），通过GDB的宏查询API回溯到宏调用的原始位置：

def get_macro_call_location():
    frame = gdb.newest_frame()
    # 定位到调用some_macro_break_point的帧
    frame = frame.older()
    sal = frame.find_sal()
    
    # 回溯查找宏展开的原始位置
    while sal and sal.symtab:
        # 查询当前位置的宏信息
        macro_info = gdb.execute(f"info macro -location {sal.symtab.fullname()}:{sal.line}", to_string=True)
        if "expanded from macro" in macro_info:
            # 解析宏调用的原始位置
            for line in macro_info.split('\n'):
                if "expanded from macro" in line:
                    parts = line.split('at ')
                    if len(parts) == 2:
                        return parts[1].strip()
        # 继续向上遍历调用栈
        frame = frame.older()
        if not frame:
            break
        sal = frame.find_sal()
    
    # 无法获取宏信息时， fallback到原始位置（仅供参考）
    return f"{sal.symtab.fullname()}:{sal.line}"

# 输出结果
print(">>>> ", get_macro_call_location(), "<<<<" )

方案2：修改宏定义传递位置参数（侵入性强但无需特殊编译参数） #

修改宏定义，在调用some_macro_break_point时传入__FILE__和__LINE__，直接在GDB中读取这些参数：

修改后的a.h

template <typename T>
inline void some_macro_break_point(const char* file, int line)
{
}

#define some_macro(name)                                         \
{                                                                \
    some_macro_break_point(__FILE__, __LINE__);                  \
}

对应的GDB Python代码

frame = gdb.newest_frame()
# 读取函数参数中的文件和行号信息
call_file = frame.read_var("file").string()
call_line = frame.read_var("line")
print(">>>> ", f"{call_file}:{call_line}", "<<<<" )

关键注意事项 #

• 方案1依赖编译器生成的宏调试信息，GCC需显式指定-g3 -gdwarf-4，Clang类似
• 方案2无需额外编译参数，但需要修改宏定义，适合无法调整编译参数的场景

内容的提问来源于stack exchange，提问作者Ruba Rushrush