如何生成C模块仅使用的输入变量清单（含类型与结构关联）

问题描述 #

我有一个大型独立C模块，使用包含多层嵌套结构的超大输入缓冲区，该缓冲区包含数百个输入变量，但模块仅用到其中一小部分。我希望生成一份仅包含模块所用变量的清单，最好能包含变量类型及所属结构的关联信息。尝试过Doxygen 1.8.5，但它只能生成包含所有输入变量的文档。

示例代码 #

#include <stdio.h>

typedef struct subS1{
    unsigned char bIn1;
    unsigned char bIn2;
} subS1;

typedef struct S1{
    struct subS1 stMySubStruct1;
    struct subS1 stMySubStruct2;
    struct subS1 stMySubStruct3;
} MyInputStruct_t;

void Foo1(MyInputStruct_t *Input);
void Foo2(MyInputStruct_t *Input);

MyInputStruct_t stMyInputStruct = {{1, 2}, {0, 0}, {9, 6}}; // large input buffer

int main() {
    Foo1(&stMyInputStruct); // call to my Module 'main' function
    return 0;
}

void Foo1(MyInputStruct_t *Input)
{
    if(Input->stMySubStruct1.bIn1 == 1)
    {
        printf("bIn1 = %d\n", Input->stMySubStruct1.bIn1); // stMySubStruct1.bIn1 is used (read or write)
    }
    Foo2(Input);
    return;
}

void Foo2(MyInputStruct_t *Input)
{
    if(Input->stMySubStruct3.bIn2 == 0)
    {
        printf("bIn2 = %d\n", Input->stMySubStruct3.bIn2); // stMySubStruct3.bIn2 is used (read or write)
    }
    return;
}

期望输出 #

期望的Foo1()所用输入变量清单示例：

• stMyInputStruct.stMySubStruct1.bIn1 -> 在Foo1()中被使用
• stMyInputStruct.stMySubStruct1.bIn2 -> 未被使用
• ...
• stMyInputStruct.stMySubStruct3.bIn2 -> 在Foo2()中被使用

解决方案 #

方法1：基于Clang AST的脚本分析 #

Clang的抽象语法树（AST）能精准追踪变量的访问情况，通过Python结合libclang可以实现自动化提取：

1. 安装依赖：确保系统安装Clang及libclang Python包（可通过pip install clang安装）
2. 编写分析脚本（核心逻辑示例）：

import clang.cindex

# 初始化Clang索引
index = clang.cindex.Index.create()
# 解析目标C文件，替换为你的模块文件名
tu = index.parse('module_code.c', args=['-std=c99'])

# 定位目标结构体MyInputStruct_t的定义
target_struct_decl = None
for node in tu.cursor.get_children():
    if node.kind == clang.cindex.CursorKind.TYPEDEF_DECL and node.spelling == 'MyInputStruct_t':
        target_struct_decl = node.underlying_typedef_type.get_declaration()
        break

# 递归遍历嵌套结构成员，检查使用情况
def check_field_usage(struct_cursor, parent_path="stMyInputStruct"):
    for field in struct_cursor.get_children():
        if field.kind == clang.cindex.CursorKind.FIELD_DECL:
            full_path = f"{parent_path}.{field.spelling}"
            # 收集该字段在目标函数中的引用
            used_in = set()
            for ref in field.get_references():
                func_parent = ref.semantic_parent
                if func_parent.spelling in ['Foo1', 'Foo2']:
                    used_in.add(func_parent.spelling)
            # 输出结果
            if used_in:
                print(f"- {full_path} -> 在{', '.join(used_in)}()中被使用")
            else:
                print(f"- {full_path} -> 未被使用")
        # 处理嵌套结构体
        elif field.type.kind == clang.cindex.TypeKind.RECORD:
            sub_struct = field.type.get_declaration()
            check_field_usage(sub_struct, f"{parent_path}.{field.spelling}")

if target_struct_decl:
    check_field_usage(target_struct_decl)

3. 运行脚本即可得到包含所有成员使用情况的清单，还可扩展添加变量类型输出（通过field.type.spelling获取）

方法2：cscope+脚本组合 #

1. 生成cscope符号数据库：在模块代码目录执行cscope -Rbq
2. 编写脚本调用cscope查询每个结构成员的引用，筛选出模块内函数的访问记录，整理成清单

方法3：GCC编译中间文件分析 #

使用GCC编译时添加-fdump-tree-all选项，生成的中间文件会包含变量使用的详细信息，通过脚本解析这些文件提取目标变量的使用情况。

内容的提问来源于stack exchange，提问作者Sandulescu Bogdan