Sourcetrail 代码分析工具的使用

Sourcetrail 概述

Sourcetrail 是一个代码分析工具，它旨在帮助开发人员理解和导航复杂的代码库。它可以创建代码库的可视化图形，显示代码中的类、函数、变量、依赖关系等信息，从而帮助开发人员更好地理解代码结构和关系，降低维护和开发过程中的复杂性。

Sourcetrail 的主要特点包括：

1. 代码可视化： Sourcetrail 通过图形化的方式展示代码库的结构和关系，使开发人员能够更容易地理解和浏览代码。

2. 代码导航： 开发人员可以通过 Sourcetrail 快速导航代码库，跳转到特定的类、函数或变量，并查看其定义、引用和调用。

3. 依赖分析： Sourcetrail 可以帮助识别代码之间的依赖关系，包括类之间的继承关系、函数之间的调用关系等，从而更好地理解代码的运行流程。

4. 多语言支持： Sourcetrail 支持多种编程语言，包括但不限于 C++、Java、Python 等。

5. 实时同步： 当代码发生变化时，Sourcetrail 可以自动检测并同步更新代码库的图形表示，确保图形始终保持最新状态。

6. 搜索功能： Sourcetrail 提供强大的搜索功能，可以快速查找特定的代码元素，例如类、函数、变量等。

7. 插件支持： 开发人员可以通过插件扩展 Sourcetrail 的功能，以满足特定需求。

Sourcetrail 实践

本文以 MariaDB 源代码为例，描述 Sourcetrail 如何结合 compile_commands.json 分析 C/C++ 大型工程的的源代码。

代码编译

编译 MariaDB 源代码，在编译时加入 'CMAKE_EXPORT_COMPILE_COMMANDS' 选项以生成 compile_commands.json 文件。

  cmake .. -DCMAKE_BUILD_TYPE=Debug -DWITH_VALGRIND=ON -DWITH_DEBUG=1 \
           -DCMAKE_INSTALL_PREFIX=/opt/mariadb \
           -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DWITH_UNIT_TESTS=OFF \
           -DWITH_WSREP=OFF -DWITH_MARIABACKUP=OFF -DWITH_ROCKSDB=OFF \
           -DPLUGIN_TOKUDB=NO -DPLUGIN_CONNECT=NO -DPLUGIN_SPIDER=NO \
           -DPLUGIN_OQGRAPH=NO -DPLUGIN_SPHINX=NO -DPLUGIN_MROONGA=NO \
           -DPLUGIN_ROCKSDB=NO

执行上述命令后，会在编译目录下生成一个名为 compile_commands.json 的文件。

创建 Sourcetrail 工程

根据 MariaDB 源代码创建代码分析项目。

1. 创建项目

1. 指定项目类型

1. 选择 compile_commands.json 文件的路径

1. 创建 MariaDB 代码分析工程后，Sourcetrail 会创建对应的数据库，代码量比较大时，数据库的创建时间会比较长

代码导航示例

查看 MariaDB handler 类的继承关系图

1. 在 Sourcetrail 主界面输入 handler，输入回车键

1. handler 类的继承关系如下图所示

查看 trx_rseg_t 数据结构与其关联数据结构的关系

1. 选择查看 trx_rseg_t 数据结构的信息

1. trx_rseg_t 数据结构展示