Profiling性能数据采集

关于Device的同步等待

调用接口后，需增加异常处理的分支，并记录报错日志、提示日志，示例代码中不一一列举。以下是关键步骤的代码示例，不可以直接拷贝运行，仅供参考。

 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21  python import acl # ...... device_id = 0 # 指定Device。 ret = acl.rt.set_device(device_id) # 创建context。 context, ret = acl.rt.create_context(device_id) # 创建stream。 stream, ret = acl.rt.create_stream() # 阻塞应用程序运行，直到正在运算中的Device完成运算。 ret = acl.rt.synchronize_device() # 资源销毁。 ret = acl.rt.synchronize_stream(stream) ret = acl.rt.destroy_context(context) ret = acl.rt.reset_device(device_id)

父主题： 同步等待

AI Core异常信息获取

基本原理

使用场景****举例：执行整网模型推理时（不支持动态Shape场景），如果产生AI Core报错，可以调用本接口获取报错算子的描述信息，再做进一步错误排查。

推荐的接口调用顺序如下：

定义并实现异常回调函数fn(aclrtExceptionInfoCallback类型)，回调函数原型请参见acl.rt.set_exception_info_callback。

实现回调函数的关键步骤如下：
1. 在异常回调函数fn内调用acl.rt.get_device_id_from_exception_info、acl.rt.get_stream_id_from_exception_info、acl.rt.get_task_id_from_exception_info接口分别获取Device ID、Stream ID、Task ID。
2. 在异常回调函数fn内调用acl.mdl.create_and_get_op_desc接口获取算子的描述信息。
3. 在异常回调函数fn内调用acl.get_tensor_desc_by_index接口获取指定算子输入/输出的Tensor描述。
4. 在异常回调函数fn内如下接口获取Tensor描述中的数据，进行进一步分析。
  
  例如，调用acl.get_tensor_desc_address接口获取Tensor数据的内存地址（用户可从该内存地址中获取Tensor数据）、调用acl.get_tensor_desc_type接口获取Tensor描述中的数据类型、调用acl.get_tensor_desc_format接口获取Tensor描述中的Format、调用acl.get_tensor_desc_num_dims接口获取Tensor描述中的Shape维度个数、调用acl.get_tensor_desc_dim_v2接口获取Shape中指定维度的大小。
调用acl.rt.set_exception_info_callback接口设置异常回调函数。
执行模型推理。

如果存在AI Core报错，则触发回调函数fn，获取算子的信息，进行进一步分析。

示例代码

调用接口后，需增加异常处理的分支，示例代码中不一一列举。以下是关键步骤的代码示例，不可以直接拷贝运行，仅供参考。

示例中，运行管理资源申请与释放请参见运行管理资源申请与释放，模型加载的接口调用流程请参见接口调用流程，模型推理的接口调用流程、准备模型推理的输入/输出数据的接口调用流程请参见准备模型执行的输入/输出数据结构。

 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53  python import acl import numpy as np # ...... # 1.申请运行管理资源，包括设置用于计算的Device、创建Context、创建Stream。 # ...... # 2.模型加载，加载成功后，返回标识模型的model_id。 # ...... # 3.创建aclmdlDataset类型的数据，用于描述模型的输入数据input、输出数据output。 # ...... # 4.实现异常回调函数。 def exception_callback(info): stream_id = acl.rt.get_stream_id_from_exception_info(info) thread_id = acl.rt.get_thread_id_from_exception_info(info) device_id = acl.rt.get_device_id_from_exception_info(info) task_id = acl.rt.get_task_id_from_exception_info(info) # 用户可以将获取的算子信息写入到文件，或者另起线程侦听异常回调，当发生异常回调时触发线程处理函数，在线程处理函数中将算子信息打屏。 op_name, input_desc, num_inputs, output_desc, num_outputs, ret = \ acl.mdl.create_and_get_op_desc(device_id, stream_id, task_id, 256) # 可以调用acl tensor的相关接口，获取算子的相关信息，用户可以根据自己需要调用。 for i in range(num_inputs): desc = acl.get_tensor_desc_by_index(input_desc, i) address = acl.get_tensor_desc_address(desc) num_dims = acl.get_tensor_desc_num_dims(desc) dim_0, ret = acl.get_tensor_desc_dim_v2(desc, 0) for i in range(num_outputs): desc = acl.get_tensor_desc_by_index(output_desc, i) address = acl.get_tensor_desc_address(desc) num_dims = acl.get_tensor_desc_num_dims(desc) dim_0, ret = acl.get_tensor_desc_dim_v2(desc, 0) acl.destroy_tensor_desc(input_desc) acl.destroy_tensor_desc(output_desc) # 5.设置异常回调。 ret = acl.rt.set_exception_info_callback(exception_callback) # 6.执行模型。 ret = acl.mdl.execute(model_id, input, output) # 7.处理模型推理结果。 # ...... # 8.释放描述模型输入/输出信息、内存等资源，卸载模型。 # ...... # 9.释放运行管理资源。 # ......

父主题： 扩展更多特性

Profiling性能数据采集

基本原理

该章节下的接口用于Profiling采集性能数据，实现方式支持以下三种：

Profiling pyACL API（通过Profiling pyACL API采集并落盘性能数据）：实现将采集到的Profiling数据写入文件，再使用Profiling工具解析该文件（请参见《性能分析工具使用指南》下的“数据解析与导出”），并展示性能分析数据。

包括以下两种接口调用方式：

acl.prof.init接口、acl.prof.start接口、acl.prof.stop接口、acl.prof.finalize接口配合使用，实现该方式的性能数据采集。该方式可获取pyACL的接口性能数据、AI Core上算子的执行时间、AI Core性能指标数据等。目前这些接口为进程级控制，表示在进程内任意线程调用该接口，其它线程都会生效。

一个进程内，可以根据需求多次调用这些接口，基于不同的Profiling采集配置，采集数据。
调用acl.init接口，在pyACL初始化阶段，通过*.json 文件传入要采集的Profiling数据。该方式可获取pyACL的接口性能数据、AI Core上算子的执行时间、AI Core性能指标数据等。

一个进程内，只能调用一次acl.init接口，如果要修改Profiling采集配置，需修改*.json文件中的配置。详细使用说明请参见acl.init接口处的说明，不在本章节描述。

Profiling pyACL API for Extension（Profiling pyACL API扩展接口）：当用户需要定位应用程序或上层框架程序的性能瓶颈时，可在Profiling采集进程内（acl.prof.start接口、acl.prof.stop接口之间）调用Profiling pyACL API扩展接口（统称为msproftx功能），开启记录应用程序执行期间特定事件发生的时间跨度，并将数据写入Profiling数据文件，再使用Profiling工具解析该文件，并导出展示性能分析数据。

Profiling工具解析导出操作请参见《性能分析工具使用指南》下的“Profiling数据解析”和“Profiling数据导出”。

一个进程内，可以根据需求多次调用这些接口。

接口调用方式：在acl.prof.start和acl.prof.stop接口之间调用acl.prof.create_stamp、acl.prof.push、acl.prof.pop、acl.prof.range_start、acl.prof.range_stop、acl.prof.destroy_stamp接口。该方式可获取应用程序执行期间特定时间发生的事件并记录事件发生的时间跨度。

一个进程内，可以根据需求多次调用这些接口。

Profiling pyACL API for Subscription（订阅算子信息的Profiling pyACL API）：实现将采集到的Profiling数据解析后写入管道，由用户读入内存，再由用户调用pyACL的接口获取性能数据。

接口调用方式：acl.prof.model_subscribe接口、acl.prof.get*接口、acl.prof.model_unsubscribe接口配合使用，实现该方式的性能数据采集，当前支持获取网络模型中算子的性能数据，包括算子名称、算子类型名称、算子执行时间等。

