性能数据采集（acl.json配置文件方式）

该章节提供离线推理场景下通过运行应用工程可执行文件、调用acl.json文件，读取Profiling相关配置，从而自动采集性能原始数据。采集性能原始数据成功后，可将采集的原始数据取到装有Ascend-cann-toolkit开发套件包的开发环境上进行性能数据解析，展示性能数据解析结果。

关于应用工程编译、运行的详细方法，请参见《应用软件开发指南 (C&C++)》。
使用该方法，务必调用aclInit()接口完成AscendCL初始化、和调用aclFinalize()完成AscendCL去初始化。

采集性能原始数据

参考以下步骤完成acl.json文件配置，并完成应用工程编译和运行：

打开aclInit()函数所在的推理应用工程代码文件，获取acl.json文件路径。

// ACL init
const char *aclConfigPath = “../src/acl.json”;
aclError ret = aclInit(aclConfigPath);
if (ret != ACL_ERROR_NONE) {
    ERROR_LOG(“acl init failed”);
    return FAILED;
}
INFO_LOG(“acl init success”);

如果aclInit()初始化为空，则需要修改该函数，补充步骤2创建的acl.json文件路径。

在查出的目录下修改acl.json文件（如不存在该文件，则需要新建，建议放在工程编译后的src目录下），添加Profiling相关配置，格式如下所示。
```
{
"profiler": {
              "switch": "on",
              "output": "output",
              "aicpu": "on"
            }
}
```
profiler参数可选的取值如下：
- switch：Profiling开关，取值on或off。可选参数。
  on表示开启Profiling，off表示关闭Profiling；如果缺失该参数或参数值不为on，则表示关闭Profiling。
  
  acl.json配置文件方式开启Profiling开关后自动采集AscendCL、Runtime接口和Task Scheduler任务调度信息数据。
- output：Profiling性能数据在运行环境上的落盘路径。可选参数。未配置本参数时，Profiling性能数据默认落盘到应用工程可执行文件所在目录。
  Profiling采集结束后，在该目录下生成PROF开头目录，存放Profiling采集的性能原始数据。支持配置绝对路径或相对路径（相对执行命令行时的当前路径）：
  - 绝对路径配置以“/”开头，例如：/home/HwHiAiUser/output。
  - 相对路径配置直接以目录名开始，例如：output。
  - 该参数指定的目录需要确保安装时配置的运行用户具有读写权限。如果该处设置的目录没有读写权限，默认存放采集结果数据到应用工程可执行文件所在目录（确保安装时配置的运行用户具有该目录的读写权限）。
- storage_limit：用于指定Profiling数据文件保存至磁盘时的存储空间上限。当累计存放的Profiling数据文件大小接近参数设置值（<=20MB）或数据存放目录所在磁盘的可用空间即将不足（<=20MB）时，除特定的Profiling数据文件外，最早保存的Profiling数据文件将被删除，以保证新生成的数据文件可以循环覆盖保存。
  单位为MB，参数值配置格式为数值+单位，例如"storage_limit": "200MB"，有效取值范围为[200, 4294967296]。
  
  未配置本参数时，默认取值为Profiling数据文件存放目录所在磁盘可用空间的90%。（Atlas 推理系列产品）（Atlas 训练系列产品）
- aicpu：采集AICPU算子的详细信息，如：算子执行时间、数据拷贝时间等。可选on或off，默认值为off。可选参数。
- aic_metrics：AI Core采集事件，默认值为PipeUtilization。可选参数。
  AI Core采集事件包括：ArithmeticUtilization、PipeUtilization、Memory、MemoryL0、 MemoryUB、ResourceConflictRatio。以上各参数值对应的详细采集指标请参见AI Core性能指标采集项说明。
- l2：控制L2采样数据的开关，可选on或off，默认为off。（Atlas 推理系列产品）（Atlas 训练系列产品）。可选参数。
- hccl：控制hccl数据采集开关。
  - json文件中配置该参数时，可选配on或off。
  - json文件中未配置该参数时，默认为空，不采集；当task_time设置为on时，该参数联动被设置为on。
- msproftx：控制msproftx用户和上层框架程序输出性能数据的开关，可选on或off，默认值为off。
  Profiling开启msproftx功能之前，需要在程序内调用msproftx相关接口来开启程序的Profiling数据流的输出，详细操作请参见Profiling AscendCL API for Extension（Profiling AscendCL API扩展接口）。
- task_time：控制任务调度耗时以及算子耗时的开关。涉及在ai_stack_time、task_time、op_summary、op_statistic文件中输出相关耗时数据。可选on或off，默认为on。
- ascendcl：控制acl性能数据采集的开关，可选on或off，默认为on。可采集acl性能数据，包括Host与Device之间、Device间的同步异步内存复制时延等。
- runtime_api：控制runtime api性能数据采集开关，可选on或off，默认为on。可采集runtime-api性能数据，包括Host与Device之间、Device间的同步异步内存复制时延等。
配置acl.json文件完成后，参考《应用软件开发指南 (C&C++)》重新编译应用工程、并运行应用工程。
“output”指定路径下生成Profiling性能原始数据，如图1所示。

图1 Profiling性能原始数据

