printf
函数功能
基于算子工程开发的算子,可以使用该接口实现CPU侧/NPU侧调试场景下的格式化输出功能。
在算子kernel侧实现代码中需要输出日志信息的地方调用printf接口打印相关内容。样例如下:
1 2 3 |
#include "kernel_operator.h" AscendC::printf("fmt string %d\n", 0x123); AscendC::PRINTF("fmt string %d\n", 0x123); |
printf(PRINTF)接口打印功能会对算子实际运行的性能带来一定影响,通常在调测阶段使用。开发者可以按需通过如下方式关闭打印功能。
- 自定义算子工程
- Kernel直调工程
- 修改cmake目录下的npu_lib.cmake文件,在ascendc_compile_definitions命令中增加-DASCENDC_DUMP=0宏定义来关闭NPU侧ASCENDC_DUMP开关。示例如下:
1 2 3 4
// 关闭所有算子的printf打印功能 ascendc_compile_definitions(ascendc_kernels_${RUN_MODE} PRIVATE -DASCENDC_DUMP=0 )
- 修改cmake目录下的cpu_lib.cmake文件,在target_compile_definitions命令中增加-DASCENDC_DUMP=0宏定义来关闭CPU侧ASCENDC_DUMP开关。示例如下:
1 2 3
target_compile_definitions(ascendc_kernels_${RUN_MODE} PRIVATE -DASCENDC_DUMP=0 )
需要注意的是,关闭CPU侧的打印开关时,只对PRINTF接口生效,对printf不生效。
- 修改cmake目录下的npu_lib.cmake文件,在ascendc_compile_definitions命令中增加-DASCENDC_DUMP=0宏定义来关闭NPU侧ASCENDC_DUMP开关。示例如下:
printf打印结果的最前面会自动打印CANN_VERSION_STR值与CANN_TIMESTAMP值。其中,CANN_VERSION_STR与CANN_TIMESTAMP为宏定义,CANN_VERSION_STR代表CANN软件包的版本号信息,形式为字符串,CANN_TIMESTAMP为CANN软件包发布时的时间戳,形式为数值(uint64_t)。开发者也可在代码中直接使用这两个宏。prinf打印结果示例如下:
1 2 3 |
CANN Version: XXX.XX, TimeStamp: 20240807140556417 fmt string 291 fmt string 291 |
根据算子执行方式的不同,printf的打印结果输出方式不同。动态图或者单算子直调场景下,待输出内容会被解析并打印在屏幕上;静态图场景下,整图算子需要全下沉到NPU侧执行,无法直接调用接口打印出单个算子的信息,因此需要在模型执行完毕后,将待输出内容落盘在dump文件中,dump文件需要通过工具解析为可读内容。
- dump文件落盘路径按照优先级排列如下:
- 如果开启了Data Dump功能,dump文件落盘到开发者配置的dump_path路径下。如何开启Dump功能依赖于具体的网络运行方式。以TensorFlow在线推理为例,通过enable_dump、dump_path、dump_mode等参数进行配置。配置方式可参考《TensorFlow 2.6.5迁移指南》中的API参考 > TF Adapter 接口(2.x)> npu.global_options > 配置参数说明章节。
- 如果未开启Data Dump功能,但配置了ASCEND_WORK_PATH环境变量,dump文件落盘到ASCEND_WORK_PATH下的printf目录下。ASCEND_WORK_PATH环境变量的配置方式可参考ASCEND_WORK_PATH。
- 如果未开启Data Dump功能也没有配置ASCEND_WORK_PATH环境变量,dump文件落盘到当前程序执行目录下的printf路径下。
- 落盘dump文件需要使用工具解析为用户可读内容:
函数原型
1 2 |
void printf(__gm__ const char* fmt, Args&&... args) void PRINTF(__gm__ const char* fmt, Args&&... args) |
参数说明
参数名 |
输入/输出 |
描述 |
---|---|---|
fmt |
输入 |
格式控制字符串,包含两种类型的对象:普通字符和转换说明。
|
args |
输入 |
附加参数,个数和类型可变的输出列表:根据不同的fmt字符串,函数可能需要一系列的附加参数,每个参数包含了一个要被插入的值,替换了fmt参数中指定的每个%标签。参数的个数应与%标签的个数相同。 |
返回值
无
支持的型号
Atlas A2训练系列产品/Atlas 800I A2推理产品
Atlas推理系列产品AI Core
注意事项
- 本接口不支持打印除换行符之外的其他转义字符。
- 如果开发者需要包含标准库头文件stdio.h和cstdio,请在kernel_operator.h头文件之前包含,避免printf符号冲突。
- 程序中调用printf/PRINTF接口使用的空间+调用DumpTensor接口使用的空间+DumpAccChkPoint接口使用的空间+assert接口使用的空间+框架dump功能所使用的空间,每个核上不可超过1M。请开发者自行控制待打印的内容数据量,超出则不会打印。
调用示例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
#include "kernel_operator.h" // 整型打印: AscendC::printf("fmt string %d\n", 0x123); AscendC::PRINTF("fmt string %d\n", 0x123); // 浮点型打印: float a = 3.14; AscendC::printf("fmt string %f\n", a); AscendC::PRINTF("fmt string %f\n", a); // 指针打印: int *a; AscendC::printf("TEST %p\n", a); AscendC::PRINTF("TEST %p\n", a); |
程序运行时打印效果如下:
1 2 3 4 |
fmt string 291 fmt string 291 TEST 0x12c08001a000 TEST 0x12c08001a000 |
父主题: 调测接口