Profiling pyACL API示例代码

调用接口后，需增加异常处理的分支，示例代码中不一一列举。以下是关键步骤的代码示例，不可以直接拷贝运行，仅供参考。

示例中，运行管理资源申请与释放请参见运行管理资源申请流程与运行管理资源释放流程，模型加载的接口调用流程请参见接口调用流程，模型推理的接口调用流程、准备模型推理的输入/输出数据的接口调用流程请参见准备模型执行的输入/输出数据结构。

 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48  python import acl import numpy as np # ...... # 1.申请运行管理资源，包括设置用于计算的Device、创建Context、创建Stream。 # ...... # 2.模型加载，加载成功后，返回标识模型的model_id。 # ...... # 3.创建aclmdlDataset类型的数据，用于描述模型的输入数据input、输出数据output。 # ...... # 4.profiling初始化。 # 设置数据落盘路径。 PROF_INIT_PATH='...' ret = acl.prof.init(PROF_INIT_PATH) # 5.进行profiling配置。 device_list = [0] ACL_PROF_ACL_API = 0x0001 ACL_PROF_TASK_TIME = 0x0002 ACL_PROF_AICORE_METRICS = 0x0004 ACL_PROF_AICPU_TRACE = 0x0008 ACL_PROF_SYS_HARDWARE_MEM_FREQ = 3 # 创建配置类型指针地址。 prof_config = acl.prof.create_config(device_list, 0, 0, ACL_PROF_ACL_API | ACL_PROF_TASK_TIME | ACL_PROF_AICPU | ACL_PROF_AICORE_METRICS | ACL_PROF_HCCL_TRACE) mem_freq = "15" ret = acl.prof.set_config(ACL_PROF_SYS_HARDWARE_MEM_FREQ, mem_freq) ret = acl.prof.start(prof_config) # 6.执行模型。 ret = acl.mdl.execute(model_id, input, output) # 7.处理模型推理结果。 # ...... # 8.释放描述模型输入/输出信息、内存等资源，卸载模型。 # ...... # 9.关闭profiling配置, 释放配置资源, 释放profiling组件资源。 ret = acl.prof.stop(prof_config) ret = acl.prof.destroy_config(prof_config) ret = acl.prof.finalize() # 10.释放运行管理资源 # ......

Profiling pyACL API for Extension示例代码

调用接口后，需增加异常处理的分支，示例代码中不一一列举。以下是关键步骤的代码示例，不可以直接拷贝运行，仅供参考。

for i in range(200000):
    stamp = acl.prof.create_stamp()
     if stamp == 0:
        print("create stamp failed")
        return FAILED

    msg = "test msprof tx"
    msg_len = len(msg)
    ret = acl.prof.set_stamp_trace_message(stamp, msg, msg_len)
    ret = acl.prof.mark(stamp)

    ret = acl.prof.destroy_stamp(stamp)

或

for i in range(200000):
    stamp = acl.prof.create_stamp()
     if stamp == 0:
        print("create stamp failed")
        return FAILED

    msg = "test msprof tx"
    msg_len = len(msg)
    ret = acl.prof.set_stamp_trace_message(stamp, msg, msg_len)

## acl.prof.push 和 acl.prof.pop 接口配对使用，完成单线程采集
    ret = acl.prof.push(stamp)
    ret = acl.prof.pop()

    ret = acl.prof.destroy_stamp(stamp)

或

for i in range(200000):
    stamp = acl.prof.create_stamp()
     if stamp == 0:
        print("create stamp failed")
        return FAILED

    msg = "test msprof tx"
    msg_len = len(msg)
    ret = acl.prof.set_stamp_trace_message(stamp, msg, msg_len)

