printf

函数功能

基于算子工程开发的算子，可以使用该接口实现CPU侧/NPU侧调试场景下的格式化输出功能。算子执行结束之后，待输出内容会被解析并打印在屏幕上。

在算子kernel侧实现代码中需要输出日志信息的地方调用printf接口打印相关内容。样例如下：

#include "kernel_operator.h"
using namespace AscendC; // 调用前需要引用AscendC命名空间

printf("fmt string %d\n", 0x123);
PRINTF("fmt string %d\n", 0x123);
AscendC::printf("fmt string %d\n", 0x123);
AscendC::PRINTF("fmt string %d\n", 0x123);

printf（PRINTF）接口打印功能会对算子实际运行的性能带来一定影响，通常在调测阶段使用。开发者可以按需通过如下方式关闭打印功能。

自定义算子工程
修改算子工程op_kernel目录下的CMakeLists.txt文件，首行增加编译选项-DASCENDC_DUMP=0，关闭ASCENDC_DUMP开关，示例如下：
```
// 关闭所有算子的printf打印功能
add_ops_compile_options(ALL OPTIONS -DASCENDC_DUMP=0)
```
Kernel直调工程
- 修改cmake目录下的npu_lib.cmake文件，在ascendc_compile_definitions命令中增加-DASCENDC_DUMP=0宏定义来关闭NPU侧ASCENDC_DUMP开关。示例如下：
```
// 关闭所有算子的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开关。示例如下：
```
target_compile_definitions(ascendc_kernels_${RUN_MODE} PRIVATE
    -DASCENDC_DUMP=0
)
```
  需要注意的是，关闭CPU侧的打印开关时，只对PRINTF接口生效，对printf不生效。

函数原型

void printf(__gm__ const char* fmt, Args&&... args);

void PRINTF(__gm__ const char* fmt, Args&&... args);

参数说明

参数名	输入/输出	描述
fmt	输入	格式控制字符串，包含两种类型的对象：普通字符和转换说明。普通字符将原样不动地打印输出。转换说明并不直接输出而是用于控制printf中参数的转换和打印。每个转换说明都由一个百分号字符（%）开始，以转换说明结束，从而说明输出数据的类型。支持的转换类型包括： %d / %i：输出十进制数，支持打印的数据类型：int8_t, int16_t, int32_t, int64_t %f：输出实数，支持打印的数据类型：float, half, bfloat16_t %x：输出十六进制整数，支持打印的数据类型：int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t %s：输出字符串 %u：输出unsigned类型数据，支持打印的数据类型：uint8_t, uint16_t, uint32_t, uint64_t %p：输出指针地址
args	输入	附加参数，个数和类型可变的输出列表：根据不同的fmt字符串，函数可能需要一系列的附加参数，每个参数包含了一个要被插入的值，替换了fmt参数中指定的每个%标签。参数的个数应与%标签的个数相同。

参数名

输入/输出

描述

fmt

输入

格式控制字符串，包含两种类型的对象：普通字符和转换说明。

普通字符将原样不动地打印输出。
转换说明并不直接输出而是用于控制printf中参数的转换和打印。每个转换说明都由一个百分号字符（%）开始，以转换说明结束，从而说明输出数据的类型。
支持的转换类型包括：
- %d / %i：输出十进制数，支持打印的数据类型：int8_t, int16_t, int32_t, int64_t
- %f：输出实数，支持打印的数据类型：float, half, bfloat16_t
- %x：输出十六进制整数，支持打印的数据类型：int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t
- %s：输出字符串
- %u：输出unsigned类型数据，支持打印的数据类型：uint8_t, uint16_t, uint32_t, uint64_t
- %p：输出指针地址

args

输入

附加参数，个数和类型可变的输出列表：根据不同的fmt字符串，函数可能需要一系列的附加参数，每个参数包含了一个要被插入的值，替换了fmt参数中指定的每个%标签。参数的个数应与%标签的个数相同。

返回值

无

支持的型号

Atlas A2训练系列产品/Atlas 800I A2推理产品

Atlas推理系列产品AI Core

注意事项

该功能仅在如下场景支持：
- 通过Kernel直调方式调用算子。
- 通过单算子API调用方式调用算子。
- 间接调用单算子API(aclnnxxx)接口：Pytorch框架单算子直调的场景。

本接口不支持打印除换行符之外的其他转义字符。
如果开发者需要包含标准库头文件stdio.h和cstdio，请在kernel_operator.h头文件之前包含，避免printf符号冲突。
程序中调用printf/PRINTF接口使用的空间+调用DumpTensor接口使用的空间+DumpAccChkPoint接口使用的空间+assert接口使用的空间+框架dump功能所使用的空间，每个核上不可超过1M。请开发者自行控制待打印的内容数据量，超出则不会打印。
用户在使能printf功能时，在printf的打印结果的最前面会自动打印CANN_VERSION值与CANN_TIMESTAMP值。CANN_VERSION与CANN_TIMESTAMP为宏定义，用户可直接使用这两个宏，其中宏CANN_VERSION代表CANN软件包的版本号信息，形式为数值(uint64_t)，CANN_TIMESTAMP为CANN软件包发布时的时间戳，形式为数值(uint64_t)。示例如下：
```
CANN Version: 804000000, TimeStamp: 20240620
```

调用示例

#include "kernel_operator.h"
using namespace AscendC; // 调用前需要引用AscendC命名空间

// 整型打印：
printf("fmt string %d\n", 0x123);
PRINTF("fmt string %d\n", 0x123);

// 浮点型打印：
float a = 3.14;
printf("fmt string %f\n", a);
PRINTF("fmt string %f\n", a);

// 指针打印：
int *a;
printf("TEST %p\n", a);
PRINTF("TEST %p\n", a);

程序运行时打印效果如下：
fmt string 291
fmt string 291
TEST 0x12c08001a000
TEST 0x12c08001a000

父主题： 调测接口