快速入门
前提条件
-
安装依赖
以下所列仅为本开源仓源码编译用到的依赖，其中python、gcc、cmake的安装方法请参见配套版本的用户手册，选择安装场景后，参见“安装CANN > 安装依赖”章节进行相关依赖的安装。
-
python >= 3.7.0
-
gcc >= 7.3.0
-
cmake >= 3.16.0
-
ccache >= 4.6.1
建议版本release-v4.6.1，x86_64环境下载链接，aarch64环境下载链接。
x86_64环境安装步骤如下：
# 在准备安装的路径下创建buildtools目录，如有则忽略 # 这里以安装路径/opt为例，对安装命令进行说明 mkdir /opt/buildtools # 切换到安装包下载路径，将ccache解压到安装路径 tar -xf ccache-4.6.1-linux-x86_64.tar.xz -C /opt/buildtools chmod 755 /opt/buildtools/ccache-4.6.1-linux-x86_64/ccache mkdir -p /usr/local/ccache/bin # 建立软链接 ln -sf /opt/buildtools/ccache-4.6.1-linux-x86_64/ccache /usr/local/bin/ccache ln -sf /opt/buildtools/ccache-4.6.1-linux-x86_64/ccache /usr/local/ccache/bin/ccache # 将ccache添加到环境变量PATH export PATH=/usr/local/ccache/bin:$PATHaarch64环境安装步骤如下：
-
编译安装
# 在准备安装的路径下创建buildtools目录，如有则忽略 # 这里以安装路径/opt为例，对安装命令进行说明 mkdir /opt/buildtools # 切换到安装包下载路径，将zstd解压到安装路径 tar -xf zstd-1.5.0.tar.gz -C /opt/buildtools cd /opt/buildtools/zstd-1.5.0 make -j 24 make install cd - # 切换到安装包下载路径，将hiredis解压到安装路径 tar -xf hiredis-1.0.2.tar.gz -C /opt/buildtools cd /opt/buildtools/hiredis-1.0.2 make -j 24 prefix=/opt/buildtools/hiredis-1.0.2 all make prefix=/opt/buildtools/hiredis-1.0.2 install cd - # 切换到安装包下载路径，将ccache解压到安装路径 tar -xf ccache-4.6.1.tar.gz -C /opt/buildtools cd /opt/buildtools/ccache-4.6.1 mkdir build cd build/ cmake -DCMAKE_BUILD_TYPE=Release -DZSTD_LIBRARY=/usr/local/lib/libzstd.a -DZSTD_INCLUDE_DIR=/usr/local/include -DHIREDIS_LIBRARY=/usr/local/lib/libhiredis.a -DHIREDIS_INCLUDE_DIR=/usr/local/include .. make -j 24 make install mkdir -p /usr/local/ccache/bin # 建立软链接 ln -sf /usr/local/bin/ccache /usr/local/ccache/bin/ccache # 将ccache添加到环境变量PATH export PATH=/usr/local/ccache/bin:$PATH
-
lcov >= 1.13（可选，仅执行UT时依赖）
以Ubuntu系统为例，x86_64环境执行以下命令安装：
apt install lcov以Euler系统为例，aarch64环境执行以下命令安装：
yum install lcov -
pytest >= 8.3.2（可选，仅执行UT时依赖）
执行以下命令安装：
pip3 install pytest -
coverage >= 4.5.4（可选，仅执行UT时依赖）
执行以下命令安装：
pip3 install coverage -
googletest（可选，仅执行UT时依赖，建议版本release-1.11.0）
下载googletest源码后，执行以下命令安装：
mkdir temp && cd temp # 在googletest源码根目录下创建临时目录并进入 cmake .. -DCMAKE_CXX_FLAGS="-fPIC -D_GLIBCXX_USE_CXX11_ABI=0" make make install # root用户安装googletest # sudo make install # 非root用户安装googletest
-
-
安装驱动与固件（运行态依赖）
运行算子时必须安装驱动与固件，若仅编译算子，可跳过本操作，安装指导详见《CANN 软件安装指南》。
环境准备
本项目支持由源码编译，进行源码编译前，请根据如下步骤完成相关环境准备。
-
安装社区尝鲜版CANN toolkit包
根据实际环境，下载对应
Ascend-cann-toolkit_${cann_version}_linux-${arch}.run包，下载链接为toolkit x86_64包、toolkit aarch64包。# 确保安装包具有可执行权限 chmod +x Ascend-cann-toolkit_${cann_version}_linux-${arch}.run # 安装命令 ./Ascend-cann-toolkit_${cann_version}_linux-${arch}.run --full --force --install-path=${install_path}- ${cann_version}：表示CANN包版本号。
- ${arch}：表示CPU架构，如aarch64、x86_64。
- ${install_path}：表示指定安装路径。
- 缺省--install-path时， 则使用默认路径安装。 若使用root用户安装，安装完成后相关软件存储在“/usr/local/Ascend”路径下；若使用非root用户安装，安装完成后相关软件存储在“$HOME/Ascend”路径下。
-
安装社区版CANN ops包（运行态依赖）
运行算子前必须安装本包，若仅编译算子，可跳过本操作。
根据产品型号和环境架构，下载对应
Ascend-cann-${soc_name}-ops_9.0.0_linux-${arch}.run包，下载链接如下：- Atlas A2 训练系列产品/Atlas A2 推理系列产品：ops x86_64包、ops aarch64包。
- Atlas A3 训练系列产品/Atlas A3 推理系列产品：ops x86_64包、ops aarch64包。
- Ascend 950PR/Ascend 950DT：ops x86_64包、ops aarch64包。
# 确保安装包具有可执行权限 chmod +x Ascend-cann-${soc_name}-ops_9.0.0_linux-${arch}.run # 安装命令 ./Ascend-cann-${soc_name}-ops_9.0.0_linux-${arch}.run --install --install-path=${install_path}- ${soc_name}：表示NPU型号名称。
- ${arch}：表示CPU架构，如aarch64、x86_64。
- ${install_path}：表示指定安装路径，需要与toolkit包安装在相同路径，root用户默认安装在
/usr/local/Ascend目录，非root用户默认安装在$HOME/Ascend目录。
-
配置环境变量
-
默认路径，root用户安装
source /usr/local/Ascend/cann/set_env.sh -
默认路径，非root用户安装
source $HOME/Ascend/cann/set_env.sh -
指定路径安装
source ${install_path}/cann/set_env.sh
-
下载源码
可以使用以下两种方式下载，请选择其中一种进行源码准备。
-
命令行方式下载（下载时间较长，但步骤简单）。
# 开发环境，非root用户命令行中执行以下命令下载源码仓。git_clone_path为用户自己创建的某个目录。 cd ${git_clone_path} git clone https://gitcode.com/cann/asc-tools.git注：如果需要切换到其它tag版本，以v0.5.0为例，可执行以下命令。
git checkout v0.5.0 -
若您的编译环境无法访问网络，可以通过压缩包方式下载（下载时间较短，但步骤稍微复杂）。
注：如果需要下载其它版本代码，请先请根据前置条件说明进行asc-tools仓分支切换。下载压缩包命名跟tag/branch相关，此处以master分支为例，下载的名字将会是asc-tools-master.zip
# 1. asc-tools仓右上角选择 【下载ZIP】。 # 2. 将ZIP包上传到开发环境中的普通用户某个目录中，【例如：${git_clone_path}/asc-tools-master.zip】。 # 3. 开发环境中，执行以下命令，解压zip包。 cd ${git_clone_path} unzip asc-tools-master.zip并且，需要同样操作下载依赖的msot、mssanitizer、msopprof、msopgen、mskpp、mskl、msdebug代码仓的master分支的压缩包，即点击各仓链接，右上角选择【下载ZIP】。
同时，需要根据实际环境，下载对应Release版本的闭源cpudebug包（cpudebug x86_64包、cpudebug aarch64包），以及开源第三方软件依赖，列表如下：
开源软件 版本 下载地址 makeself 2.5.0 makeself-2.5.0.tar.gz boost 1.87.0 boost-1_87_0.tar.gz googletest 1.14.0 googletest-1.14.0.tar.gz mockcpp 2.7 mockcpp-2.7.tar.gz mockcpp_patch 2.7 mockcpp-2.7.patch 其中，对于依赖的开源第三方软件，提供一键式下载脚本
install_dep_tar.py，用户可以通过执行如下命令，下载所有开源第三方软件依赖。python3 install_dep_tar.py --dest_dir=${your_3rd_party_path} # 其中，${your_3rd_party_path}为下载开源第三方软件的存放路径
编译安装
- 编译
本开源仓提供一键式编译安装能力，进入本开源仓代码根目录，执行如下命令：
cd asc-tools
bash build.sh --pkg
若您的编译环境无法访问网络，您需要在联网环境中下载上述依赖代码仓的压缩包、闭源压缩包及开源软件压缩包，并手动上传至您的编译环境中。
您需要在编译环境中新建一个{your_3rd_party_path}目录来存放依赖代码仓、闭源及第三方开源软件的压缩包。
mkdir -p {your_3rd_party_path}
创建好目录后，将下载好的所依赖的压缩包上传至目录{your_3rd_party_path}后，可以使用如下命令进行编译：
bash build.sh --pkg --cann_3rd_lib_path={your_3rd_party_path}
编译完成后会在build_out目录下生成cann-asc-tools_<cann_version>_linux-.run软件包。
- 安装
在开源仓根目录下执行下列命令，根据设置的环境变量路径，将编译生成的run包安装到CANN包的装包路径，同时会覆盖原CANN包中的Ascend C内容。
# 切换到run包生成路径下
cd build_out
# 默认路径安装run包
./cann-asc-tools_<cann_version>_linux-<arch>.run --full
# 指定路径安装run包
./cann-asc-tools_<cann_version>_linux-<arch>.run --full --install-path=${install_path}
UT测试（可选）
在开源仓根目录执行下列命令之一，将依次批跑tests目录下的用例，得到结果日志，用于看护编译是否正常。
bash build.sh -t
或
bash build.sh --test
若您的环境无法访问网络，您需要在联网环境中下载上述依赖代码仓的压缩包及开源软件压缩包，并手动上传至您的环境中。 同时，相比编译，UT不下载Release版本的cpudebug包，而是需要根据实际环境，下载对应Debug版本的闭源cpudebug包（cpudebug x86_64包、cpudebug aarch64包），Debug版本相比Release版本，方便进行调试。
您需要在环境中新建一个{your_3rd_party_path}目录来存放依赖代码仓、闭源及第三方开源软件的压缩包。
mkdir -p {your_3rd_party_path}
创建好目录后，将下载好的所依赖的压缩包上传至目录{your_3rd_party_path}后，可以使用如下命令进行UT测试：
bash build.sh --test --cann_3rd_lib_path={your_3rd_party_path}
UT测试显示覆盖率
-
依赖项
- lcov >= 1.14
-
执行命令
bash build.sh --test --cov