## acl.prof.range_start 和 acl.prof.range_stop 接口配对使用，可以完成多线程采集
    range_id = 0
    range_id, ret = acl.prof.range_start(stamp)
    ret = acl.prof.range_stop(range_id)

    ret = acl.prof.destroy_stamp(stamp)

Profiling pyACL API for Subscription示例代码

调用接口后，需增加异常处理的分支，示例代码中不一一列举。以下是关键步骤的代码示例，不可以直接拷贝运行，仅供参考。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 python import acl import numpy as np # ...... # 1.申请运行管理资源，包括设置用于计算的Device、创建Context、创建Stream。 # ...... # 2.模型加载，加载成功后，返回标识模型的model_id。 # ...... # 3.创建aclmdlDataset类型的数据，用于描述模型的输入数据input、输出数据output。 # ...... # 4.创建管道，用于读取以及写入模型订阅的数据。 r, w = os.pipe() # 5.创建模型订阅的配置并且进行模型订阅。 ACL_AICORE_NONE = 0xFF subscribe_config = acl.prof.create_subscribe_config(1, ACL_AICORE_NONE, w) # 模型订阅需要传入模型的model_id。 ret = acl.prof.model_subscribe(model_id, subscribe_config) # 6.实现管道读取订阅数据的函数。 # 6.1 自定义函数，实现从用户内存中读取订阅数据的函数。 def get_model_info(data, data_len): # 获取算子信息个数。 op_number, ret = acl.prof.get_op_num(data, data_len) # 遍历用户内存的算子信息。 for i in range(op_number): # 获取算子的模型id。 model_id = acl.prof.get_model_id(data, data_len, i) # 获取算子的类型名称。 op_type, ret = acl.prof.get_op_type(data, data_len, i, 65) # 获取算子的名称。 op_name, ret = acl.prof.get_op_name(data, data_len, i, 275) # 获取算子的执行开始时间。 op_start = acl.prof.get_op_start(data, data_len, i) # 获取算子的执行结束时间。 op_end = acl.prof.get_op_end(data, data_len, i) # 获取算子执行的耗时时间。 op_duration = acl.prof.get_op_duration(data, data_len, i) # 6.2 自定义函数，实现从管道中读取数据到用户内存的函数。 def prof_data_read(args): fd, ctx = args ret = acl.rt.set_context(ctx) # 获取单位算子信息的大小（Byte）。 buffer_size, ret = acl.prof.get_op_desc_size() # 设置每次从管道中读取的算子信息个数。 N = 10 # 计算存储算子信息的内存的大小。 data_len = buffer_size * N # 从管道中读取数据到申请的内存中，读取到的实际数据大小可能小于buffer_size * N，如果管道中没有数据，默认会阻塞直到读取到数据为止。 while True: data = os.read(fd, data_len) if len(data) == 0: break np_data = np.array(data) bytes_data = np_data.tobytes() np_data_ptr = acl.util.bytes_to_ptr(bytes_data) size = np_data.itemsize * np_data.size # 调用6.1实现的函数解析内存中的数据。 get_model_info(np_data_ptr, size) # 7.启动线程读取管道数据并解析。 thr_id, ret = acl.util.start_thread(prof_data_read, [r, context]) # 8.执行模型。 ret = acl.mdl.execute(model_id, input, output) # 9.处理模型推理结果。 # ...... # 10.释放描述模型输入/输出信息、内存等资源，卸载模型。 # ...... # 11.取消订阅，释放订阅相关资源。 ret = acl.prof.model_unsubscribe(model_id) ret = acl.util.stop_thread(thr_id) os.close(r) ret = acl.prof.destroy_subscribe_config(subscribe_config) # 12.释放运行管理资源。 # ......

父主题： 扩展更多特性

溢出算子数据采集及分析

前提条件

使用ATC工具转换模型时，需在转换命令中增加“--status_check”参数，并将参数值设置为“1”，表示在编译算子时添加溢出检测逻辑。

