本工具主要针对Kernel直调工程（NPU模式）、简易自定义算子工程编译生成的算子ELF文件（Executable and Linkable Format）提供解析和解压功能，并将结果信息以可读形式呈现，方便开发者直观获得kernel文件信息。

ELF文件是一种用于二进制文件、可执行文件、目标代码、共享库和核心转储的文件格式，包括常见的*.a、*.so文件等。ELF文件常见构成如下：
- ELF头部：描述了整个文件的组织结构，包括文件类型、机器类型、版本号等信息。
- 程序头部表：描述了文件中各种段（segments）信息，包括程序如何加载到内存中执行的信息。
- 节区头部表：描述了文件中各个节（sections）信息，包括程序的代码、数据、符号表等。
工具使用过程中，若出现如下场景，请根据日志提示信息，分析排查问题。
- ELF文件未找到
- ELF文件权限错误
- ELF文件存在但不支持解析或解压

产品支持情况

产品	是否支持
Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件	√
Atlas 200I/500 A2 推理产品	√
Atlas 推理系列产品	√
Atlas 训练系列产品	√

工具安装

安装msobjdump工具。
工具跟随CANN软件包发布（参考环境准备完成CANN安装），其路径默认为“${INSTALL_DIR}/tools/msobjdump”，其中${INSTALL_DIR}请替换为CANN软件安装后文件存储路径。若安装的Ascend-cann-toolkit软件包，以root安装举例，则安装后文件存储路径为：/usr/local/Ascend/ascend-toolkit/latest。

设置环境变量。

root用户安装Ascend-cann-toolkit包时

source /usr/local/Ascend/ascend-toolkit/set_env.sh
source /usr/local/Ascend/ascend-toolkit/latest/toolkit/bin/setenv.bash

非root用户安装Ascend-cann-toolkit包时

source ${HOME}/Ascend/ascend-toolkit/set_env.sh
source ${HOME}/Ascend/ascend-toolkit/latest/toolkit/bin/setenv.bash

检查工具是否安装成功。
执行如下命令，若能正常显示--help或-h信息，则表示工具环境正常，功能可正常使用。
```
msobjdump -h
```

命令格式

解析ELF文件的命令

msobjdump --dump-elf <elf_file> [--verbose]

表1 参数说明
参数（区分大小写）	可选/必选	说明
--dump-elf <elf_file>，-d	必选	解析ELF文件中包含的device信息，如文件名、文件类型、文件长度、符号表等，并终端打屏显示。 <elf_file>表示待解析ELF文件路径，如/home/op_api/lib_api.so。支持两种打印模式：简单打印：默认仅打印部分device信息。全量打印：与--verbose配套使用，开启全量device信息打屏显示。不同工程打印字段信息不同，具体参见表4和表5。
--verbose，-V	可选	必须与--dump-elf配套使用，用于开启ELF文件中全量打印device信息功能。

解压ELF文件的命令

msobjdump --extract-elf <elf_file> [--out-dir <out_path>]

表2 参数说明
参数（区分大小写）	可选/必选	说明
--extract-elf <elf_file>，-e	必选	解压ELF文件中包含的device信息，并按原始文件夹规则落盘到输出路径下。 <elf_file>表示待解压ELF文件路径，如/home/op_api/lib_api.so。默认路径：解压结果文件默认落盘到当前执行路径下。自定义路径：可与--out-dir配套使用，设置落盘路径。
--out-dir <out_path>，-o	可选	必须与--extract-elf配套使用，用于设置解压文件的落盘路径。 <out_path>为落盘文件目录，如/home/extract/。说明： msobjdump支持多用户并发调用，但需要指定不同的--out-dir，否则可能出现落盘内容被覆盖的问题。

获取ELF文件列表的命令

msobjdump --list-elf <elf_file>

表3 参数说明
参数（区分大小写）	可选/必选	说明
--list-elf <elf_file>，-l	可选	获取ELF文件中包含的device信息文件列表，并打印显示。 <elf_file>表示待打印的ELF文件路径，如/home/op_api/lib_api.so。

表4 ELF解析字段说明（Kernel直调工程）
字段名	含义	是否必选	打印说明
VERSION	表示版本号。	是	不设置--verbose，默认打印。
TYPE COUNT	表示ELF文件中包含的kernel文件个数。
ELF FILE ${id}	表示ELF文件中包含的kernel文件名，${id}表示kernel文件序号。 kernel文件名的命名规则如下：按${sec_prefix}_${file_index}_${kernel_type}.o拼接，其中${sec_prefix}为section段名（工具根据“.ascend.kernel”关键字搜索获取），${file_index}表示文件编号，${kernel_type}表示kernel类型。
KERNEL LEN	表示kernel文件的长度。
KERNEL TYPE	表示kernel类型，映射关系为{0 : 'mix', 1: 'aiv', 2: 'aic'}。	否
ASCEND META	表示算子执行时核间同步、Cube/Vector核占比（task_ration）等信息。若没有获取到该信息，默认显示None。	否
elf heard infos	包括ELF Header、Section Headers、Key to Flags、Program Headers、Symbol表等信息。	否	设置--verbose，开启全量打印。

