CANN/shmem编译构建指南

编译与构建【免费下载链接】shmemCANN SHMEM 是面向昇腾平台的多机多卡内存通信库基于OpenSHMEM 标准协议实现跨设备的高效内存访问与数据同步。项目地址: https://gitcode.com/cann/shmemSHMEM编译下载SHMEM源码git clone https://gitcode.com/cann/shmem.git您可自行选择需要的分支。编译进入shmem的根目录编译cd shmem bash scripts/build.sh更多命令介绍可查看shmem仓主目录下的README.md和scripts/build.sh文件。SHMEM编译相关说明SHMEM的基本编译命令是bash build.sh默认构建模式下生成版本信息并创建安装包(默认情况下不会编译RDMA能力、用例、测试、python接口)。后可跟参数实现不同功能-use_cxx11_abi1启用C11 ABI默认-use_cxx11_abi0禁用C11 ABI-cannCANN 8.5以上版本可以使用CANN开放接口编译-uttests构建tests/unittest目录下所有ut用例-examples构建examples目录下所有用例-python_example对部分examples目录下用例提供torch接入能力-enable_rdma构建并启用RDMA相关能力。 Ascend910B/C 默认配置 RDMA 后端类型Ascend950 需要配合-rdma_backend来指定后端类型。-rdma_backend指定RDMA后端类型Ascend910B/C 不支持该选项可选值为XSCALE使用云脉网卡。必须配合-enable_rdma使用否则会报错。参数顺序不限。-enable_ascendc_dump启用AscendC_Dump模式用于对算子内核代码进行调测-package构建py扩展的whl包生成run包SHMEM_{version}_linux-{arch}.run生成路径为{project_root}/package/{arch}/生成python whl包shmem-xxx.whl生成路径为{project_root}/package/{arch}/-python_extension生成python whl包shmem-xxx.whl生成路径为{project_root}/dist/-gendoc生成文档-onlygendoc: 生成文档不构建源码-debug设置构建类型为Debug模式-mssanitizerexample启用mssanitizer内存检测工具脚本执行需用mssanitizer拉起任务才能实际生效allgather样例运行脚本提供了tool选项使用工具。工具使用方法参见异常检测工具msSanitizerMindStudio Sanitizer 注如果开启该选项请确保使用mssanitizer工具拉起算子如使用其他方式拉起算子可能导致未知错误-soc_type如果SOC是Ascend950类别需要增加-soc_type Ascend950参数可以通过npu-smi info命令查看其他SOC可不加该参数。-enable_simt使能simt编程模式接口。-full编译 package python_extension uttests examples。SHMEM自动编译脚本会自动完成依赖库的下载工程编译UT用例编译库打包。RDMA参数使用说明若需要使用 RDMA 功能需要在编译时开启-enable_rdma参数。之后用户需要根据服务器类型与使用的网卡种类进行参数配置来配置后端Ascend910B/C 平台仅需要使用-enable_rdma参数不需要额外参数后端使用默认配置Ascend950 平台使用-enable_rdma参数显式指定-soc_type Ascend950指定-rdma_backend参数否则构建脚本将会报错参数依赖规则-rdma_backend参数在使用时必须同时指定-enable_rdma参数-rdma_backend参数仅在-soc_type Ascend950时有效否则构建脚本将会报错如果指定了-rdma_backend但未指定-enable_rdma构建将失败并提示错误信息-rdma_backend,-enable_rdma,-soc_type xxx三个参数顺序不限但所有依赖参数必须最终都被指定有效命令示例# Ascend950 平台启用RDMA并指定后端为 XSCALE参数顺序示例1 bash scripts/build.sh -soc_type Ascend950 -enable_rdma -rdma_backend XSCALE # Ascend950 平台启用RDMA并指定后端为 XSCALE参数顺序示例2 bash scripts/build.sh -enable_rdma -soc_type Ascend950 -rdma_backend XSCALE # Ascend950 平台启用RDMA并指定后端为 XSCALE参数顺序示例3 bash scripts/build.sh -rdma_backend XSCALE -enable_rdma -soc_type Ascend950 # Ascend910B/C 启用RDMA不需要指定backend bash scripts/build.sh -enable_rdma无效命令示例# 错误指定了-rdma_backend但未启用-enable_rdma bash scripts/build.sh -soc_type Ascend950 -rdma_backend XSCALE # 将报错Error: -rdma_backend requires -enable_rdma to be specified. # 错误在非Ascend950平台使用-rdma_backend bash scripts/build.sh -enable_rdma -rdma_backend XSCALE # 将报错Error: -rdma_backend can only be specified when SOC_TYPE is Ascend950.RDMA 后端类型说明-rdma_backend参数支持以下后端类型XSCALE云脉网卡后端仅 Ascend950 支持⚠️ 重要提示自动生成的编译定义CMake 会根据-rdma_backend的值自动生成以下编译定义用户不应手动设置当-rdma_backend XSCALE时自动添加-DACLSHMEMI_RDMA_K_BACKEND_XSCALE1未指定后端时自动添加-DACLSHMEMI_RDMA_K_BACKEND_IN_DIE1手动定义这些宏可能导致编译冲突或功能异常禁止手动定义的内部宏用户不应手动添加名为ACLSHMEMI_K_RDMA_BACKEND的编译定义这是一个设备端代码使用的内部宏由系统在src/device/gm2gm/engine/shmem_device_rdma.hpp中根据上述自动生成的定义进行设置手动定义此宏会导致编译错误或运行时功能异常SHMEM关键文件介绍scripts目录install.sh: 安装脚本uninstall.sh: 卸载脚本build.sh: 编译脚本release.sh全自动构建与打包脚本set_env.shSHMEM的环境变量设置文件run.sh脚本使用UT测试用例运行脚本。bash scripts/run.sh提供多种参数支持自定义用例执行-ranks # 总rank数 -frank # 该服务器第一个rank -ipport # ip端口 -fnpu # 每个服务器起的第一个npu -gnpus # 单机使用的卡数 -test_filter # gtest_filter # 例如 bash run.sh -ranks 4 -fnpu 2 -gnpus 4 -test_filter ScalarP # 会在2-6卡install.sh打包生成的run包安装卸载依赖的脚本提供安装卸载功能。 安装目录${INSTALL_PATH} |--shmem |--latest |--${version} |--shmem |--include (头文件) |--lib (so库) |--scripts (卸载脚本)uninstall.sh卸载脚本可以卸载对应路径安装的shmem库或通过run包的--uninstall卸载默认路径下的shmem。release.sh出包脚本编译后使用。对编译产物打包后会删除install目录下其他文件。推荐使用build.sh完成打包。编译文件build.sh文件名scripts/build.shSHMEM编译文件一般无需更改。环境变量设置文件set_env.sh​文件名​scripts/set_env.shSHMEM安装完成后提供进程级环境变量设置脚本set_env.sh以自动完成环境变量设置用户进程结束后自动失效。【免费下载链接】shmemCANN SHMEM 是面向昇腾平台的多机多卡内存通信库基于OpenSHMEM 标准协议实现跨设备的高效内存访问与数据同步。项目地址: https://gitcode.com/cann/shmem创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考