关于ATC工具及其参数的详细说明，请参见《ATC工具使用指南》。

采集溢出算子信息

在调用调用acl.init接口初始化pyACL时，在JSON配置文件中增加溢出算子Dump配置。

JSON配置文件中的示例内容如下，示例中的“dump_path”以相对路径为例：

&#123;
    "dump":&#123;
        "dump_path":"output",
        "dump_debug":"on"
    &#125;
&#125;

当dump_path配置为相对路径时，您可以在“应用可执行文件的目录/{dump_path}”下查看导出的数据文件，针对每个溢出算子，会导出两个数据文件：

溢出算子的dump文件：命名规则如{op_type}.{op_name}.{taskid}.{stream_id}.{timestamp}，如果op_type、op_name出现了“.”、“/”、“\”、空格时，会转换为下划线表示。

用户可通过该信息知道具体出现溢出错误的算子，并通过解析溢出算子的dump文件获取该算子的输入和输出信息。
算子溢出数据文件：命名规则如OpDebug.Node_Opdebug.{taskid}.{stream_id}.{timestamp}，其中taskid不是溢出算子的taskid，用户不需要关注taskid的实际含义。

用户可通过解析算子溢出数据文件获取溢出相关信息，包括溢出算子所在的模型、AICore的status寄存器状态等。

解析溢出算子的dump文件

请根据实际情况，将{op_type}.{op_name}.{taskid}.{stream_id}.{timestamp}上传到安装有Toolkit软件包的环境。
进入解析脚本所在目录，例如Toolkit软件包安装目录为：/home/HwHiAiUser/Ascend/ascend-toolkit/latest。
```
cd /home/HwHiAiUser/Ascend/ascend-toolkit/latest/toolkit/tools/operator_cmp/compare
```
执行msaccucmp.py脚本，转换dump文件为numpy文件。举例：
```
python3 msaccucmp.py convert -d /home/HwHiAiUser/dump -out /home/HwHiAiUser/dumptonumpy -v 2
```
:::note 说明 -d参数支持传入单个文件，对单个dump文件进行转换，也支持传入目录，对整个path下所有的dump文件进行转换。 :::

调用Python，转换numpy文件为txt文件。举例：

$ python3
>>> import numpy as np
>>> a = np.load("/home/HwHiAiUser/dumptonumpy/Pooling.pool1.1147.1589195081588018.output.0.npy")
>>> b = a.flatten()
>>> np.savetxt("/home/HwHiAiUser/dumptonumpy/Pooling.pool1.1147.1589195081588018.output.0.txt", b)

转换为.txt格式文件后，维度信息、Dtype均不存在。详细的使用方法请参考numpy官网介绍。

解析算子溢出数据文件

由于生成的溢出数据是二进制格式，可读性较差，需要通过工具将bin文件解析为用户可读性好的JSON文件。

