内存检测

内存检测是针对用户程序运行时的一种异常检测，该工具可以检测并报告算子运行中对外部存储（Global Memory）和内部存储（Local Memory）的越界及未对齐等内存访问异常。

内存异常类型

内存检测工具能够检测并报告诸如内存非法读写、多核踩踏、非对齐访问、内存泄漏以及非法释放等异常操作，如下表所示。

表1 内存异常类型
异常名	描述	位置	支持地址空间
非法读写	由于访问了未分配的内存导致的异常。	kernel, host	GM
多核踩踏	AI Core核心访问了重叠的内存导致的踩踏问题。	kernel	GM
非对齐访问	DMA（负责在Global Memory和Local Memory之间搬运数据）搬运的地址与内存的最小访问粒度未对齐导致的异常。	kernel	GM, UB, L0{A,B,C}, L1
内存泄露	申请内存使用后未释放，导致程序在运行过程中内存占用持续增加的异常。	host	GM
非法释放	对未分配或已释放的地址进行释放导致的异常。	host	GM
分配内存未使用	对内存分配后未使用导致的异常。	kernel，host	GM

启用内存检测

运行mssanitizer工具时，默认启用内存检测工具memcheck。

执行如下命令可显式指定内存检测，默认会开启非法读写、多核踩踏、非对齐访问和非法释放的检测功能：
```
mssanitizer --tool=memcheck ./<kernel_name>_npu
```
执行如下命令，可在步骤一检测功能项的基础上，手动启用内存泄漏的检测功能：
```
mssanitizer --tool=memcheck --leak-check=yes ./<kernel_name>_npu
```

执行如下命令，可在步骤一检测功能项的基础上，手动启用分配内存未使用的检测功能：
```
mssanitizer --tool=memcheck --check-unused-memory=yes ./<kernel_name>_npu
```

./<kernel_name>_npu为NPU侧可执行文件所在路径，可配置为相对路径或绝对路径。

启动工具后，将会在当前目录下自动生成工具操作日志文件mssanitizer_{TIMESTAMP}_{PID}.log。
当用户程序运行完成后，界面将会打印异常报告，异常的具体含义请参见内存异常报告解析。
当用户使用PyTorch等框架接入算子时，框架内部可能会通过内存池管理GM内存，而内存池通常会一次性分配大量GM内存，并在运行过程中复用。此时，若用户对算子进行检测并记录GM上所有内存分配和释放的信息，会因为内存池的内存管理方式导致检测信息不准确。因此检测工具提供了手动上报GM内存分配信息的接口，方便用户在算子调用时手动上报该算子应当使用的GM内存范围，详细接口介绍请参见SanitizerReportMalloc和SanitizerReportFree。

内存异常报告解析

内存检测异常报告会输出多种不同类型的异常信息，以下将对一些简单的异常信息示例进行说明，帮助用户解读异常报告中的信息。

非法读写

非法读写异常信息的产生是由于算子程序中，通过读或写的方式访问了一块未分配的内存。此错误一般发生在GM上，由于GM分配的大小与实际算子程序中访问的范围不一致导致。

====== ERROR: illegal read of size 100      // 异常的基本信息，包含非法读写的类型以及被非法访问的字节数，非法读写包括read（非法读取）和write（非法写入）
======    at 0x124040017f9c on GM    // 异常发生的内存位置信息，包含发生的地址空间与内存地址，此处的内存地址指一次内存访问中的首地址
======    in block 0    // 异常代码对应cube核的block索引
======    code in add_custom.cpp:52     // 异常发生的代码定位信息，包含文件名和行号

以上示例中，对GM上的“0x124040017f9c”地址存在非法读取，且导致异常发生的指令对应于算子实现文件add_custom.cpp的第 52 行。

多核踩踏
 AI Core是昇腾AI处理器中的计算核心，AI处理器内部有多个AI Core，算子运行就在这些AI Core上。这些AI Core会在计算过程中从GM上搬入或搬出数据。当没有显式地进行核间同步时，如果各个核之间访问的GM内存存在重叠并且至少有一个核对重叠地址进行写入时，则会发生多核踩踏问题。这里我们通过所有者的概念来保证多核之间不会发生踩踏问题，当一块内存被某一个核写入后，这块内存就由该核所有。当其他核对这块内存进行访问时就会产生out of bounds异常。
