函数功能
基于算子工程开发的算子,可以使用该接口实现NPU域上板调试场景下的格式化输出功能。算子执行结束之后,待输出内容会被解析并打印在屏幕上。具体使用方法如下:
- 设置打开DUMP开关的环境变量
export ACL_DUMP_DATA=1
- 修改Dump信息配置文件acl.json。单算子调用应用开发场景下,新建acl.json放在应用开发的工程目录下,在调用aclInit接口时传入;Pytorch调用场景下,放在Pytorch脚本执行目录下,由框架自行读取。配置样例如下:其中dump_path表示dump数据文件存储到运行环境的目录,支持配置绝对路径或相对路径;dump_mode表示dump的模式,配置成input/output/all有效模式均可以;dump_op_switch表示单算子dump数据开关,需要配置成on,开启单算子dump模式;dump_debug为预留参数,开发者无需关注,直接配置成off即可。
{
"dump":{
"dump_path":"./dump",
"dump_mode": "all",
"dump_debug": "off",
"dump_op_switch": "on"
}
}
- 增加算子工程编译选项-DASCENDC_DUMP:修改算子工程op_kernel目录下的CMakeLists.txt文件,首行增加编译选项,打开DUMP开关,样例如下:
add_ops_compile_options(ALL OPTIONS -DASCENDC_DUMP)
- 在算子kernel侧实现代码中需要输出日志信息的地方调用PRINTF接口打印相关内容。
PRINTF("fmt string %d", 0x123);
函数原型
void PRINTF(__gm__ const char* fmt, Args&&... args);
参数说明
参数名
|
输入/输出
|
描述
|
fmt
|
输入
|
格式控制字符串,包含两种类型的对象:普通字符和转换说明。
- 普通字符将原样不动地打印输出。
- 转换说明并不直接输出而是用于控制PRINTF中参数的转换和打印。每个转换说明都由一个百分号字符(%)开始,以转换说明结束,从而说明输出数据的类型 。支持的转换类型包括:
- %d / %i:输出十进制数
- %f:输出实数
- %x:输出十六进制整数
- %s:输出字符串
- %u:输出unsigned类型数据
- %p:输出指针地址
|
args
|
输入
|
附加参数,个数和类型可变的输出列表:根据不同的fmt字符串,函数可能需要一系列的附加参数,每个参数包含了一个要被插入的值,替换了fmt参数中指定的每个%标签。参数的个数应与%标签的个数相同。
|
注意事项
- 该功能仅在如下场景支持:
- 基于Kernel Launch算子工程,通过基础调用(Kernel Launch)方式调用算子。
- 通过单算子API执行的方式开发单算子调用应用。
- 间接调用单算子API(aclnnxxx)接口:Pytorch框架单算子直调的场景。
- 本接口不支持打印除换行符之外的其他转义字符。
- 程序中调用PRINTF使用的空间+调用DumpTensor接口使用的空间+框架dump功能所使用的空间,每个核上不可超过1M。请开发者自行控制待打印的内容数据量,超出则不会打印。
调用示例
// 整型打印:
PRINTF("fmt string %d", 0x123);
// 指针打印:
int *a;
PRINTF("TEST %p", a);