使用前准备

使用约束

Device侧内存检测和CANN软件栈内存检测不能同时使能，若同时使能会提示“--check-cann-heap and --check-device-heap CANNOT both enabled”。
使用工具提供的API头文件重新编译的待检测程序只能用于AsecndCL系列接口的泄漏检测，无法用于Device接口的检测。
如要加载的可执行文件或用户自定义程序本身带有命令行参数时，在可执行文件或用户程序之前使用“--”分隔检测工具和用户命令，如下所示：
```
mssanitizer --check-cann-heap=yes --leak-check=yes -- ./<kernel_name>_npu  parameter1 parameter2 ...
```

prog.py为用户自定义脚本，自定义脚本中不建议配置删除文件或目录、修改密码、提权命令等有安全风险的高危操作。

环境准备

请参考环境准备，完成相关环境变量的配置。

添加编译选项

不同算子工程添加编译选项的位置不同，下面以内核调用符场景和msOpGen算子工程编译场景准备为例进行介绍：

内核调用符场景
- 算子代码的编译选项需添加 -g --cce-enable-sanitizer。
  编辑样例工程目录下的“cmake/npu/CMakeLists.txt”文件，单击LINK参考核函数开发和运行验证的完整样例。
```
target_compile_options(${smoke_testcase}_npu PRIVATE
                     -O2
                     -std=c++17
                     --cce-enable-sanitizer
                     -g
)
```
  增加 --cce-enable-sanitizer 选项代表使能异常检测。
  
  为了在异常报告输出时显示异常发生的具体位置，增加 -g 选项使编译器生成定位信息，从而在报告中显示文件名行号等信息。
  - 开启-O2后可能会导致编译器对某些代码进行优化，造成行号被异常报告为0，此时，需将-O2改为-O0，通过-O0关闭优化获取正确定位信息。
  - 下载代码样例时，需执行以下命令指定分支版本。
    git clone https://gitee.com/ascend/samples.git -b 8.0.RC2
- 链接阶段需增加target_link_options选项。
  - 编辑样例工程目录下的“cmake/npu/CMakeLists.txt”文件。
```
target_link_options(${smoke_testcase}_npu PRIVATE
    --cce-fatobj-link
    --cce-enable-sanitizer
)
```
  - 编辑样例工程目录下的“cmake/Modules/CMakeCCEInformation.cmake”文件。
```
if(NOT CMAKE_CCE_LINK_EXECUTABLE)
  set(CMAKE_CCE_LINK_EXECUTABLE
    "<CMAKE_CCE_COMPILER> ${CMAKE_LIBRARY_CREATE_CCE_FLAGS} ${_CMAKE_COMPILE_AS_CCE_FLAG} <FLAGS> <CMAKE_CCE_LINK_FLAGS> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>${__IMPLICIT_LINKS}")
endif()
```
- 启用msSanitizer检测工具时需要加载NPU侧可执行文件<kernel_name>_npu，该文件的获取可参考核函数运行验证简介。

msOpGen算子工程编译场景
- op_kernel侧编译选项中添加-sanitizer选项，具体请参考支持自定义编译选项。
- 编辑样例工程目录下的“op_kernel/CMakeLists.txt”文件。
```
add_ops_compile_options(ALL OPTIONS -sanitizer)
```

父主题： 异常检测（msSanitizer）