表5 ELF解析字段说明（简易自定义算子工程）
字段名	含义	是否必选	打印说明
.ascend.meta. ${id}	表示算子kernel函数名称，其中${id}表示meta信息的索引值。	是	不设置--verbose，默认打印。
KERNEL_TYPE	表示kernel函数运行时core类型，取值参见表表6。	否
CROSS_CORE_SYNC	表示硬同步syncall类型。 USE_SYNC：使用硬同步。 NO_USE_SYNC：不使用硬同步。
MIX_TASK_RATION	表示kernel函数运行时的Cube核/Vecor核占比分配类型。
elf heard infos	包括ELF Header、Section Headers、Key to Flags、Program Headers、Symbol表等信息。	否	设置--verbose，开启全量打印。

表6 kernel type信息
KERNEL_TYPE	说明
AICORE	该参数为预留参数，当前版本暂不支持。算子执行时仅会启动AI Core，比如用户在host侧设置blockdim为5，则会启动5个AI Core。
AIC	算子执行时仅启动AI Core上的Cube核：比如用户在host侧设置blockdim为10，则会启动10个Cube核。
AIV	算子执行时仅启动AI Core上的Vecor核：比如用户在host侧设置blockdim为10，则会启动10个Vecor核。
MIX_AIC_MAIN	AIC、AIV混合场景下，设置核函数的类型为MIX ，算子执行时会同时启动AI Core上的Cube核和Vector核，比如用户在host侧设置blockdim为10，且设置task_ration为1：2，则会启动10个Cube核和20个Vector核。
MIX_AIV_MAIN	AIC、AIV混合场景下，使用了多核控制相关指令时，设置核函数的类型为MIX，算子执行时会同时启动AI Core上的Cube核和Vector核，比如用户在host侧设置blockdim为10，且设置task_ration为1：2，则会启动10个Vector核和20个Cube核。
AIC_ROLLBACK	算子执行时会同时启动AI Core和Vector Core，此时AI Core会当成Cube Core使用。
AIV_ROLLBACK	算子执行时会同时启动AI Core和Vector Core，此时AI Core会当成Vector Core使用。

使用样例（Kernel直调算子工程）

以MatMulInvocationNeo算子为例（NPU模式），完整的工程可参考Matmul多核Kernel直调样例。假设${cmake_install_dir}为算子Cmake编译产物根目录，目录结构如下（仅为示例，具体以实际算子工程为准），类似CMake编译配置文件编写。

out
├── lib
│   ├── libascendc_kernels_npu.so
├── include
│   ├── ascendc_kernels_npu
│           ├── aclrtlaunch_matmul_custom.h
│           ├── aclrtlaunch_triple_chevrons_func.h
......

工具对编译生成的库文件（如*.so、*.a等）进行解析和解压，功能实现命令样例如下：

解析包含device信息的库文件

支持两种打印方式，请按需选取，解析字段含义参见表4。

简单打印

msobjdump --dump-elf ${cmake_install_dir}/out/libascendc_kernels_npu.so

执行上述命令，终端打印基础device信息，示例如下：

===========================
[VERSION]: 1
[TYPE COUNT]: 1
===========================
[ELF FILE 0]: ascendxxxb1_ascendc_kernels_npu_0_mix.o
[KERNEL TYPE]: mix
[KERNEL LEN]: 511560
[ASCEND META]: None

全量打印

msobjdump --dump-elf ${cmake_install_dir}/out/libascendc_kernels_npu.so --verbose

执行上述命令，终端打印所有device信息，示例如下：

===========================
[VERSION]: 1
[TYPE COUNT]: 1
===========================
[ELF FILE 0]: ascendxxxb1_ascendc_kernels_npu_0_mix.o
[KERNEL TYPE]: mix
[KERNEL LEN]: 511560
[ASCEND META]: None
====== [elf heard infos] ======
ELF Header:
  Magic:   7f 45 4c 46 02 01 01 00 00 00 00 00 00 00 00 00
  Class:                             ELF64
  Data:                              2's complement, little endian
  Version:                           1 (current)
  OS/ABI:                            UNIX - System V
  ABI Version:                       0
  Type:                              EXEC (Executable file)
  Machine:                           <unknown>: 0x1029
  Version:                           0x1
  Entry point address:               0x0
  Start of program headers:          64 (bytes into file)
  Start of section headers:          510280 (bytes into file)
  Flags:                             0x940000
  Size of this header:               64 (bytes)
  Size of program headers:           56 (bytes)
  Number of program headers:         2
  Size of section headers:           64 (bytes)
  Number of section headers:         20
  Section header string table index: 18

