assert
函数功能
基于算子工程开发的算子,可以使用该接口实现CPU/NPU域assert断言功能。算子执行中,如果assert内部条件判断不为真,则输出assert条件并将输入的信息格式化打印在屏幕上。
在算子kernel侧实现代码中需要增加断言的地方使用assert检查代码,并格式化输出一些调测信息。示例如下:
1 2 3 4 5 |
int assertFlag = 10; assert(assertFlag == 10); assert(assertFlag == 10, "The assertFlag value is 10.\n"); assert(assertFlag == 10, "The assertFlag value is %d.\n", assertFlag); |
assert接口打印功能会对算子实际运行的性能带来一定影响(每一条assert,系统会额外增加一条逻辑判断,具体性能影响取决于代码中assert的使用数量),通常在调测阶段使用。开发者可以按需通过如下方式关闭打印功能。
- 自定义算子工程
- Kernel直调工程
在assert条件被触发时,在断言信息前面会自动打印CANN_VERSION_STR值与CANN_TIMESTAMP值。其中,CANN_VERSION_STR与CANN_TIMESTAMP为宏定义,CANN_VERSION_STR代表CANN软件包的版本号信息,形式为字符串,CANN_TIMESTAMP为CANN软件包发布时的时间戳,形式为数值(uint64_t)。开发者也可在代码中直接使用这两个宏。assert打印信息示例如下:
1
|
[ASSERT][CANN_VERSION : XXX.XX][TimeStamp : 20240807140556417] /home/.../add_custom.cpp:44: Assertion `assertFlag != 10' The assertFlag value is 10. |
函数原型
1 2 |
assert(expr) assert(expr, __gm__ const char *fmt, Args&&... args) |
参数说明
参数名 |
输入/输出 |
描述 |
---|---|---|
expr |
输入 |
assert断言是否终止程序的条件。为true则程序继续执行,为false则终止程序。 |
fmt |
输入 |
格式控制字符串,包含两种类型的对象:普通字符和转换说明。
|
args |
输入 |
附加参数,个数和类型可变的输出列表:根据不同的fmt字符串,函数可能需要一系列的附加参数,每个参数包含了一个要被插入的值,替换了fmt参数中指定的每个%标签。参数的个数应与%标签的个数相同。 |
返回值
无
支持的型号
Atlas A2训练系列产品/Atlas 800I A2推理产品
Atlas推理系列产品AI Core
注意事项
- 该功能仅在如下场景支持:
- kernel开发不要包含系统的assert.h,会导致宏定义冲突。
- assert接口调用形式与C语言一致,不需要使用AscendC命名空间。
- 本接口不支持打印除换行符之外的其他转义字符。
- 程序中调用assert接口使用空间+调用printf接口使用的空间+调用DumpTensor接口使用的空间+DumpAccChkPoint接口使用的空间+框架dump功能所使用的空间,每个核上不可超过1M。请开发者自行控制待打印的内容数据量,超出则不会打印。
- 程序中只调用assert接口,assert接口使用空间每个核上不可超过1k。请开发者自行控制待打印的内容数据量,超出则不会打印。
调用示例
1 2 3 4 5 6 7 8 9 10 11 |
int assertFlag = 10; // 断言条件 assert(assertFlag == 10); // 打印消息 assert(assertFlag == 10, "The assertFlag value is 10.\n"); // 格式化打印 assert(assertFlag == 10, "The assertFlag value is %d.\n", assertFlag); assert(assertFlag != 10, "The assertFlag value is %d.\n", assertFlag); |
程序运行时会触发assert,打印效果如下:
1
|
[ASSERT][CANN_VERSION : XXX.XX][TimeStamp : 20240807140556417] /home/.../add_custom.cpp:44: Assertion `assertFlag != 10' The assertFlag value is 10. |
父主题: 调测接口