ascendc_assert
产品支持情况
- Ascend 950PR/Ascend 950DT：支持
- Atlas A3 训练系列产品/Atlas A3 推理系列产品：支持
- Atlas A2 训练系列产品/Atlas A2 推理系列产品：支持
- Atlas 200I/500 A2 推理产品：支持
- Atlas 推理系列产品AI Core：支持
- Atlas 推理系列产品Vector Core：不支持
- Atlas 训练系列产品：不支持
功能说明
头文件路径为："utils/debug/asc_assert.h"。
ascendc_assert提供了一种在CPU/NPU域实现断言功能的接口。当断言条件不满足时，系统会输出断言信息并格式化打印在屏幕上。
在算子Kernel侧实现代码中需要增加断言的地方使用ascendc_assert检查代码，并格式化输出一些调测信息。
注意
该接口主要用于调试分析，开启后会对算子性能产生一定影响，通常在调试阶段使用，生产环境建议关闭。
默认情况下，调用该接口就会打印相关内容，开发者可以参考关闭ASCENDC_DUMP说明，按需关闭该接口功能。
函数原型
C++
#define ascendc_assert(expr)
#define ascendc_assert(expr, __gm__ const char *fmt, Args&&... args)
参数说明
表1 参数说明
| 参数名称 | 输入/输出 | 描述 |
|---|---|---|
| expr | 输入 | assert断言是否终止程序的条件。为true则程序继续执行，为false则终止程序。 |
| fmt | 输入 | 格式控制字符串，包含两种类型的对象：普通字符和转换说明。 •普通字符将原样不动地打印输出。 •转换说明并不直接输出而是用于控制printf中参数的转换和打印。每个转换说明都由一个百分号字符（%）开始，以转换说明结束，从而说明输出数据的类型。 •支持的转换类型包括： ▪%d / %i：输出十进制数，支持打印的数据类型：bool、int8_t、int16_t、int32_t、int64_t。 ▪%f：输出实数，支持打印的数据类型：float、half。 ▪%x：输出十六进制整数，支持打印的数据类型：int8_t、uint8_t、int16_t、uint16_t、int32_t、uint32_t、int64_t、uint64_t。 ▪%s：输出字符串。 ▪%u：输出unsigned类型数据，支持打印的数据类型：bool、uint8_t、uint16_t、uint32_t、uint64_t。 ▪%p：输出指针地址。 注意： •上文列出的数据类型是NPU域调试支持的数据类型，CPU域调试时，支持的数据类型和C/C++规范保持一致。 •在转换类型为%x，即输出十六进制整数时，NPU域上的输出为64位，CPU域上的输出为32位。 |
| args | 输入 | 附加参数，个数和类型可变的参数列表：根据不同的fmt字符串，函数可能需要一系列的附加参数，每个参数包含了一个要被插入的值，替换了fmt参数中指定的每个%标签。参数的个数应与%标签的个数相同。 |
数据类型
无
返回值说明
无
约束说明
单次调用本接口打印的数据总量不可超过30KB。使用时应注意，如果超出这个限制，则数据不会被打印。
调用示例
接口调用示例
C++
int assertFlag = 10;
// 格式化打印
ascendc_assert(assertFlag != 10, "The assertFlag value is %d.\n", assertFlag);
程序运行时会触发assert，打印效果如下：
[ASSERT] /home/.../add_custom.cpp:44: Assertion `assertFlag != 10' The assertFlag value is 10.