Section Headers:
  [Nr] Name              Type            Address          Off    Size   ES Flg Lk Inf Al
  [ 0]                   NULL            0000000000000000 000000 000000 00      0   0  0
  [ 1] .text             PROGBITS        0000000000000000 0000b0 010a08 00  AX  0   0  4
   .....................................................................................
  [19] .strtab           STRTAB          0000000000000000 071278 00b6cb 00      0   0  1
Key to Flags:
  W (write), A (alloc), X (execute), M (merge), S (strings), I (info),
  L (link order), O (extra OS processing required), G (group), T (TLS),
  C (compressed), x (unknown), o (OS specific), E (exclude),
  D (mbind), p (processor specific)

There are no section groups in this file.

Program Headers:
  Type           Offset   VirtAddr           PhysAddr           FileSiz  MemSiz   Flg Align
  LOAD           0x0000b0 0x0000000000000000 0x0000000000000000 0x010aa8 0x010aa8 R E 0x1000
  GNU_STACK      0x000000 0x0000000000000000 0x0000000000000000 0x000000 0x000000 RW  0
......

解压包含device信息的库文件并落盘
```
msobjdump --extract-elf ${cmake_install_dir}/out/libascendc_kernels_npu.so
```
执行上述命令，默认在当前执行路径下落盘ascendxxxb1_ascendc_kernels_npu_0_mix.o文件。

获取包含device信息的库文件列表

msobjdump --list-elf ${cmake_install_dir}/out/libascendc_kernels_npu.so

执行上述命令，终端会打印所有文件，屏显信息形如：

ELF file    0: ascendxxxb1_ascendc_kernels_npu_0_mix.o

使用样例（简易自定义算子工程）

以下面的算子工程为例（仅为示例，具体以实际算子工程为准），假设${cmake_install_dir}为算子Cmake编译产物根目录，目录结构如下，类似算子编译。

├── op_api
│   ├── include
│       ├── aclnn_acos_custom.h
│       ├── aclnn_matmul_leakyrelu_custom.h
│       ├── .........
│   ├── lib
│       ├── libcust_opapi.so

工具对编译生成的库文件（如*.so、*.a等）进行解析和解压，功能实现命令样例如下：

解析包含device信息的库文件

支持两种打印方式，请按需选取，解析字段含义参见表5。

简单打印

msobjdump --dump-elf ${cmake_install_dir}/op_api/lib/libcust_opapi.so

执行上述命令，终端打印基础device信息，示例如下：

.ascend.meta. [0]: AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26_1
KERNEL_TYPE: AIV
.ascend.meta. [0]: AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26_2_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
.ascend.meta. [0]: AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26_3_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
....................................
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_1
KERNEL_TYPE: AIV
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_2_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_3_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN

全量打印

msobjdump --dump-elf ${cmake_install_dir}/op_api/lib/libcust_opapi.so --verbose

执行上述命令，终端打印基础device信息，示例如下：

.ascend.meta. [0]: AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26_1
KERNEL_TYPE: AIV
.ascend.meta. [0]: AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26_2_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
.ascend.meta. [0]: AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26_3_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
....................................
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_1
KERNEL_TYPE: AIV
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_2_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_3_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
....................................
===== [elf heard infos] in ascendxxx_acos_custom_AcosCustom_da824ede53d7e754f85c14b9446ec2fc.o =====:
ELF Header:
  Magic:   7f 45 4c 46 02 01 01 00 00 00 00 00 00 00 00 00
  Class:                             ELF64
  Data:                              2's complement, little endian
  Version:                           1 (current)
  OS/ABI:                            UNIX - System V
  ................................................
  Size of program headers:           56 (bytes)
  Number of program headers:         3
  Size of section headers:           64 (bytes)
  Number of section headers:         9
  Section header string table index: 7
Section Headers:
  [Nr] Name              Type            Address          Off    Size   ES Flg Lk Inf Al
  [ 0]                   NULL            0000000000000000 000000 000000 00      0   0  0 
   .....................................................................................
  [ 8] .strtab           STRTAB          0000000000000000 00529b 000119 00      0   0  1
