Profiling数据采集功能

功能介绍

性能分析工具（Profiling）用于采集和分析算子在昇腾AI处理器上运行阶段的关键性能指标，用户可根据输出的性能数据，快速定位软、硬件性能瓶颈，提升算子运行性能。

使用方法（命令行）

通过命令行进行性能数据采集的关键步骤如下，详细样例参考上板Profiling数据采集。

1. 执行如下命令使能Profiling功能，这里仅提供关键配置项，其他配置项参考NPU调测参数按需配置。
   • 开启Profiling数据采集功能
     • 基础功能：无需配置，默认采集PipeUtilization数据。

       ascendebug kernel --backend npu --profiling ... {其他NPU调测参数}

     • 高级功能（可选）：如需采集其他数据，可进一步设置${profiling_metrics}。

       ascendebug kernel --backend npu --profiling ${profiling_metrics} ... {其他NPU调测参数}

   • 开启Profiling数据采集和时间戳打点功能
     1. 在核函数代码中按需调用AscendCTimeStamp自定义打点标识，descId取值参见表2，样例如下：

         AscendC::AscendCTimeStamp(descId);

     2. NPU调测命令示例如下：
        • 基础功能：无需配置，默认采集PipeUtilization数据。

          ascendebug kernel --backend npu  --dump-mode time_stamp --profiling ... {其他NPU调测参数}

        • 高级功能（可选）：如需采集其他数据，可进一步设置${profiling_metrics}。

          ascendebug kernel --backend npu  --dump-mode time_stamp --profiling ${profiling_metrics} ... {其他NPU调测参数}

   其中${profiling_metrics}支持的取值如下：

   • Atlas 200/300/500 推理产品：ArithmeticUtilization、PipeUtilization（默认值）、Memory、MemoryL0、MemoryUB、ResourceConflictRatio
   • Atlas 200/500 A2推理产品：ArithmeticUtilization、PipeUtilization、Memory、MemoryL0、MemoryUB、ResourceConflictRatio、L2Cache、PipelineExecuteUtilization（默认值）
   • Atlas 推理系列产品（Ascend 310P处理器）：ArithmeticUtilization、PipeUtilization（默认值）、Memory、MemoryL0、MemoryUB、ResourceConflictRatio
   • Atlas 训练系列产品：ArithmeticUtilization、PipeUtilization（默认值）、Memory、MemoryL0、MemoryUB、ResourceConflictRatio
   • Atlas A2训练系列产品/Atlas 800I A2推理产品：ArithmeticUtilization、PipeUtilization（默认值）、Memory、MemoryL0、MemoryUB、ResourceConflictRatio、L2Cache

   更多关于数据采集高级功能的介绍可参考《性能分析工具使用指南》的“msprof命令行工具>性能数据采集>采集AI任务运行性能数据”章节中--aic-metrics配置项。

2. 检查是否成功使能Profiling。

   当打屏日志中有调用msprof开启profiling的调用信息，并且有“npu kernel run end” 信息则表示Profiling执行完成。

3. 查看结果文件，详细说明参见产物说明。

使用方法（API）

通过API开启性能数据采集的关键步骤如下，详细样例参考上板Profiling数据采集。

1. 完成环境搭建，并准备好输入/标杆数据文件。
   

   核函数直调工程场景下，需提前配置好核函数源码信息OpKernelInfo。

2. 构建算子信息。调用DebugOp类里input系列接口（如tensor_input、custom_input等），设置算子的输入、输出、属性值等信息。
3. 创建调试对象并初始化工作空间。调用create_op_executor接口，创建调试对象op_executor，用户可传入${work_dir}参数手动设置工作空间。
4. （可选）参考Tiling调测功能 > 使用方法（API）章节，调用Tiling调测接口生成Tiling Info文件。
   

   本步骤仅适用于没有Tiling Info文件的场景，需调用Tiling调测API生成Tiling Info。

