cuBridge 尝试成为GPU程序员使用一种编程语言进行开发、并且可运行在多种GPU硬件平台的解决方案

### 使用指南 #### 系统需求 建议在安装了以下软件的系统环境中安装**cuBridge**，然后再开始实验和使用 ： | 软件安装 | 安装指南 | | ----- | ------------------------------------------------------------ | | CUDA工具包| 详见[NVIDIA CUDA Installation Guide for Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html) | | MXMACA工具包| 详见[MXMACA快速上手指南](https://www.metax-tech.com/platform.html?cid=4) | #### 安装**cuBridge** 以下是**cuBridge**安装指南，有问题或建议请私信[p4ul](https://gitee.com/p4ul)。 ##### Step 1：确定**cuBridge**安装位置 **cuBridge**对安装位置没有限制，可以是编译机器的任意目录。 在step2中，将`CMAKE_INSTALL_PREFIX`的路径设置为cuBridge的安装位置。 推荐安装到MACA_PATH环境变量所在位置的tools子目录，例如cuBridge解压到/opt/maca/tools/目录下。 ##### Step 2：安装**cuBridge** 安装前，根据[MXMACA快速上手指南](https://www.metax-tech.com/platform.html?cid=4) 先设置MACA_PATH环境变量 ###### 方法1：直接使用git clone安装 ```shell git clone https://gitee.com/p4ul/cu-bridge.git sudo chmod 755 cu-bridge -Rf #set env MACA_PATH cd cu-bridge mkdir build && cd ./build cmake -DCMAKE_INSTALL_PREFIX=/opt/maca/tools/ ../ make && make install ``` ###### 方法2：下载后解压安装 ```shell wget https://gitee.com/p4ul/cu-bridge/repository/archive/2.0.1.zip unzip cu-bridge-2.0.1.zip mv cu-bridge-2.0.1 cu-bridge sudo chmod 755 cu-bridge -Rf cd cu-bridge mkdir build && cd ./build cmake -DCMAKE_INSTALL_PREFIX=/opt/maca/tools/ ../ make && make install ``` ##### Step 3：配置**cuBridge**编译环境 ```shell export CUCC_PATH=/path/to/where/installed/cu-brdige export PATH=$PATH:${CUCC_PATH}/tools:${CUCC_PATH}/bin ``` #### 使用**cuBridge** 以下是**cuBridge**使用指南，有问题或建议请私信[p4ul](https://gitee.com/p4ul)。 ##### Step 1：用CUDA语言编译一个GPU程序 用户可以自己用CUDA语言编写一个GPU程序。 为方便起见，**cuBridge**使用指南以[cuda-samples](https://github.com/NVIDIA/cuda-samples)里的一个[vectorAdd](https://github.com/NVIDIA/cuda-samples/tree/master/Samples/0_Introduction/vectorAdd)程序为例。 1. 将CUDA_PATH环境变量设置为CUDA工具包安装位置 ```shell export CUDA_PATH=/path/to/where/installed/cuda ``` 2. 将当前目录更改为vectorAdd源代码项目目录，ls查看该目录下文件，然后运行make： ```shell cd vectorAdd ls make ``` 3. 再次ls查看该目录下是否新增了vectorAdd可执行程序文件，如果make成功，可以在安装了英伟达GPU的机器上启动该vectorAdd程序： ```shell ls ./vectorAdd ``` ##### Step 2: 编译和生成MXMACA程序 ###### Step 2.1: 确认MXMACA编程环境工作正常 参考[MXMACA快速上手指南](https://www.metax-tech.com/platform.html?cid=4)安装MXMACA编程环境后，执行以下步骤检查结果。 1. 检查MXMACA编译器是否正确安装： ```shell which mxcc ``` 正确安装的结果可能是： ```shell /opt/maca/bin/mxcc ``` 2. 检查MXMACA运行环境是否正常： ```shell macainfo ``` 如果macainfo不能正常执行，可能是MXMACA编程环境尚未正确配置，需要正确配置相关的环境变量，例如 ```shell export MACA_PATH=/opt/maca export PATH=$PATH:${MACA_PATH}/mxgpu_llvm/bin: ${MACA_PATH}/bin export LD_LIBRARY_PATH=${MACA_PATH}/lib:${LD_LIBRARY_PATH} ``` 然后再重新启动macainfo，看看是否能正常执行。 ###### Step 2.2: 将CUDA_PATH环境变量设置为**CUDA Toolkit**安装位置 ```shell export CUDA_PATH=/path/to/where/installed/cuda export PATH=$PATH:${CUDA_PATH}/bin ``` ###### Step 2.3: 将CUCC_PATH环境变量设置为**cuBridge**安装位置 ```shell export CUCC_PATH=/path/to/where/installed/cu-brdige export PATH=$PATH:${CUCC_PATH}/tools:${CUCC_PATH}/bin ``` ###### Step 2.4: 使用**cuBridge**编译CUDA源代码项目 **方法1：CUDA源代码项目使用CMake构建** [cuda-samples](https://github.com/NVIDIA/cuda-samples)里的[vectorAdd](https://github.com/NVIDIA/cuda-samples/tree/master/Samples/0_Introduction/vectorAdd)源代码项目是使用Makefile构建的，下载后可以直接使用以下方式生成MXMACA程序。 1. 将当前目录更改为vectorAdd源代码项目目录，ls查看该目录下文件，然后运行 make_maca： ```shell cd vectorAdd ls make_maca ``` 2. 再次ls查看该目录下是否新增了vectorAdd可执行程序文件，如果make成功，可以在安装了沐曦GPU的机器上启动该vectorAdd程序： ```shell ls ./vectorAdd ``` **方法2：CUDA源代码项目使用CMake构建** [cuda-samples](https://github.com/NVIDIA/cuda-samples)里的[vectorAdd](https://github.com/NVIDIA/cuda-samples/tree/master/Samples/0_Introduction/vectorAdd)源代码项目是使用Makefile构建的。 下载后我们可以先改造成CMake构建，再进行实验和测试。 1. 创建CMakeLists.txt，用于构建和生成Makefile ```shell cmake_minimum_required(VERSION 3.17) set(CMAKE_VERBOSE_MAKEFILE on) #set(CMAKE_CXX_SYSROOT_FLAG_CODE "list(APPEND CMAKE_CXX_SOURCE_FILE_EXTENSIONS cu)") set_source_files_properties(vectorAdd.cu PROPERTIES LANGUAGE CXX) project(vectorAdd CXX) set(CMAKE_CXX_COMPILER "$ENV{CUDA_PATH}/bin/nvcc") set(CMAKE_C_COMPILER "$ENV{CUDA_PATH}/bin/nvcc") #include_directories(../../common/inc) add_executable(vectorAdd vectorAdd.cu) ``` 2. 前面Step2.2已经将CUDA_PATH环境变量设置为**CUDA Toolkit**安装位置，将当前目录更改为vectorAdd源代码项目目录，通过cmake_maca生成Makefile ```shell cd vectorAdd mkdir build cd build cmake_maca .. ``` 使用cmake_maca命令需要编译机器上正确**安装CUDA工具包**( 安装方法详见[NVIDIA CUDA Installation Guide for Linux](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/index.html)) 如果编译机器上没有安装CUDA工具包，也可以尝试用cmake命令替代上面的cmake_maca命令 3. ls查看vectorAdd目录下文件，然后运行make_maca： ```shell make_maca ``` 4. 再次ls查看该目录下是否新增了vectorAdd可执行程序文件，如果make成功，可以在安装了沐曦GPU的机器上启动该vectorAdd程序： ```shell ls ./vectorAdd ``` **方法3：使用cucc直接编译CUDA源代码** 1. **cuBridge**提供的cucc命令也可以用于直接编译CUDA源代码，例如： ```shell cd vectorAdd cucc -x maca vectorAdd.cu -o vectorAdd ``` 2. ls查看该目录下是否新增了vectorAdd可执行程序文件，如果make成功，可以在安装了沐曦GPU的机器上启动该vectorAdd程序： ```shell ls ./vectorAdd ``` ### 更多内容 根据项目进展情况，使用指南会不定期进行更新和维护，请持续关注