如果acl.json文件之前已经存在，本处仅仅是修改文件内容、添加Profiling相关配置，则不需要重新编译应用工程。

采集数据说明

配置acl.json Profiling参数后请参见数据解析与导出将原始数据文件解析并导出为可视化的Timeline和Summary文件。

生成的Profiling数据如表1和表2所示。

表1 timeline文件介绍
timeline文件名	相关参数	说明
msprof*.json	所有可生成数据的参数均会在此文件写入数据。	timeline数据总表。对采集到的timeline性能数据按照迭代粒度进行性能展示。详情请参见timeline数据总表。
ai_stack_time_*.json	ascendcl runtime_api task_time 以上参数可选。	各个组件（AscendCL，GE，Runtime，Task Scheduler）的耗时。详情请参见AscendCL、GE、Runtime、Task Schduler组件耗时数据概览。
thread_group_*.json	ascendcl runtime_api task_time 以上参数可选。	AscendCL，GE，Runtime组件耗时数据。该文件内的各组件数据按照线程（Thread）粒度进行排列，方便查看各线程下各组件的耗时数据。当模型为动态Shape时自动采集并生成该文件。文件详情请参见AscendCL、GE、Runtime组件耗时完整数据（按线程粒度展示）。
task_time_*.json	task_time	Task Scheduler任务调度信息。文件详情请参见Task Scheduler任务调度信息数据。
acl_*.json	ascendcl	AscendCL接口耗时数据。文件详情请参见AscendCL接口耗时数据。
runtime_api_*.json	runtime_api	Runtime接口耗时数据。文件详情请参见Runtime接口耗时数据。
ge_*.json	-	GE接口耗时数据。文件详情请参见GE接口耗时数据。
ge_op_execute_*.json	task_time	算子下发各阶段耗时数据。当模型为动态Shape时自动采集并生成该文件。文件详情请参见算子下发各阶段耗时数据。
step_trace_*.json	task_time	迭代轨迹数据，每轮迭代的耗时。文件详情请参见迭代轨迹数据。
hccl_*.json	hccl	HCCL数据。文件详情请参见HCCL数据。
msproftx数据	msproftx	msproftx数据，通过Profiling AscendCL API for Extension（Profiling AscendCL API扩展接口）采集用户和上层框架程序的性能数据，并由msproftx参数进行数据导出。
注：“*”表示{device_id}_{model_id}_{iter_id}，其中{device_id}表示设备ID，{model_id}表示模型ID，{iter_id}表示某轮迭代的ID。这些字段可以使用数据解析与导出完成数据解析后，使用数据解析与导出中的“Profiling数据文件信息查询”功能对结果文件进行查询得出，若查询某些字段显示为N/A（为空）则在导出的结果文件名中不展示。

表2 summary文件介绍
summary文件名	相关参数	说明
acl_*.csv	ascendcl	AscendCL接口的耗时。详情请参见AscendCL接口耗时数据。
acl_statistic_*.csv	ascendcl	AscendCL接口调用次数及耗时。详情请参见AscendCL接口调用次数及耗时数据。
op_summary_*.csv	task_time	AI Core和AI CPU算子信息。详情请参见AI Core和AI CPU算子数据。
op_statistic_*.csv	task_time	AI Core和AI CPU算子调用次数及耗时，从算子类型维度找出耗时最大的算子类型。详情请参见AI Core和AI CPU算子调用次数及耗时数据。
step_trace_*.csv	task_time	迭代轨迹数据。文件详情请参见迭代轨迹数据。
ai_stack_time_*.csv	ascendcl runtime_api task_time 以上参数可选。	每个组件（AscendCL，GE，Runtime，Task Scheduler）的耗时。详情请参见各个组件的耗时数据。
runtime_api_*.csv	runtime_api	每个runtime api的调用时长。详情请参见Runtime接口耗时数据。
fusion_op_*.csv	-	模型中算子融合前后信息。详情请参见模型中算子融合前后信息数据。
ge_op_execute_*.csv	task_time	算子下发各阶段耗时数据。当模型为动态Shape时自动采集并生成该文件。文件详情请参见算子下发各阶段耗时数据。
task_time_*.csv	task_time	Task Scheduler的任务调度信息数据。详情请参见： Task Scheduler的任务调度信息数据。 Task Scheduler的任务调度信息数据。
aicpu_*.csv	aicpu	AI CPU数据。文件详情请参见AI CPU数据。
l2_cache_*.csv	l2	L2Cache数据。详情请参见L2Cache数据。（Atlas 推理系列产品）（Atlas 训练系列产品）
prof_rule_0.json	-	调优建议。无需指定Profiling参数自动生成，完成后打屏显示结果，详细介绍请参见性能调优建议。
注：“*”表示{device_id}_{model_id}_{iter_id}，其中{device_id}表示设备ID，{model_id}表示模型ID，{iter_id}表示某轮迭代的ID。这些字段可以使用数据解析与导出完成数据解析后，使用数据解析与导出中的“Profiling数据文件信息查询”功能对结果文件进行查询得出，若查询某些字段显示为N/A（为空）则在导出的结果文件名中不展示。

父主题： 高级功能