MindStudio Sanitizer 开发环境搭建及编译和UT方法¶
1. 预备知识¶
请参考《msSanitizer架构设计文档》学习代码框架及核心流程介绍。
2. 开发环境准备¶
请按照以下文档进行环境配置：《算子工具开发环境安装指导》。
3. 编译打包¶
分为如下两种方式，优缺点如下：
| 方法 | 适用场景 | 优点 | 缺点 |
|---|---|---|---|
| 一键式脚本 | 首次构建、CI/CD 流水线 | 零配置，一步到位 | 无法单独执行某一步骤 |
| 分步骤脚本 | 日常开发、增量编译 | 灵活，效率高 | 需要多步操作 |
3.1 方法一：一键式脚本¶
3.2 方法二：分步骤脚本¶
3.2.1 下载依赖¶
3.2.2 编译打包¶
3.2.2.1 启动编译¶
执行如下命令启动编译：
mkdir build
cd build
cmake ../cmake
make -j$(nproc) # -j 是并行编译的 job 数量，可自行指定；nproc 不可用时请手动填数字（例如 -j8）。
[!NOTE] 说明
debug 版本编译方法
如果想进行 gdb 或 vscode 图形化断点调试等，需要编译 debug 版本，方法如下：
在执行如上 cmake 命令时增加参数 -DCMAKE_BUILD_TYPE=Debug，例如：cmake ../cmake -DCMAKE_BUILD_TYPE=Debug[!CAUTION] 注意
CMake的参数问题
请务必使用cmake ../cmake而非cmake ..，否则不会生成 .run 安装包。
若 output 目录下的 Ascend-mindstudio-sanitizer-xxx.run 文件的生成时间已更新为当前编译时间，则表明编译与打包已成功完成。
3.2.2.2 编译结果说明¶
编译结果生成到 output 目录下：
output/
|-- Ascend-mindstudio-sanitizer-XXX_linux-aarch64.run # 安装包
|-- bin # 可执行bin文件，可直接调用调试功能
|-- include # API接口头文件
|-- lib64 # 各种动态库和静态库
|-- version.info # 版本信息
3.2.3 清理/重新编译¶
删除构建目录，重新执行第 3.2.2.1 节：
4. 执行UT测试¶
4.1 方法一：一键式脚本¶
4.2 方法二：分步骤脚本¶
4.2.1 下载依赖¶
4.2.2 执行UT测试¶
[!NOTE] 说明
UT 的 CMake 入口说明
UT 构建使用工程根目录的CMakeLists.txt（即cmake ..，不是cmake ../cmake），只编译测试与依赖，不包含.run打包流程。
mkdir build_ut
cd build_ut
cmake .. -DBUILD_TESTS=ON
make -j$(nproc) mssanitizer_test # -j 是并行编译的 job 数量，可自行指定；nproc 不可用时请手动填数字（例如 -j8）。
./test/ut/mssanitizer_test
输出类似如下跑的用例数和通过用例数相同即表示成功：
4.2.3 清理/重新编译¶
删除构建目录，重新执行第 4.2.2 节：
5. FAQ¶
5.1 编译时执行make为什么没有生成run包？¶
有可能执行 cmake 时用了 cmake ..，cmake 命令说明如下：
cmake ..：只编译本工程，make install 会把东西装到 output/，但不会调用 makeself，所以不会生成 Ascend-mindstudio-sanitizer-xxx.run。cmake ../cmake：用的是 cmake/CMakeLists.txt 的「超级构建」，会先编译+安装，再执行 parser.py + makeself，在 output/ 里生成 .run 包。