C Call Graph Explorer by yelingjie(C 函数调用图)
支持可提供 compile_commands.json 的 GCC C 工程(如 Makefile 工程),以及使用 Arm Compiler 5(ARMCC)或 Arm Compiler 6(ArmClang)的 Keil MDK-ARM C 工程。插件读取编译配置和已保存的源码,使用 LLVM Clang 生成调用图。
Visualize C function calls, callers, parameters, thread entry points and message queues in VS Code. Supports GCC compilation databases and Keil MDK projects, with optional Cortex-M debug values along a selected call path. English and 简体中文 interfaces are available.
能做什么
| 功能 |
使用方式 |
| 函数调用图 |
从 main 或任意函数逐层展开调用者和被调用者,点击函数或连线跳转源码。 |
| 调用路径回溯 |
从入口到目标函数查看候选路径,检查调用行、实参和形参对应关系。 |
| 参数写回与路径变量 |
查看可识别的指针参数写回、返回值接收位置,以及路径上变量的声明、作用域和读写位置。 |
| 线程与消息队列 |
浏览常见 RTOS 的任务入口,以及可按队列变量关联的发送和接收关系。 |
| 调试值联动 |
配合 Cortex-M 调试桥接插件,在暂停时读取所选变量,区分当前值与历史观测。 |
| 增量分析 |
复用缓存,只重新扫描修改文件及受影响的依赖;也可完整重扫。 |
调用图和线程关系来自静态分析,表示可能的调用关系。调试值来自实际暂停快照;插件不把静态候选路径当作已经执行的路径。
快速开始
- 安装 C Call Graph Explorer by yelingjie(扩展 ID:
yelingjie.c-call-graph),在 VS Code 打开受信任的 C 工程文件夹。
- 先快速浏览:按
Ctrl+Shift+P,运行 C Call Graph: Scan Workspace and Select main,选择入口。此模式无需安装 Clang。
- 需要按真实编译配置分析:安装 LLVM Clang,然后右键
.uvprojx 或 compile_commands.json,运行 C Call Graph: Open Project and Select Entry。Keil 工程再选择 Target。
- 右键函数卡片展开下一层;点击函数名打开定义,点击调用连线查看调用位置与参数。
- 需要中文界面时,将设置
keilCallgraph.language 改为 zh-CN。
源码预览适合先读代码;参数写回、路径变量和构建配置分析需要 Clang 与工程配置。调试值联动还需要下文列出的调试插件和构建产物。
English quick start
- Open a trusted local C workspace. Run C Call Graph: Scan Workspace and Select main for a source preview without Clang.
- For build-aware analysis, install LLVM Clang, configure
keilCallgraph.clangPath if needed, then right-click a .uvprojx or compile_commands.json file and select C Call Graph: Open Project and Select Entry.
- Choose the Keil target when prompted and select an entry function. Right-click function cards to expand calls or show callers; click function names and call sites to navigate to source.
- Use Threads and Processes to explore recognized task entries and queue operations. Optional runtime variable values require the compatible Cortex-M debug bridge described below.
安装与依赖
- VS Code 1.85.0 或更高版本。在扩展视图中搜索「C Call Graph Explorer by yelingjie」或扩展 ID
yelingjie.c-call-graph 并安装,然后打开受信任的本地工作区。使用离线安装包时,在扩展菜单中选择「从 VSIX 安装」。
- LLVM Clang(按编译配置分析时需要)。Windows 可从 LLVM 官方发布页 下载安装包,或解压对应架构的二进制压缩包。插件需要 LLVM 中的
bin\clang.exe,Keil 和 GCC 工程都使用它做调用图分析。用 clang --version 或下方命令验证安装。插件不内置 Clang。
- Keil 工程和头文件(分析 Keil 工程时需要)。准备
.uvprojx、当前 Target 使用的已保存 C 源码,以及对应的工程、CMSIS、Pack 和 C 标准库头文件。Keil 继续用工程配置的工具链编译固件。使用 VSIX 无需单独安装 Node.js、npm、clangd 或微软 C/C++ 扩展。
- GCC 工程的编译数据库。准备
compile_commands.json、对应的源码和构建生成的头文件。GCC、Make 或 West 由项目用于生成构建配置或构建固件,插件扫描时只启动 LLVM Clang。
VS Code 配置
按 Ctrl+, 打开 VS Code 设置,搜索下表中的设置名。修改后在调用图面板点「完整重扫」。
| 设置 |
默认值 |
何时设置 |
keilCallgraph.language |
en(English) |
要把命令面板、右键菜单和调用图切换为中文时,选 zh-CN(简体中文)。切换语言无需重扫。 |
keilCallgraph.clangPath |
clang |
Windows 默认会尝试 LLVM 的常见安装位置,也可从 PATH 查找。免安装版或自定义位置可在用户设置中填写 clang.exe 的完整路径。 |
keilCallgraph.extraIncludePaths |
[] |
Clang 找不到工程外部的头文件时,在工作区设置中添加包含该头文件的目录。相对路径以所选 .uvprojx 或 compile_commands.json 的目录为基准。 |
在 VS Code 的「用户」设置中搜索 keilCallgraph.clangPath,直接填入 clang.exe 的完整路径。例如:
C:\Program Files\LLVM\bin\clang.exe
下面是包含两项设置的 settings.json 示例。路径请按实际安装位置修改。在 JSON 里,反斜杠写成双反斜杠。
{
"keilCallgraph.clangPath": "C:\\Program Files\\LLVM\\bin\\clang.exe",
"keilCallgraph.extraIncludePaths": [
"D:\\software\\keil_v5\\ARM\\ARMCLANG\\include"
]
}
可以在 VS Code 的 PowerShell 终端验证可执行文件。若刚将 Clang 加入 PATH,完全关闭并重开 VS Code 后再验证。
& "C:\Program Files\LLVM\bin\clang.exe" --version
如果提示找不到 math.h、string.h、stdlib.h 或 stdio.h,可补充 Keil 安装目录下的 ARM\ARMCLANG\include。若缺的是 Pack 或第三方头文件,按报错补充该工程实际使用的目录即可。
Makefile 和 GCC 工程
- 使用项目已有的
compile_commands.json。如果 Make 工程没有编译数据库,可在支持 Bear 的构建环境中运行 bear -- make 来记录实际编译命令。确保这次构建会编译需要分析的 C 文件。
- 在 VS Code 资源管理器右键
compile_commands.json,选择「C 函数调用图:打开工程并选择入口」。也可以右键 Makefile、GNUmakefile 或 .mk 文件,选择所在目录及子目录中的编译数据库,或在对话框中指定路径。
- 每份编译数据库对应一种构建配置。切换板卡或配置后,打开对应构建目录里的数据库。更改构建参数后重新生成数据库,再点「更新分析」。
插件读取 arguments 或 command 字段,识别 gcc、cc 和 arm-none-eabi-gcc 等带目标前缀的驱动。它采用每个 C 文件的编译目录、宏、头文件、语言标准和常见目标参数。重复的 C 文件采用首条 GCC 命令。汇编、C++、GCC 插件和响应文件不在本版的分析范围内。
Zephyr 示例
在已配置 GCC 工具链的 Zephyr 工作区中,使用 West 生成编译数据库和头文件。将 <board> 换成实际板卡名。已有构建目录时,可以直接使用其中的数据库。Zephyr 构建文档
west build -b <board> -d build_hello samples/hello_world -- -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
打开 build_hello/compile_commands.json,选择 main。分析时插件保留 Zephyr 的头文件路径,并用 LLVM 自带的内建头文件替换 GCC 的私有编译器头文件目录。
扫描和使用
如果暂时没有工程配置,在 VS Code 打开 C 工程文件夹,按 Ctrl+Shift+P,运行 C Call Graph: Scan Workspace and Select main(扫描工作区并选择 main)。搜索候选的文件路径,选择入口后先看它的第一层调用。右键函数卡片选择 Expand Callees(展开下一层),点击函数名可以打开源码。图上 Select Entry(选择入口)可切到另一个 main()。
源码预览不依赖 Make、GCC 或 Clang。它识别常见的 C 函数定义和调用,按源码名称给出候选关系,并标出可识别的线程入口参数。预览未按实际构建配置处理宏、头文件、目标文件列表和间接调用。同名函数无法区分时,查看连线上的调用位置。需要按实际配置分析参数、变量和写回时,打开编译数据库或 Keil 工程。
线程、进程和消息队列
选择 main() 后点 Threads and Processes(查看线程和进程)。图中会按创建位置列出从 main() 能到达的创建点,包含初始化函数中的调用。Explore This Thread(展开此线程)从该线程入口继续逐层阅读。点创建位置可回到源码。图是静态结果,条件分支中的创建点也可能出现。
| 平台 |
常见线程或任务入口 |
消息队列 |
| FreeRTOS / ESP-IDF |
xTaskCreate、xTaskCreateStatic、PinnedToCore 版本 |
xQueueSend、xQueueReceive 等 |
| RT-Thread |
rt_thread_create、rt_thread_init |
rt_mq_send、rt_mq_recv 等 |
| CMSIS-RTOS / RTX |
osThreadNew、osThreadCreate,可定位的 osThreadDef |
osMessageQueuePut/Get、osMessagePut/Get、osMailPut/Get |
| Zephyr |
k_thread_create、K_THREAD_DEFINE、K_KERNEL_THREAD_DEFINE |
k_msgq_put/get |
| Eclipse ThreadX |
tx_thread_create,含 tx_kernel_enter 对 tx_application_define 的调用 |
tx_queue_send/receive、tx_queue_front_send |
| Apache NuttX |
task_create、kthread_create、kthread_create_with_stack、pthread_create |
POSIX mq_send/receive 等 |
Zephyr 的静态线程在源码预览中限于所选 main() 同一 C 文件,编译配置分析可识别目标里的静态线程。rt_thread_init() 标为初始化。POSIX 和 Windows 还支持常见线程与进程创建接口。fork() 展示派生位置,posix_spawn() 或 CreateProcess() 展示可见的程序参数,子进程内部需另选其源码入口。
消息队列按「发送线程 → 队列 → 接收线程」显示,也会列出 main() 里的队列操作。连线表示源码使用同一队列变量。源码预览限于同一 C 文件内可识别的文件作用域变量;用编译数据库分析时可匹配跨文件的外部声明。局部别名、经参数转交的句柄、其他自动注册任务和跨进程共享队列可能无法关联。未能关联的读写位置仍列在图中。
- 在 VS Code 资源管理器中右键目标
.uvprojx 或 compile_commands.json,选择「C 函数调用图:打开工程并选择入口」。也可从命令面板运行同名命令,有多份同名工程时请按相对路径区分。
- 选择 Target 和入口函数,例如
main。右键函数卡片可展开下一级、查看调用者、折叠或回溯。点击函数名打开定义,点击箭头查看调用行和参数对应。
- 在源码中选中函数名,右键选择「C 函数调用图:查看调用者和下一层」。左侧显示直接调用者,右侧显示该函数直接调用的函数。可从定义、声明或已解析的调用处打开。
- 在源码的可疑函数内右键,选择「C 函数调用图:回溯到当前函数」。图上会展开候选路径,可在多条路径间切换。
卡片中的参数写回表示源码里可识别的写入。点击写回项可以跳到赋值语句,或者跳到传递该参数的调用。
扫描结果按工程路径和 Target 保存为 .json.gz 缓存,放在 VS Code 的扩展工作区存储目录。保存代码后,右键查看函数或点击「更新分析」,插件会重新扫描新增、修改或依赖受影响的文件。重新打开同一工作区时,右键函数会优先打开上次分析的工程和 Target。图面板会显示复用和扫描的文件数量。需要忽略缓存时,点「完整重扫」。
Windows 上的 VS Code 默认缓存位置如下。扫描结果在调用图面板显示,诊断在「输出」面板显示。
%APPDATA%\Code\User\workspaceStorage\<工作区ID>\yelingjie.c-call-graph\<哈希>.json.gz
路径变量与 Cortex-M 调试
静态调用图可独立使用。运行值联动需要兼容 v1 协议的配套插件与构建产物:local-tools.mdk-makefile 生成受管构建配置,local-tools.cortex-m-debug 提供调试桥接,后者使用 Cortex-Debug 执行调试。配套插件需另行安装;仅安装 Cortex-Debug 不会提供此桥接接口。调试会话与调用图插件应位于同一个扩展宿主。
- 右键构建插件生成的
embedded-project.json,选择「C 函数调用图:打开工程并选择入口」,选定对应的 Debug 目标。插件使用该目标的 compile_commands.json;build-info.json、ELF、配置及源码指纹匹配后,才可连接调试会话。单独打开 .uvprojx 或 compile_commands.json 仍能使用静态调用图和变量面板。
- 选入口 A,对目标 C 执行「从入口高亮到这里」,并切到需要的 A → B → C 候选路径。「路径变量」按函数列出形参、局部变量、引用的全局和静态变量,以及可定位的声明、作用域和读写位置。勾选要监视的声明;结构体、指针和数组可以用
.field、->field 或 [0] 手动添加成员。变量同名且在行号范围内无法区分时会标记歧义。
- 需要停点时,在路径面板的函数定义或调用点选择「添加断点」。断点由 VS Code 和调试器按源码行处理;同一行已有断点时沿用它。面板只提供移除自己添加且未被用户编辑的断点。
- 可选安装同一工作区扩展宿主上的
local-tools.cortex-m-debug。启动对应的调试配置后,点「连接调试会话」选择会话。暂停时可点「读取暂停值」重读。运行时展示上次暂停值;递归或多线程的结果分别列出,跨停点对比标作「上次观测」。保存或重新构建后若图失效,先更新分析,再连接匹配新固件的会话。
候选路径使用原有高亮,当前可确认的栈帧及调用点另外用绿色标出。高亮使用停点快照中首个线程的栈;同一源码行多处调用无法确认时只提示歧义。Attach 会话在本地构建可匹配时可显示观测值,并持续标注「固件身份未验证」。读取失败、未在栈、超出作用域、被优化和构建不匹配各有独立状态。
连线上的实参到形参、指针写回、返回值接收位置是静态关系。变量值是调试器在该次暂停所读到的值。插件只请求声明对应的变量或手动添加的只读成员,不重新执行原始实参表达式。成员、函数内静态变量和外部头文件中声明的静态变量是否可读取取决于调试器暴露的作用域。首期由用户控制继续和单步。
分析范围
分析 ARMCC 5 工程时,插件会跳过 FreeRTOS RVDS ARM_CM4F 的 portmacro.h 中已识别的寄存器和屏障汇编块。相关内联函数仍可出现在调用图里,汇编指令的读写效果不参与分析。
分析存在提示时,VS Code 会打开「输出」面板的 C Call Graph 频道,列出 Clang 在各文件中报告的错误。也可点击调用图顶部的 Show Diagnostics(查看分析错误)重新打开并复制内容。
- 以当前 Target 的 C 文件、宏和头文件路径为准。缺少源码、头文件或遇到 Clang 不支持的 ARMCC 专有语法时,相关文件的调用图可能不完整。输出面板首部会显示实际扫描的工程完整路径和 Target。
- 能静态定位的直接调用和简单回调会连到函数。动态函数指针和无法解析的调用保留在图中。候选路径表示源码中的调用关系。
- 首版支持输入参数、返回值和可识别的参数写回。复杂指针别名及缺少定义的调用可能显示为「方向未知」或只显示部分结果。
本地验证
开发者可用 Node.js 和 npm 运行测试。npm test 检查 AC5/AC6、GCC、增量缓存、参数写回、路径和变量声明,以及模拟调试事件在面板中的显示。可用环境变量 CLANG_PATH 指定本地 Clang。
$env:CLANG_PATH = 'C:\Program Files\LLVM\bin\clang.exe'
npm test
常见问题
| 现象 |
处理方式 |
| 找不到 Clang 或启动失败 |
验证 clang --version;在 keilCallgraph.clangPath 填写可执行文件的完整路径。 |
| 找不到头文件或调用图缺失 |
打开 C Call Graph 输出频道,检查当前工程和 Target;生成构建头文件,并按需补充 extraIncludePaths。 |
| Makefile 无法直接分析 |
先生成 compile_commands.json,再打开对应配置的数据库;插件不从任意 Makefile 推断全部编译参数。 |
| 预览中的同名函数连到了多个候选 |
改用编译配置分析,并查看连线的源码位置;源码预览不能精确区分全部同名符号。 |
| 修改代码后仍显示旧结果 |
保存源码后点「更新分析」;修改构建参数时先重新生成编译数据库,必要时「完整重扫」。 |
| 无法连接调试会话 |
确认已安装兼容的桥接插件、打开受管工程,并使用与源码及构建记录匹配的 ELF。 |
| 运行时显示历史值 |
暂停后读取当前值;运行中不会把上次暂停值标为当前实时值。 |
| 暂停时变量不可读 |
检查是否在当前栈和作用域内;编译优化、缺少调试符号或调试器能力可能导致变量不可用。 |
本扩展执行本机 Clang 分析源码,请只在信任的工作区使用。它不负责转换工程、构建固件、烧录硬件或实现完整的指针别名分析。