5. 调用NPU编译接口和Profiling运行接口。
   1. 通过CompileNpuOptions设置NPU编译相关的功能，如内存检测功能。
   2. 根据不同场景调用对应的NPU编译接口。
      • 标准自定义算子场景： 调用compile_custom_npu接口。
      • 核函数直调场景：调用compile_call_kernel_npu接口。
      • ops_adv算子场景：调用compile_ops_adv_npu接口。
   3. 通过RunProfilingOptions设置性能数据采集相关的功能，并通过NpuCompileInfo设置NPU编译属性。
   4. 调用run_profiling接口。

   接口调用示例如下：

   • 开启Profiling数据采集功能

     # 调用NPU编译接口
     compile_npu_options = ascendebug.CompileNpuOptions()
     name, kernel_file, extern = op_executor.compile_custom_npu(customize_path, tiling_info.tiling_key, compile_npu_options)
     # 配置Profiling属性，调用Profiling运行接口
     profiling_options = ascendebug.RunProfilingOptions(block_num=24, loop=10)
     npu_compile_info = ascendebug.NpuCompileInfo(syncall=extern['cross_core_sync'], task_ration=extern['task_ration'])
     op_executor.run_profiling(kernel_file, profiling_options, npu_compile_info=npu_compile_info, tiling_info=tiling_info)

   • 开启Profiling数据采集和时间戳打点功能
     1. 在核函数代码中按需调用AscendCTimeStamp自定义打点标识，descId取值参见表2，样例如下：

         AscendC::AscendCTimeStamp(descId);

     2. 设置dump_model为“time_stamp”，样例如下：

        # 调用NPU编译接口
        compile_npu_options = ascendebug.CompileNpuOptions(dump_mode='time_stamp')
        name, kernel_file, extern = op_executor.compile_custom_npu(customize_path, tiling_info.tiling_key, compile_npu_options)
        # 配置Profiling属性，调用Profiling运行接口
        profiling_options = ascendebug.RunProfilingOptions(block_num=24, loop=10)
        npu_compile_info = ascendebug.NpuCompileInfo(syncall=extern['cross_core_sync'], task_ration=extern['task_ration'], dump_mode='time_stamp)
        op_executor.run_profiling(kernel_file, profiling_options, npu_compile_info=npu_compile_info, tiling_info=tiling_info)

6. 查看结果文件，详细说明参见产物说明。

产物说明

无论是命令行方式或API方式，Profiling解析结果存放在${root}/${work_dir}/npu/output路径下，其中${root}表示当前操作路径，${work_dir}表示调测工作空间，默认为/debug_workspace/${op_type}目录，${op_type}为算子名。目录结构示例如下，默认情况下采集到的文件如表1所示。

├ ${op_type}               // 算子名
├── npu
│   ├── build           // 存放NPU编译生成的中间文件
│       ├── launch_args.so
│   ├── output         // 存放NPU编译运行的输出文件及精度比对结果
│       ├── y.bin      // 运行输出原始数据
│       ├── y.txt      // 精度比对结果文件
│       ├── PROF_00000x_xxxx_xxx        // 存放Profiling结果文件
│           ├── mindstudio_profiler_output
│               ├── task_time_*.csv
│               ├── prof_rule_*.json
│               ├── op_summary_*.csv
│               ├── op_statistic_*.csv
│               ├── api_statistic_*.csv
│               ├── step_trace_*.csv
│               ├── step_trace_*.json
│               ├── msprof_*.json       // 若开启时间戳打点，会包含该信息
│   ├── src          // 存放NPU编译生成的临时代码文件
│       ├── _gen_args_${op_type}.cpp

• json文件可视化界面呈现。

  在Chrome浏览器中输入chrome://tracing，将文件拖到空白处打开，通过键盘上的快捷键（w：放大，s：缩小，a：左移，d：右移）查看。该文件可查看当前AI任务运行的时序信息，比如运行过程中接口调用时间线，如图1所示。

  图1 查看json文件
  

  对于msprof_*.json，若开启时间戳打点功能，可通过timeline查看内置打点信息和自定义打点信息，打点位置在算子profiling中。

  

• csv文件查看。

  csv文件支持离线查看，可看到AI任务运行时的软硬件数据，比如各算子在AI处理器软硬件上的运行耗时，通过字段排序等可以快速找出需要的信息，如图2所示。

  图2 查看csv文件
  

  对于op_summary_*.csv，支持在线屏显summary关键字段信息（如下表），生成的字段由${profiling_metrics}取值控制，更多字段详细介绍参见《性能分析工具使用指南》中“性能数据文件参考 > op_summary（算子详细信息）”。

  表2 summary屏显字段说明

  字段名	字段含义	profiling_metrics取值
  Task Duration(us)	Task耗时，包含调度到加速器的时间、加速器上的执行时间以及结束响应时间，单位us。	公共字段
  Task Wait Time(us)	上一个Task的结束时间与当前Task的开始时间间隔，单位us。
  aicore_time(us)	当所有的Block被同时调度，且每个Block的执行时长相等时，该Task在AI Core上的理论执行时间，单位us。通常情况下，不同的Block开始调度时间略有差距，故该字段值略小于Task在AI Core上的实际执行时间。 当AI Core频率变化（比如进行手动调频、功耗超出阈值时动态调频以及Atlas 300V/Atlas 300I Pro产品）时该数据不准确，不建议参考。
  aiv_time(us)	当所有的Block被同时调度，且每个Block的执行时长相等时，该Task在AI Vector Core上的理论执行时间，单位us。通常情况下，不同的Block开始调度时间略有差距，故该字段值略小于Task在AI Vector Core上的实际执行时间。（Atlas A2训练系列产品/Atlas 800I A2推理产品） --task-time=l1、--aic-mode=task-based时生成。
  ai*_vec_time(us)	vec类型指令（向量类运算指令）耗时，单位us。	PipeUtilization
  ai*_mac_time(us)	cube类型指令（矩阵类运算指令）耗时，单位us。
  ai*_scalar_time(us)	scalar类型指令（标量类运算指令）耗时，单位us。
  ai*_fixpipe_time(us)	fixpipe类型指令（L0C->OUT/L1搬运类指令）耗时，单位us。
  ai*_mte1_time(us)	mte1类型指令（L1->L0A/L0B搬运类指令）耗时，单位us。
  ai*_mte2_time(us)	mte2类型指令（HBM->AICORE搬运类指令）耗时，单位us。
  ai*_mte3_time(us)	mte3类型指令（AICORE->HBM搬运类指令）耗时，单位us。

  表3 summary屏显字段说明

  字段名	字段含义	profiling_metrics取值
  Task Duration(us)	Task耗时，包含调度到加速器的时间、加速器上的执行时间以及结束响应时间，单位us。	公共字段
  Task Wait Time(us)	上一个Task的结束时间与当前Task的开始时间间隔，单位us。
  aicore_time(us)	当所有的Block被同时调度，且每个Block的执行时长相等时，该Task在AI Core上的理论执行时间，单位us。通常情况下，不同的Block开始调度时间略有差距，故该字段值略小于Task在AI Core上的实际执行时间。 当AI Core频率变化（比如进行手动调频、功耗超出阈值时动态调频以及Atlas 300V/Atlas 300I Pro产品）时该数据不准确，不建议参考。
  vec_time(us)	vec类型指令（向量类运算指令）耗时，单位us。Atlas 200/500 A2推理产品不支持该字段，给予默认值N/A。	PipeUtilization
  mac_time(us)	cube类型指令（矩阵类运算指令）耗时，单位us。
  scalar_time(us)	scalar类型指令（标量类运算指令）耗时，单位us。
  mte1_time(us)	mte1类型指令（L1->L0A/L0B搬运类指令）耗时，单位us。
  mte2_time(us)	mte2类型指令（DDR->AICORE搬运类指令）耗时，单位us。
  mte3_time(us)	mte3类型指令（AICORE->DDR搬运类指令）耗时，单位us。

  表4 summary屏显字段说明

  字段名	字段含义	profiling_metrics取值
  Task Duration(us)	Task耗时，包含调度到加速器的时间、加速器上的执行时间以及结束响应时间，单位us。	公共字段
  Task Wait Time(us)	上一个Task的结束时间与当前Task的开始时间间隔，单位us。
  aicore_time(us)	当所有的Block被同时调度，且每个Block的执行时长相等时，该Task在AI Core上的理论执行时间，单位us。通常情况下，不同的Block开始调度时间略有差距，故该字段值略小于Task在AI Core上的实际执行时间。 当AI Core频率变化（比如进行手动调频、功耗超出阈值时动态调频以及Atlas 300V/Atlas 300I Pro产品）时该数据不准确，不建议参考。
  vec_time(us)	vec类型指令（向量类运算指令）耗时，单位us。Atlas 200/500 A2推理产品不支持该字段，给予默认值N/A。	PipeUtilization
  mac_time(us)	cube类型指令（矩阵类运算指令）耗时，单位us。
  scalar_time(us)	scalar类型指令（标量类运算指令）耗时，单位us。
  mte1_time(us)	mte1类型指令（L1->L0A/L0B搬运类指令）耗时，单位us。
  mte2_time(us)	mte2类型指令（DDR->AICORE搬运类指令）耗时，单位us。
  mte3_time(us)	mte3类型指令（AICORE->DDR搬运类指令）耗时，单位us。
  fixpipe_exe_time(us)	fixpipe类型指令（L0C->OUT/L1搬运类指令）耗时，单位us。	PipelineExecuteUtilization