GDB-Python 脚本：通过 C/C++ 结构字段迭代的任何示例

Question

新的GDB-Python scripting API 看起来很强大，应该很有用。然而，编写一个有用的脚本来遍历 C 或 C++ 结构中的字段并非易事。有谁知道一些确实可以做到这一点的固体样品？

提前致谢。

---

更新最终示例：替换早期示例中的_print_fields()。

    if l.type.code == gdb.TYPE_CODE_STRUCT:
        print "Found a struct  %s " % n
        #self._print_fields(n, t)
        self._print_deep_items(n, t, l)
    else:
        print "Found no struct"

def _print_deep_items (self, n_, type_, instance_):
    for fld in type_.fields():
        fn = fld.name
        ft = fld.type
        fv = instance_[fn]
        if fv.type.code == gdb.TYPE_CODE_STRUCT:
            print "  Found a sub struct  %s " % fn
            self._print_deep_items(fn, ft, fv)
        else:
            print "    Field %s " % fn, " type %s " % ft.tag, " value %s " % fv

然后输出：

  variable s1   type S1
Found a struct  s1
    Field v1   type None   value 0
    Field v2   type None   value 0
  Found a sub struct  v3
    Field w3   type None   value 0

---

使用第一个示例进行更新：使以下示例代码正常工作。这不是最佳的，因为它在组成字符串字段名称后对每个字段进行查找。 abarnert 展示了一种有前途且优雅的方法，工作代码在上述最终更新部分进行了更新。

import gdb
class PrintGList(gdb.Command):
    """print fields of a struct: wzd struct_object

Iterate through the fields of a struct, and display
a human-readable form of the objects."""
    def __init__(self):
        gdb.Command.__init__(self, "wzd", gdb.COMMAND_DATA, gdb.COMPLETE_SYMBOL, True)

    def invoke(self, arg, from_tty):

        arg_list = gdb.string_to_argv(arg)
        if len(arg_list) < 1:
            print "usage: wzd struct"
            return

        n = arg_list[0]
        l = gdb.parse_and_eval(arg_list[0])
        m = l.type.tag

        print "  variable %s " % n, " type %s " % m
        try:
            t = gdb.lookup_type(m)
        except RuntimeError, e:
            print "type %s not found" % t
            return

        if l.type.code == gdb.TYPE_CODE_STRUCT:
            print "Found a struct  %s " % n
            self._print_fields(n, t)
        else:
            print "Found no struct"

    def _print_fields(self, n, typeobject):
        print typeobject
        flds = typeobject.fields()
        for x in flds:
            sn = n + "." + x.name
            print "  field %s" % sn, " code %s " % x.type.code, " type %s " % x.type.tag
            if x.type.code == gdb.TYPE_CODE_STRUCT:
                print "Found sub level struct  %s " % sn
                sl = gdb.parse_and_eval(sn)
                sm = sl.type.tag
                st = gdb.lookup_type( sm )
                self._print_fields(sn, x.type)

    def _deep_items (self, type_):
        for k, v in type_.iteritems():
            if k:
                print " k v %s " % k , " %s " % v
            else:
                print "   v    ",      " %s " % v

PrintGList()

要测试的源文件：

struct S2 {        int w3;    };
struct S1 {        int v1, v2;      struct S2 v3; } s1;
int main(int argc, char *argv[]) {   return 0; }

示例输出：

  variable s1   type S1
Found a struct  s1
S1
  field s1.v1  typecode 8   type None
  field s1.v2  typecode 8   type None
  field s1.v3  typecode 3   type S2
Found sub level struct  s1.v3
S2
  field s1.v3.w3  typecode 8   type None

GDB 会话获取： 源 /home/me/testpath/wzdfile.py 文件 a.out b 主要 r wzd s1 退出

Answer 1

根据the docs，遍历 C 结构的字段应该非常简单：

如果类型是结构或类类型，或枚举类型，则可以使用 Python 字典语法访问该类型的字段。例如，如果some_type 是一个持有结构类型的gdb.Type 实例，您可以通过以下方式访问其 foo 字段：

bar = some_type['foo']

bar 将是一个 gdb.Field 对象；请参阅下面Type.fields 方法的描述下的gdb.Field 类的描述。

您也可以使用Type.fields 显式获取struct 的字段，但是（从7.4 开始）您也可以使用普通的dict 方法，以便获取名称列表/@987654335 @对：

for name, field in foo.type.iteritems():

或者，只是名称：

for name, field in foo.type.iterkeys():

等等。

这似乎并没有直接记录在该页面上，但gdb.types 说deep_items 时非常强烈地暗示它：

返回一个类似于标准 gdb.Type.iteritems 方法的 Python 迭代器。

例如，给定这个 C 类型：

struct S {
    int x;
    int y;
};

你可以这样做：

(gdb) python struct_S = my_s.type # or gdb.lookup_type("struct S"), etc.
(gdb) python print struct_S.keys()
{['a', 'b']}
(gdb) python print my_s['a']
0

快速浏览一下types.py source，看看gdb.types.deep_item(type_) 是如何实现的，这似乎就是它的全部内容。

---

在 gdb 7.4 之前，您不能将类型直接视为 dict。也就是说，没有for name in instance_.type: 或instance_.type.iteritems() 等。您必须显式调用fields。无论如何，把它们放在一起，这是一个使用 gdb 7.2 迭代结构的所有字段的简单示例：

for field in inst.fields:
    fname = field.name
    ftype = field.type
    fval = inst[fname]

除非你的struct 里面有一个匿名的struct，否则这将不起作用。为此，您需要deep_items（如果 7.2 中没有，您需要查看代码并弄清楚如何自己实现）。

所以，在 7.2 中不是 相当 微不足道的，而是非常简单。而且，如果您想要简单，只需升级到 7.4。