Question

鉴于C ++源代码，我想找到每个函数写入和读取的类字段。使用Clang前端的最佳方法是什么？

（我不是要求对所有步骤进行详细解释;但是，有效解决方案的出发点会很棒。）

到目前为止，我尝试使用RecursiveASTVisitor解析语句，但是跟踪节点连接很困难。另外，我无法弄清楚如何跟踪下面的内容：

int& x = m_int_field;
x++;

这清楚地修改了m_int_field;但是如果给出一个Stmt则不可能知道;所以AST遍历本身似乎不够。

我可以分别计算字段和子字段（例如，访问成员结构的三个字段）。

示例：

typedef struct Y {
    int m_structfield1;
    float m_structfield2;
    Y () {
        m_structfield1 = 0;
        m_structfield2 = 1.0f;
    }
} Y;
class X {
    int m_field1;
    std::string m_field2;
    Y m_field3;
public:
    X () : m_field2("lel") {}
    virtual ~X() {}
    void func1 (std::string s) {
        m_field1 += 2;
        m_field2 = s;
    }
    int func2 () {
        return m_field1 + 5;
    }
    void func3 (Y& y) {
        int& i = m_field1;
        y.m_structfield2 = 1.2f + i++;
    }
    int func4 () {
        func3 (m_field3);
        return m_field3.m_structfield1;
    }
};

应该返回

X::X() -> m_field1 (w), m_field3.m_structfield1 (w), m_field3.m_structfield2 (w)
X::func1(std::string) -> m_field1 (r+w), m_field2 (w)
X::func2() -> m_field1 (r)
X::func3(Y&) -> m_field1 (r+w)
X::func4() -> m_field1 (r+w), m_field3.m_structfield2 (w), m_field3.m_structfield1 (r)

为简单起见，我们可以假设没有继承。

Answer 1

我一直在收集一些examples of analyzing code with Clang's AST matchers。这里有一个示例应用程序StructFieldUser，它报告结构的哪些字段被读取或写入，以及每次访问发生的函数。它与您正在寻找的不同，但它可能是一个有用的参考点。它演示了如何提取和记录这类信息，并说明了如何将所有部分组合在一起。

一般来说，AST匹配器的一个好地方是this post by Eli Bendersky。

要了解可以解决问题的匹配器，您可以使用clang-query进行练习：

$ clang-query example.cpp --    # the two dashes mean no compilation db
clang-query> let m1 memberExpr()
clang-query> m m1

Match #1:

/path/example.cpp:9:9: note: "root" binds here
        m_structfield1 = 0;
        ^~~~~~~~~~~~~~

Match #2:

/path/example.cpp:10:9: note: "root" binds here
        m_structfield2 = 1.0f;
        ^~~~~~~~~~~~~~
...
11 matches.

然后，您可以使用遍历匹配器开始连接到其他节点。这使您可以捕获相关的上下文，例如引用该引用的函数或类方法。将bind表达式添加到节点匹配器将帮助您准确了解匹配的内容。绑定节点还将允许访问回调中的节点。

clang-query> let m2 memberExpr(hasAncestor(functionDecl().bind("fdecl"))).bind("mexpr")
clang-query> m m2

Match #1:

/path/example.cpp/path/example.cpp:8:5: note: "fdecl" binds here
    Y () {
    ^~~~~~
/path/example.cpp:9:9: note: "mexpr" binds here
        m_structfield1 = 0;
        ^~~~~~~~~~~~~~
/path/example.cpp:9:9: note: "root" binds here
        m_structfield1 = 0;
        ^~~~~~~~~~~~~~

Match #2:

/path/example.cpp:8:5: note: "fdecl" binds here
    Y () {
    ^~~~~~
/path/example.cpp:10:9: note: "mexpr" binds here
        m_structfield2 = 1.0f;
        ^~~~~~~~~~~~~~
/path/example.cpp:10:9: note: "root" binds here
        m_structfield2 = 1.0f;
        ^~~~~~~~~~~~~~
...

学习如何获取所需的确切节点可能需要一些工作。请注意，上面的匹配器不会在X::X()中选择初始化。从

看AST

clang-check -ast-dump example.cpp --

表明这些节点不是MemberExpr个节点;它们是CXXCtorInitializer个节点，因此需要cxxCtorInitializer匹配器来获取这些节点。可能需要多个匹配器才能找到所有不同的节点。

如何使用Clang查找所有成员字段读/写？

1 个答案: