跳转至

msProf工具安装指南

本文档主要介绍msProf工具的安装方式：使用CANN包安装、使用msProf run包安装以及源码编译安装。

msProf工具完整功能集成在CANN包中，且msProf依赖CANN包，因此使用msProf工具需要先安装CANN包，若需要升级安装本工具代码仓中的最新功能，可以使用msProf run包安装或源码编译安装，在已安装CANN包的环境下覆盖安装msProf包。

使用CANN包安装

msProf工具完整功能已集成在CANN包中发布，可通过以下方式完成安装：

  • 方式一：依据CANN官方文档安装

请参见《CANN安装官方文档》，按文档逐步完成安装与配置。

  • 方式二：使用CANN官方容器镜像

请访问《CANN官方镜像仓库》，按仓库中的指引完成镜像拉取及容器启动。

（可选）使用msProf run包安装

使用msProf run包安装需要单独获取msProf发布包，可访问msProf Release页面，进入目标版本后下载与当前系统架构匹配的mindstudio-profiler_<version>_<arch>.run安装包。若发布页同时提供SHA256校验信息，建议一并获取，用于安装前的完整性校验。

[!note] 说明

下载的msProf run包需要在已安装CANN的环境中进行覆盖安装才能使用。

  1. 下载msProf run包完成后，执行以下命令为run包添加可执行权限。
chmod +x mindstudio-profiler_<version>_<arch>.run
  1. 校验安装包完整性。
# 若发布页提供SHA256校验文件，可直接执行校验
sha256sum -c <sha256_file>

# 若发布页提供SHA256摘要值，可执行如下命令并与发布页摘要值比对
sha256sum mindstudio-profiler_<version>_<arch>.run

# run包也支持通过--check执行完整性校验
./mindstudio-profiler_<version>_<arch>.run --check

打印如下信息，则说明软件包完整性校验成功。

Verifying archive integrity...  100%   SHA256 checksums are OK. All good.
  1. 校验通过后，执行以下命令完成安装。
./mindstudio-profiler_<version>_<arch>.run --install
  1. 如需指定安装路径，可附加 --install-path=<cann_path> 参数。安装路径须指向cann目录，具体请参见安装run包参数说明。

（可选）源码编译安装

如需使用最新代码的功能，可下载本仓库代码，自行编译、打包并完成安装。

[!note] 说明

编译出的msProf run包需要在已安装CANN的环境中进行覆盖安装才能使用。

编译环境准备

  1. 安装依赖。

msProf工具源码编译依赖SQLite3，请执行以下命令完成安装，或确保当前环境已满足该依赖。

  • Ubuntu系统上安装SQLite3：

     sudo apt update
 sudo apt install sqlite3 libsqlite3-dev

  • openEuler/CentOS系统上安装SQLite3：

    sudo yum install sqlite sqlite-devel

  • 克隆本仓库。

git clone https://gitcode.com/Ascend/msprof.git
  1. 下载第三方依赖。
cd msprof
# 下载三方依赖包
bash scripts/download_thirdparty.sh

执行编译打包

build/build.sh编译脚本支持通过--mode参数指定编译类型：

  • all：编译全量run包（包含采集与解析功能）
  • analysis：编译解析run包（仅包含解析功能）

更多参数说明请参见编译run包参数说明。

编译完成后，会在当前路径output目录下生成run包，名称格式为mindstudio-profiler_<version>_<arch>.run。其中，version为版本号，arch为系统架构（根据实际运行系统自动适配）。

方式一：编译msProf全量run包（推荐）

# 编译全量run包，包含msProf的采集和解析功能
bash build/build.sh --mode=all --version=<version>

方式二：编译msProf解析run包

# 单独编译解析包
bash build/build.sh --mode=analysis --version=<version>

安装run包

  1. run包将生成在output目录下，执行以下命令为其添加可执行权限：
cd output
chmod +x mindstudio-profiler_<version>_<arch>.run
  1. 执行安装命令。
./mindstudio-profiler_<version>_<arch>.run --install

安装命令支持--install-path等参数，具体请参见安装run包参数说明。

执行安装命令时，会自动执行--check参数，校验软件包的一致性和完整性，出现如下回显信息，表示软件包校验成功。

Verifying archive integrity...  100%   SHA256 checksums are OK. All good.

安装完成后，若显示如下信息，则说明软件安装成功。

mindstudio-profiler package install success.

附录

编译run包参数说明

msProf工具run包的编译命令可配置如下参数。

参数 可选/必选 说明
--build_type 可选 编包类型，可取值：
• Release：编译出用于生产环境部署的软件包。
• Debug：编译出用于开发调试的软件包（只支持编译解析部分的Debug软件包）。
默认值为Release。
--mode 可选 编包方式。可取值：
• all：编译出包含msProf采集和解析功能的软件包。
• analysis：编译出仅包含msProf解析功能的软件包。
默认值为analysis。
--version 可选 配置run包的版本号。
默认值为none。

安装run包参数说明

msProf工具run包的安装命令可配置如下参数。

参数 可选/必选 说明
--install 可选 安装软件包。可配置--install-path参数指定软件的安装路径；不配置--install-path参数时，则直接安装到默认路径下。
--uninstall 可选 卸载软件包。可配置--install-path参数指定软件安装时的路径；不配置--install-path参数时，则直接卸载默认路径下的msProf。
--install-path 可选 安装路径。路径须指定到cann目录，如果用户未指定安装路径，则软件会安装到默认路径下，默认安装路径如下：
• root用户：/usr/local/Ascend/cann
• 非root用户：${HOME}/Ascend/cann，${HOME}为当前用户的家目录。
--install-for-all 可选 安装时，允许其他用户具有安装用户组的权限。当安装携带该参数时，支持其他用户使用msProf运行业务，但该参数存在安全风险，请谨慎使用。
--help 可选 查看帮助信息。