Key to Flags:
  W (write), A (alloc), X (execute), M (merge), S (strings), I (info),
  L (link order), O (extra OS processing required), G (group), T (TLS),
  C (compressed), x (unknown), o (OS specific), E (exclude),
  D (mbind), p (processor specific)
................................................

===== [elf heard infos] in ascendxxx_matmul_leakyrelu_custom_MatmulLeakyreluCustom_e052bee3255764ac919095f3bdf83389.o =====:
ELF Header:
  Magic:   7f 45 4c 46 02 01 01 00 00 00 00 00 00 00 00 00
  Class:                             ELF64
  Data:                              2's complement, little endian
  Version:                           1 (current)
  ................................................
  Section header string table index: 6
Section Headers:
  [Nr] Name              Type            Address          Off    Size   ES Flg Lk Inf Al
  [ 0]                   NULL            0000000000000000 000000 000000 00      0   0  0
  [ 1] .text             PROGBITS        0000000000000000 0000e8 007ed8 00  AX  0   0  4
  [ 2] .data             PROGBITS        0000000000008000 0080e8 000008 00  WA  0   0 256
  [ 3] .comment          PROGBITS        0000000000000000 0080f0 000043 01  MS  0   0  1
  [ 4] .bl_uninit        NOBITS          0000000000000000 008133 000020 00      0   0  1
  [ 5] .symtab           SYMTAB          0000000000000000 008138 0000c0 18      7   1  8
  [ 6] .shstrtab         STRTAB          0000000000000000 0081f8 00003b 00      0   0  1
  [ 7] .strtab           STRTAB          0000000000000000 008233 0000ec 00      0   0  1
  ................................................

解压包含device信息的库文件并落盘

msobjdump --extract-elf ${cmake_install_dir}/op_api/lib/libcust_opapi.so

执行上述命令，默认在当前执行路径下保存解压文件，产物目录如下：

|-- config                                                               // 算子原型配置文件目录
|    ├── ${soc_version}   
|        ├── acos_custom.json                                  
|        ├── matmul_leakyrelu_custom.json                               
|        ├── .......                                             
|-- ${soc_version}                                                    // 昇腾AI处理器名
|     ├── acos_custom                                               // 基础单算子编译文件*.o和对应的*.json文件
|         ├── AcosCustom_da824ede53d7e754f85c14b9446ec2fc.json      // 命名规则：${op_type}_${parm_info}.json或${op_type}_${parm_info}.o，${parm_info}是基于算子输入/输出dtype、shape等信息生成的标识码
|         ├── AcosCustom_da824ede53d7e754f85c14b9446ec2fc.o
|         ├── AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26.json
|         ├── AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26.o
|     ├── matmul_leakyrelu_custom  
|         ├── MatmulLeakyreluCustom_e052bee3255764ac919095f3bdf83389.json
|         ├── MatmulLeakyreluCustom_e052bee3255764ac919095f3bdf83389.o
|     ├── axpy_custom    
|         ├── .....

以acos_custom算子编译产物解压为例：

查看算子原型（acos_custom.json）

{
    "binList": [
        {
            "implMode": "high_performance",
            "int64Mode": false,
            "simplifiedKeyMode": 0,
            "simplifiedKey": [......],
            "staticKey": "96b2b4bb2e3xxx,ee37ce8796ef139dexxxx",
            "inputs": [
                {
                    "name": "x",
                    "index": 0,
                    "dtype": "float32",
                    "format": "ND",
                    "paramType": "required",
                    "shape": [
                        -2
                    ],
                    "format_match_mode": "FormatAgnostic"
                }
            ],
            "outputs": [
                {
                    "name": "y",
                    "index": 0,
                    "dtype": "float32",
                    "format": "ND",
                    "paramType": "required",
                    "shape": [
                        -2
                    ],
                    "format_match_mode": "FormatAgnostic"
                }
            ],
            "attrs": [
                {
                    "name": "tmp",
                    "dtype": "int",
                    "value": 0
                },
                .........
            ],
            "opMode": "dynamic",
            "optionalInputMode": "gen_placeholder",
            "deterministic": "ignore",
            "binInfo": {
                "jsonFilePath": "ascendxxx/acos_custom/AcosCustom_da824ede53d7e754f85c14b9446ec2fc.json"
            }
        },
        {
            "implMode": "high_performance",
            "int64Mode": false,
            "simplifiedKeyMode": 0,
            "simplifiedKey": [
  
            ],
            "staticKey": "27d6f997f2f3551axxxx,1385590c47affa578eb429xxx",
            "inputs": [
                {
                    "name": "x",
                    "index": 0,
                    "dtype": "float16",
                    "format": "ND",
                    "paramType": "required",
                    "shape": [
                        -2
                    ],
                    "format_match_mode": "FormatAgnostic"
                }
            ],
            "outputs": [
                {
                    "name": "y",
                    "index": 0,
                    "dtype": "float16",
                    "format": "ND",
                    "paramType": "required",
                    "shape": [
                        -2
                    ],
                    "format_match_mode": "FormatAgnostic"
                }
            ],
            "attrs": [
                {
                    "name": "tmp",
                    "dtype": "int",
                    "value": 0
                },
                .........
            ],
            "opMode": "dynamic",
            "optionalInputMode": "gen_placeholder",
            "deterministic": "ignore",
            "binInfo": {
                "jsonFilePath": "ascendxxx/acos_custom/AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26.json"
            }
        }
    ]
}