请根据实际情况，将溢出数据文件OpDebug.Node_Opdebug.{taskid}.{timestamp}上传到安装有Toolkit软件包的环境。
进入解析脚本所在路径，例如Toolkit软件包安装目录为：/home/HwHiAiUser/Ascend/ascend-toolkit/latest。
```
cd /home/HwHiAiUser/Ascend/ascend-toolkit/latest/toolkit/tools/operator_cmp/compare
```
执行解析命令，例如：
```
python3 msaccucmp.py convert -d /home/HwHiAiUser/opdebug/Opdebug.Node_OpDebug.59.1597922031178434  -out /home/HwHiAiUser/result
```
关键参数：
- -d：溢出数据文件所在目录，包括文件名。
- -out：解析结果待存储目录，如果不指定，默认生成在当前目录下。
解析结果文件内容如下所示。
```
&#123;
    "DHA Atomic Add": &#123;
        "model_id": 0,
        "stream_id": 0,
        "task_id": 0,
        "task_type": 0,
        "pc_start": "0x0",
        "para_base": "0x0",
        "status": 0
    &#125;,
    "L2 Atomic Add": &#123;
        "model_id": 0,
        "stream_id": 0,
        "task_id": 0,
        "task_type": 0,
        "pc_start": "0x0",
        "para_base": "0x0",
        "status": 0
    &#125;,
    "AI Core": &#123;
        "model_id": 514,
        "stream_id": 563,
        "task_id": 57,
        "task_type": 0,
        "pc_start": "0x1008005b0000",
        "para_base": "0x100800297000",
        "kernel_code": "0x1008005ae000",
        "block_idx": 1,
        "status": 32
    &#125;
&#125;
```
参数解释：
- model_id：标识溢出算子所在的模型id。
- stream_id：标识溢出算子所在的streamid。
- task_id：标识溢出算子的taskid。
- task_type：标识溢出算子的task类型。
- pc_start：标识溢出算子的代码程序的内存起始地址。
- para_base：标识溢出算子的参数的内存起始地址。
- kernel_code：标识溢出算子的代码程序的内存起始地址，和pc_start相同。
- block_idx：标识溢出算子的blockid参数。
- status：AICore的status寄存器状态，用户可以从status值分析得到具体溢出错误。status为10进制表示，需要转换成16进制，然后定位到具体错误。
  
  例如：status为272，转换成16进制为0x00000110，则可以判定出可能原因为0x00000010+0x00000100。
  - 0x00000008：符号整数最小负数NEG符号位取反溢出。
  - 0x00000010：整数加法、减法、乘法或乘加操作计算有溢出。
  - 0x00000020：浮点计算有溢出。
  - 0x00000080：浮点数转无符号数的输入是负数。
  - 0x00000100：FP32转FP16或32位符号整数转FP16中出现溢出。
  - 0x00000400：CUBE累加出现溢出。

父主题： 扩展更多特性

应用调试

运行应用

运行应用的步骤，请参考基于Caffe ResNet-50网络实现图片分类（同步推理）。

相关注意点如下：

模型转换，详细说明请参见《ATC工具使用指南》。
运行时，需将pyACL初始化配置文件（acl.json）所在的目录、测试图片所在的目录、*.om文件所在的目录都上传到Host的同一个目录下。

如果在pyACL初始化阶段，在acl.init接口中不传入参数，则无需将pyACL初始化配置文件（acl.json）所在的目录上传到Host。
运行代码时，直接运行对应的Python脚本即可。如：

`<br>1<br>`	`<br>python3 main.py<br>`

问题定位

运行应用时如果出错，您可以参见《日志参考》获取日志文件，以便查看日志文件中详细报错。根据报错初步定位后：

如果是接口约束导致接口调用逻辑不对，需查看总体的使用约束以及各接口本身的约束，再调整接口调用逻辑。
如果是算子在AI Core上运行报错，需要进一步定位算子报错的原因，可调用pyACL提供的接口，获取出错算子的描述信息，用于进一步分析时使用，可参见AI Core异常信息获取，查看原理及调用示例。

在线提单

关于Device的同步等待​

AI Core异常信息获取​

基本原理​

示例代码​

Profiling性能数据采集​

基本原理​

Profiling pyACL API示例代码​

Profiling pyACL API for Extension示例代码​

Profiling pyACL API for Subscription示例代码​

溢出算子数据采集及分析​

前提条件​

采集溢出算子信息​

解析溢出算子的dump文件​

解析算子溢出数据文件​

应用调试​

运行应用​

问题定位​

关于Device的同步等待

AI Core异常信息获取

基本原理

示例代码

Profiling性能数据采集

基本原理

Profiling pyACL API示例代码

Profiling pyACL API for Extension示例代码

Profiling pyACL API for Subscription示例代码

溢出算子数据采集及分析

前提条件

采集溢出算子信息

解析溢出算子的dump文件

解析算子溢出数据文件

应用调试

运行应用

问题定位