```
====== WARNNING: out of bounds of size 256      // 异常的基本信息，包含发生踩踏的字节数
======    at 0x1240c002e000 on GM when writing data      // 异常发生的内存位置信息，包含发生的地址空间与内存地址，此处的内存地址指一次内存访问中的首地址
======    in block 1      // 异常代码对应vector核的block索引
======    code in add_custom.cpp:84      // 异常发生的代码定位信息，包含文件名和行号
```
以上示例中，共有256个字节的访问发生踩踏，对GM上的“0x1240c002e000”地址进行访问时存在多核踩踏，且导致异常发生的指令对应于算子实现文件add_custom.cpp的第 84 行。
非对齐访问
 昇腾芯片上包含多种类型的内存，当通过DMA进行访问时，不同类型的内存在不同芯片上有不同的最小访问粒度。当访问的内存地址与最小访问粒度不对齐时，会发生数据异常或AI Core异常等问题。访问对齐检测可以在对齐问题发生时输出对齐异常信息。
```
====== ERROR: misaligned access of size 13      // 异常的基本信息，包含发生对齐异常操作的字节数
======    at 0x0a on UB     // 异常发生的内存位置信息，包含发生的地址空间与内存地址
======    in block 39       // 异常代码对应cube核的block索引
======    code in add_custom.cpp:84      // 异常发生的代码定位信息，包含文件名和行号
```
以上示例中，共有针对13个字节的对齐异常访问，对UB上的“0x0a”地址进行访问时存在对齐问题，且导致异常发生的指令对应于算子实现文件add_custom.cpp的第 84 行。
内存泄露
 内存检测工具可以检测出Device侧的内存泄漏问题，这些问题通常是开发者没有正确释放使用AscendCL接口申请的内存导致的，由于内部存储（Local Memory）目前不存在内存分配的概念，因此内存泄漏只可能出现在GM上。通过指定命令行参数“--leak-check=yes”可以开启内存泄漏检测。
```
====== ERROR: LeakCheck: detected memory leaks     // 检测到内存泄漏

======    Direct leak of 100 byte(s)      // 具体每次的内存泄漏信息
======      at 0x124080013000 on GM allocated in add_custom.cpp:14

======    Direct leak of 1000 byte(s)
======      at 0x124080014000 on GM allocated in add_custom.cpp:15

====== SUMMARY: 1100 byte(s) leaked in 2 allocation(s)     // 全部内存泄漏的总结，包括发生泄漏的次数以及总共泄漏了多少字节等信息
```
以上示例中，第一个内存泄漏信息包含了地址空间、内存地址、内存长度以及代码定位信息，代码定位信息指向具体分配这块内存的调用所在的文件名和行号。

非法释放

非法释放是指对一个未分配的地址或者已释放的地址进行了释放操作，一般发生在 GM 上。

====== ERROR: illegal free()     // 异常的基本信息，表明发生了非法释放异常
======    at 0x124080013000 on GM      // 异常发生的内存位置信息，包含发生的地址空间与内存地址
======    code in add_custom.cpp:84      // 异常发生的代码定位信息，包含文件名和行号

以上示例中，对GM上的“0x124080013000”地址进行了非法释放，且导致异常发生的指令对应于算子实现文件add_custom.cpp的第 84 行。

分配内存未使用

分配内存未使用是指算子运行时申请了内存，但直到算子运行完成，都没有使用该内存。该异常场景一般是算子使用了错误的内存或算子逻辑存在问题，一般发生在 GM 上。

====== WARNNING: Unused memory of 1000 byte(s)  //异常的基本信息，表明检测到内存分配未使用异常
======    at 1240c0016000 on GM                 // 异常发生的内存位置信息，包含发生的地址空间与内存地址
======    code in add_custom.cpp:2              //异常发生的代码定位信息，包含文件名和行号
====== SUMMARY: 1100byte(s) unused memory in 2 allocation(s) // 内存分配未使用的总结信息，包括未使用内存块的个数及字节等信息

内存异常报告具有以下级别：

WARNNING：此级别被定义为不确定性的风险，可能出现的异常现象由实际情况决定。如多核踩踏风险涉及多个核对同一块内存的操作，高阶用户可以通过核间同步的手段来规避此风险，初阶用户遇到此类异常，应该将其视为危险源。
ERROR：最高严重级别的异常，涉及针对内存操作的确定性错误，如非法读写、内存泄漏、非对齐访问等。强烈建议用户检查此严重级别的异常。

父主题： 使用mssanitizer检测算子异常