解析${op_type}_${parm_info}.o文件获取.ascend.meta段信息。

msobjdump --dump-elf ./AcosCustom_da824ede53d7e754f85c14b9446ec2fc.o

执行上述命令，终端屏显如下，字段与库文件解析类似，参见表5。

.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_1
KERNEL_TYPE: AIV
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_2_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]
.ascend.meta. [0]: AcosCustom_da824ede53d7e754f85c14b9446ec2fc_3_mix_aiv
KERNEL_TYPE: MIX_AIV_MAIN
MIX_TASK_RATION: [0:1]

查看${op_type}_${parm_info}.json，直观获取device文件中算子信息。

{
    "binFileName": "AcosCustom_da824ede53d7e754f85c14b9446ec2fc",
    "binFileSuffix": ".o",
    "blockDim": -1,
    "coreType": "MIX",
    "intercoreSync": 1,
    "kernelName": "AcosCustom_da824ede53d7e754f85c14b9446ec2fc",
    "magic": "RT_DEV_BINARY_MAGIC_ELF",
    "memoryStamping": [],
    "opParaSize": 24,
    "parameters": [],
    "sha256": "94e32d04fcaf435411xxxxxxxx",
    "workspace": {
        "num": 1,
        "size": [
            -1
        ],
        "type": [
            0
        ]
    },
    "kernelList": [
        {
            "tilingKey": 1,
            "kernelType": "MIX_AIC",
            "taskRation": "0:1",
            "crossCoreSync": 0,
            "kernelName": "AcosCustom_da824ede53d7e754f85c14b9446ec2fc_1"
        },
        .........
    ],
    "taskRation": "tilingKey",
    "optionalInputMode": "gen_placeholder",
    "debugOptions": "printf",
    "debugBufSize": 78643200,
    "compileInfo": {},
    "supportInfo": {                                                        // 算子原型信息
        "implMode": "high_performance",
        "int64Mode": false,
        "simplifiedKeyMode": 0,
        "simplifiedKey": [......],
        "staticKey": "96b2b4bb2e35fa3dxxx,ee37ce8796ef139dedxxxxxxxx",
        "inputs": [
            {
                "name": "x",
                "index": 0,
                "dtype": "float32",
                "format": "ND",
                "paramType": "required",
                "shape": [
                    -2
                ],
                "format_match_mode": "FormatAgnostic"
            }
        ],
        "outputs": [
            {
                "name": "y",
                "index": 0,
                "dtype": "float32",
                "format": "ND",
                "paramType": "required",
                "shape": [
                    -2
                ],
                "format_match_mode": "FormatAgnostic"
            }
        ],
        "attrs": [
            {
                "name": "tmp",
                "dtype": "int",
                "value": 0
            },
            .........
        ],
        "opMode": "dynamic",
        "optionalInputMode": "gen_placeholder",
        "deterministic": "ignore"
    },
    "filePath": "ascendxxx/acos_custom/AcosCustom_da824ede53d7e754f85c14b9446ec2fc.json"
}

获取包含device信息的库文件列表

msobjdump --list-elf ${cmake_install_dir}/op_api/lib/libcust_opapi.so

执行上述命令，终端会打印所有文件，屏显信息形如：

ELF file    0: ascendxxx_acos_custom_AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26.json
ELF file    1: ascendxxx_acos_custom_AcosCustom_dad9c8ca8fcbfd789010c8b1c0da8e26.o
....................
ELF file    2: ascendxxx_acos_custom_AcosCustom_da824ede53d7e754f85c14b9446ec2fc.json
ELF file    3: ascendxxx_acos_custom_AcosCustom_da824ede53d7e754f85c14b9446ec2fc.o

msobjdump工具

产品支持情况

工具安装

命令格式

使用样例（Kernel直调算子工程）

使用样例（简易自定义算子工程）