Install AMD ROCm¶

Deploying ROCm¶ AMD hosts both Debian and RPM repositories for the ROCm v3.x packages. The following directions show how to install ROCm on supported Debian-based systems such as Ubuntu 18.04.x Note: These directions may not work as written on unsupported Debian-based distributions. For example, newer versions of Ubuntu may not be compatible with the rock-dkms kernel driver. In this case, you can exclude the rocm-dkms and rock-dkms packages.

Prerequisites¶ In this release, AMD ROCm extends support to Ubuntu 20.04, including dual kernel. The AMD ROCm platform is designed to support the following operating systems: Ubuntu 20.04 (5.4 and 5.6-oem) and 18.04.5 (Kernel 5.3)

CentOS 7.8 & RHEL 7.8 (Kernel 3.10.0-1127) (Using devtoolset-7 runtime support)

CentOS 8.2 & RHEL 8.2 (Kernel 4.18.0 ) (devtoolset is not required)

SLES 15 SP1 FRESH INSTALLATION OF AMD ROCm V3.8 RECOMMENDED A fresh and clean installation of AMD ROCm v3.8 is recommended. An upgrade from previous releases to AMD ROCm v3.8 is not supported. Note: AMD ROCm release v3.3 or prior releases are not fully compatible with AMD ROCm v3.5 and higher versions. You must perform a fresh ROCm installation if you want to upgrade from AMD ROCm v3.3 or older to 3.5 or higher versions and vice-versa. Note: render group is required only for Ubuntu v20.04. For all other ROCm supported operating systems, continue to use video group. For ROCm v3.5 and releases thereafter, the clinfo path is changed to - /opt/rocm/opencl/bin/clinfo.

For ROCm v3.3 and older releases, the clinfo path remains unchanged - /opt/rocm/opencl/bin/x86_64/clinfo.

Supported Operating Systems¶ Ubuntu¶ Installing a ROCm Package from a Debian Repository¶ To install from a Debian Repository: Run the following code to ensure that your system is up to date: sudo apt update sudo apt dist - upgrade sudo apt install libnuma - dev sudo reboot Add the ROCm apt repository. For Debian-based systems like Ubuntu, configure the Debian ROCm repository as follows: Note: The public key has changed to reflect the new location. You must update to the new location as the old key will be removed in a future release. Old Key: http://repo.radeon.com/rocm/apt/debian/rocm.gpg.key

New Key: http://repo.radeon.com/rocm/rocm.gpg.key wget - q - O - http : // repo . radeon . com / rocm / rocm . gpg . key | sudo apt - key add - echo 'deb [arch=amd64] http://repo.radeon.com/rocm/apt/debian/ xenial main' | sudo tee / etc / apt / sources . list . d / rocm . list The gpg key may change; ensure it is updated when installing a new release. If the key signature verification fails while updating, re-add the key from the ROCm apt repository. The current rocm.gpg.key is not available in a standard key ring distribution, but has the following sha1sum hash: e85a40d1a43453fe37d63aa6899bc96e08f2817a rocm . gpg . key Install the ROCm meta-package. Update the appropriate repository list and install the rocm-dkms meta-package: sudo apt update sudo apt install rocm - dkms && sudo reboot Set permissions. To access the GPU, you must be a user in the video and render groups. Ensure your user account is a member of the video and render groups prior to using ROCm. To identify the groups you are a member of, use the following command: groups To add your user to the video and render groups, use the following command with the sudo password: sudo usermod -a -G video $LOGNAME sudo usermod -a -G render $LOGNAME By default, you must add any future users to the video and render groups. To add future users to the video and render groups, run the following command: echo 'ADD_EXTRA_GROUPS=1' | sudo tee - a / etc / adduser . conf echo 'EXTRA_GROUPS=video' | sudo tee - a / etc / adduser . conf echo 'EXTRA_GROUPS=render' | sudo tee - a / etc / adduser . conf Restart the system. After restarting the system, run the following commands to verify that the ROCm installation is successful. If you see your GPUs listed by both commands, the installation is considered successful. / opt / rocm / bin / rocminfo / opt / rocm / opencl / bin / clinfo Note: To run the ROCm programs, add the ROCm binaries in your PATH. echo 'export PATH=$PATH:/opt/rocm/bin:/opt/rocm/profiler/bin:/opt/rocm/opencl/bin' | sudo tee - a / etc / profile . d / rocm . sh Uninstalling ROCm Packages from Ubuntu¶ To uninstall the ROCm packages from Ubuntu 20.04 or Ubuntu 18.04.5, run the following command: sudo apt autoremove rocm - opencl rocm - dkms rocm - dev rocm - utils && sudo reboot Installing Development Packages for Cross Compilation¶ It is recommended that you develop and test development packages on different systems. For example, some development or build systems may not have an AMD GPU installed. In this scenario, you must avoid installing the ROCk kernel driver on the development system. Instead, install the following development subset of packages: sudo apt update sudo apt install rocm - dev Note: To execute ROCm enabled applications, you must install the full ROCm driver stack on your system. Using Debian-based ROCm with Upstream Kernel Drivers¶ You can install the ROCm user-level software without installing the AMD’s custom ROCk kernel driver. To use the upstream kernels, run the following commands instead of installing rocm-dkms: sudo apt update sudo apt install rocm - dev echo 'SUBSYSTEM=="kfd", KERNEL=="kfd", TAG+="uaccess", GROUP="video"' | sudo tee / etc / udev / rules . d / 70 - kfd . rules CentOS RHEL¶ This section describes how to install ROCm on supported RPM-based systems such as CentOS v7.7/RHEL v7.8 and CentOS/RHEL v8.1. Preparing RHEL for Installation¶ RHEL is a subscription-based operating system. You must enable the external repositories to install on the devtoolset-7 environment and the dkms support files. Note: The following steps do not apply to the CentOS installation. The subscription for RHEL must be enabled and attached to a pool ID. See the Obtaining an RHEL image and license page for instructions on registering your system with the RHEL subscription server and attaching to a pool id. Enable the following repositories for RHEL v7.x: sudo subscription - manager repos -- enable rhel - server - rhscl - 7 - rpms sudo subscription - manager repos -- enable rhel - 7 - server - optional - rpms sudo subscription - manager repos -- enable rhel - 7 - server - extras - rpms Enable additional repositories by downloading and installing the epel-release-latest-7/epel-release-latest-8 repository RPM: sudo rpm - ivh < repo > For more details, see https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm for RHEL v7.x

see https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm for RHEL v8.x Install and set up Devtoolset-7. Note: Devtoolset is not required for CentOS/RHEL v8.x To setup the Devtoolset-7 environment, follow the instructions on this page: https://www.softwarecollections.org/en/scls/rhscl/devtoolset-7/ Note: devtoolset-7 is a software collections package and is not supported by AMD. Installing CentOS v7.8/v8.2 for DKMS¶ Use the dkms tool to install the kernel drivers on CentOS/RHEL: sudo yum install -y epel-release sudo yum install -y dkms kernel-headers-`uname -r` kernel-devel-`uname -r` Installing ROCm¶ To install ROCm on your system, follow the instructions below: Delete the previous versions of ROCm before installing the latest version. Create a /etc/yum.repos.d/rocm.repo file with the following contents: CentOS/RHEL 7.x : http://repo.radeon.com/rocm/yum/rpm

CentOS/RHEL 8.x : http://repo.radeon.com/rocm/centos8/rpm [ ROCm ] name = ROCm baseurl = http : // repo . radeon . com / rocm / yum / rpm enabled = 1 gpgcheck = 1 gpgkey = http : // repo . radeon . com / rocm / rocm . gpg . key Note: The URL of the repository must point to the location of the repositories’ repodata database. Install ROCm components using the following command: Note: This step is applicable only for CentOS/RHEL v8.x and is not required for v7.x. sudo yum install rocm - dkms && sudo reboot Restart the system. The rock-dkms component is installed and the /dev/kfd device is now available. Set permissions. To access the GPU, you must be a user in the video group. Ensure your user account is a member of the video group prior to using ROCm. To identify the groups you are a member of, use the following command: groups To add your user to the video group, use the following command with the sudo password: sudo usermod -a -G video $LOGNAME By default, add any future users to the video group. Run the following command to add users to the video group: echo 'ADD_EXTRA_GROUPS=1' | sudo tee - a / etc / adduser . conf echo 'EXTRA_GROUPS=video' | sudo tee - a / etc / adduser . conf Note: Before updating to the latest version of the operating system, delete the ROCm packages to avoid DKMS-related issues. Restart the system. Test the ROCm installation. Testing the ROCm Installation¶ After restarting the system, run the following commands to verify that the ROCm installation is successful. If you see your GPUs listed, you are good to go! / opt / rocm / bin / rocminfo / opt / rocm / opencl / bin / clinfo Note: Add the ROCm binaries in your PATH for easy implementation of the ROCm programs. echo 'export PATH=$PATH:/opt/rocm/bin:/opt/rocm/profiler/bin:/opt/rocm/opencl/bin' | sudo tee - a / etc / profile . d / rocm . sh Compiling Applications Using HCC, HIP, and Other ROCm Software¶ To compile applications or samples, run the following command to use gcc-7.2 provided by the devtoolset-7 environment: scl enable devtoolset - 7 bash Uninstalling ROCm from CentOS/RHEL¶ To uninstall the ROCm packages, run the following command: sudo yum autoremove rocm - opencl rocm - dkms rock - dkms Installing Development Packages for Cross Compilation¶ You can develop and test ROCm packages on different systems. For example, some development or build systems may not have an AMD GPU installed. In this scenario, you can avoid installing the ROCm kernel driver on your development system. Instead, install the following development subset of packages: sudo yum install rocm - dev Note: To execute ROCm-enabled applications, you will require a system installed with the full ROCm driver stack. Using ROCm with Upstream Kernel Drivers¶ You can install ROCm user-level software without installing AMD’s custom ROCk kernel driver. To use the upstream kernel drivers, run the following commands sudo yum install rocm - dev echo 'SUBSYSTEM=="kfd", KERNEL=="kfd", TAG+="uaccess", GROUP="video"' | sudo tee / etc / udev / rules . d / 70 - kfd . rules sudo reboot Note: You can use this command instead of installing rocm-dkms. Note: Ensure you restart the system after ROCm installation. SLES 15 Service Pack 1¶ The following section tells you how to perform an install and uninstall ROCm on SLES 15 SP 1. Installation Install the “dkms” package. sudo SUSEConnect -- product PackageHub / 15.1 / x86_64 sudo zypper install dkms Add the ROCm repo. sudo zypper clean –all sudo zypper addrepo http://repo.radeon.com/rocm/zyp/zypper/ rocm sudo zypper ref sudo rpm --import http://repo.radeon.com/rocm/rocm.gpg.key sudo zypper --gpg-auto-import-keys install rocm-dkms sudo reboot Run the following command once cat << EOF | sudo tee / etc / modprobe . d / 10 - unsupported - modules . conf allow_unsupported_modules 1 EOF sudo modprobe amdgpu Verify the ROCm installation. Run /opt/rocm/bin/rocminfo and /opt/rocm/opencl/bin/clinfo commands to list the GPUs and verify that the ROCm installation is successful. Set permissions. To access the GPU, you must be a user in the video group. Ensure your user account is a member of the video group prior to using ROCm. To identify the groups you are a member of, use the following command: groups To add your user to the video group, use the following command with the sudo password: sudo usermod -a -G video $LOGNAME By default, add any future users to the video group. Run the following command to add users to the video group: echo 'ADD_EXTRA_GROUPS=1' | sudo tee - a / etc / adduser . conf echo 'EXTRA_GROUPS=video' | sudo tee - a / etc / adduser . conf Restart the system. Test the basic ROCm installation. After restarting the system, run the following commands to verify that the ROCm installation is successful. If you see your GPUs listed by both commands, the installation is considered successful. / opt / rocm / bin / rocminfo / opt / rocm / opencl / bin / clinfo Note: To run the ROCm programs more efficiently, add the ROCm binaries in your PATH. echo ‘export PATH=$PATH:/opt/rocm/bin:/opt/rocm/profiler/bin:/opt/rocm/opencl/bin’|sudo tee -a /etc/profile.d/rocm.sh Uninstallation To uninstall, use the following command: sudo zypper remove rocm - opencl rocm - dkms rock - dkms Note: Ensure all other installed packages/components are removed. Note: Ensure all the content in the /opt/rocm directory is completely removed. If the command does not remove all the ROCm components/packages, ensure you remove them individually. Performing an OpenCL-only Installation of ROCm¶ Some users may want to install a subset of the full ROCm installation. If you are trying to install on a system with a limited amount of storage space, or which will only run a small collection of known applications, you may want to install only the packages that are required to run OpenCL applications. To do that, you can run the following installation command instead of the command to install rocm-dkms. sudo yum install rock - dkms rocm - opencl - devel && sudo reboot

HIP Installation Instructions¶ HIP can be easily installed using the pre-built binary packages with the package manager for your platform. Installing pre-built packages¶ HIP can be easily installed using pre-built binary packages using the package manager for your platform. HIP Prerequisites¶ HIP code can be developed either on AMD ROCm platform using HIP-Clang compiler, or a CUDA platform with nvcc installed. AMD Platform¶ sudo apt install mesa - common - dev sudo apt install clang sudo apt install comgr sudo apt - get - y install rocm - dkms For more information about AMD ROCm Installation Guide, https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html HIP-Clang is the compiler for compiling HIP programs on AMD platform. HIP-Clang can be built manually: git clone - b rocm - 3.8 . x https : // github . com / RadeonOpenCompute / llvm - project . git cd llvm - project mkdir - p build && cd build cmake - DCMAKE_INSTALL_PREFIX =/ opt / rocm / llvm - DCMAKE_BUILD_TYPE = Release - DLLVM_ENABLE_ASSERTIONS = 1 - DLLVM_TARGETS_TO_BUILD = "AMDGPU;X86" - DLLVM_ENABLE_PROJECTS = "clang;lld;compiler-rt" ../ llvm make - j sudo make install The ROCm device library can be manually built as following, export PATH=/opt/rocm/llvm/bin:$PATH git clone -b rocm-3.8.x https://github.com/RadeonOpenCompute/ROCm-Device-Libs.git cd ROCm-Device-Libs mkdir -p build && cd build CC=clang CXX=clang++ cmake -DLLVM_DIR=/opt/rocm/llvm -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_WERROR=1 -DLLVM_ENABLE_ASSERTIONS=1 -DCMAKE_INSTALL_PREFIX=/opt/rocm .. make -j sudo make install NVIDIA Platform¶ HIP-nvcc is the compiler for HIP program compilation on NVIDIA platform. Add the ROCm package server to your system as per the OS-specific guide available here.

Install the â€œhip-nvccâ€ package. This will install CUDA SDK and the HIP porting layer. apt - get install hip - nvcc Default paths and environment variables: By default HIP looks for CUDA SDK in /usr/local/cuda (can be overriden by setting CUDA_PATH env variable). By default HIP is installed into /opt/rocm/hip (can be overridden by setting HIP_PATH environment variable). Optionally, consider adding /opt/rocm/bin to your path to make it easier to use the tools.

Building HIP from Source¶ Build ROCclr¶ ROCclr is defined on AMD platform that HIP use Radeon Open Compute Common Language Runtime (ROCclr), which is a virtual device interface that HIP runtimes interact with different backends. See https://github.com/ROCm-Developer-Tools/ROCclr git clone - b rocm - 3.8 . x https : // github . com / ROCm - Developer - Tools / ROCclr . git export ROCclr_DIR = "$(readlink -f ROCclr)" git clone - b rocm - 3.8 . x https : // github . com / RadeonOpenCompute / ROCm - OpenCL - Runtime . git export OPENCL_DIR = "$(readlink -f ROCm-OpenCL-Runtime)" cd "$ROCclr_DIR" mkdir - p build ; cd build cmake - DOPENCL_DIR = "$OPENCL_DIR" - DCMAKE_INSTALL_PREFIX =/ opt / rocm / rocclr .. make - j sudo make install ( this is optional ) Build HIP¶ git clone - b rocm - 3.8 . x https : // github . com / ROCm - Developer - Tools / HIP . git export HIP_DIR = "$(readlink -f HIP)" cd "$HIP_DIR" mkdir - p build ; cd build cmake - DCMAKE_BUILD_TYPE = Release - DHIP_COMPILER = clang - DHIP_PLATFORM = rocclr - DCMAKE_PREFIX_PATH = "$ROCclr_DIR/build;/opt/rocm/" - DCMAKE_INSTALL_PREFIX =</ where / to / install / hip > .. make - j sudo make install Default paths and environment variables¶ By default HIP looks for HSA in /opt/rocm/hsa (can be overridden by setting HSA_PATH environment variable).

By default HIP is installed into /opt/rocm/hip (can be overridden by setting HIP_PATH environment variable).

By default HIP looks for clang in /opt/rocm/llvm/bin (can be overridden by setting HIP_CLANG_PATH environment variable)

By default HIP looks for device library in /opt/rocm/lib (can be overridden by setting DEVICE_LIB_PATH environment variable).

Optionally, consider adding /opt/rocm/bin to your PATH to make it easier to use the tools.

Optionally, set HIPCC_VERBOSE=7 to output the command line for compilation. After installation, make sure HIP_PATH is pointed to /where/to/install/hip Verify your installation¶ Run hipconfig (instructions below assume default installation path) : /opt/rocm/bin/hipconfig --full Compile and run the square sample.

AMD ROCm MultiVersion Installation¶ Users can install and access multiple versions of the ROCm toolkit simultaneously. Previously, users could install only a single version of the ROCm toolkit. Now, users have the option to install multiple versions simultaneously and toggle to the desired version of the ROCm toolkit. From the v3.3 release, multiple versions of ROCm packages can be installed in the /opt/rocm-<version> folder. Ensure the existing installations of ROCm, including /opt/rocm, are completely removed before the v3.3 ROCm toolkit installation. The ROCm v3.3 package requires a clean installation. To install a single instance of ROCm, use the rocm-dkms or rocm-dev packages to install all the required components. This creates a symbolic link /opt/rocm pointing to the corresponding version of ROCm installed on the system.

To install individual ROCm components, create the /opt/rocm symbolic link pointing to the version of ROCm installed on the system. For example, # ln -s /opt/rocm-3.3.0 /opt/rocm

To install multiple instance ROCm packages, create /opt/rocm symbolic link pointing to the version of ROCm installed/used on the system. For example, # ln -s /opt/rocm-3.3.0 /opt/rocm Note: The Kernel Fusion Driver (KFD) must be compatible with all versions of the ROCm software installed on the system. Review the following important notes: Single Version Installation To install a single instance of the ROCm package, access the non-versioned packages. You must not install any components from the multi-instance set. For example, rocm-dkms

rocm-dev

hip A fresh installation or an upgrade of the single-version installation will remove the existing version completely and install the new version in the /opt/rocm-<version> folder. Multi Version Installation To install a multi-instance of the ROCm package, access the versioned packages and components. For example, rocm-dkms3.3.0

rocm-dev3.3.0

hip3.3.0 The new multi-instance package enables you to install two versions of the ROCm toolkit simultaneously and provides the ability to toggle between the two versioned packages.

The ROCm-DEV package does not create symlinks

Users must create symlinks if required

Multi-version installation with previous ROCm versions is not supported

Kernel Fusion Driver (KFD) must be compatible with all versions of ROCm installations IMPORTANT: A single instance ROCm package cannot co-exist with the multi-instance package. NOTE: The multi-instance installation applies only to ROCm v3.3 and above. This package requires a fresh installation after the complete removal of existing ROCm packages. The multi-version installation is not backward compatible. Note: If you install the multi-instance version of AMD ROCm and create a sym-link to /opt/rocm, you must run ‘Idconfig’ to ensure the software stack functions correctly with the sym-link.

ROCm Installation Known Issues and Workarounds¶ The ROCm platform relies on some closed source components to provide functionalities like HSA image support. These components are only available through the ROCm repositories, and they may be deprecated or become open source components in the future. These components are made available in the following packages: hsa-ext-rocr-dev

Getting the ROCm Source Code¶ AMD ROCm is built from open source software. It is, therefore, possible to modify the various components of ROCm by downloading the source code and rebuilding the components. The source code for ROCm components can be cloned from each of the GitHub repositories using git. For easy access to download the correct versions of each of these tools, the ROCm repository contains a repo manifest file called default.xml. You can use this manifest file to download the source code for ROCm software. The repo tool from Google® allows you to manage multiple git repositories simultaneously. Run the following commands to install the repo: mkdir - p ~/ bin / curl https : // storage . googleapis . com / git - repo - downloads / repo > ~/ bin / repo chmod a + x ~/ bin / repo Note: You can choose a different folder to install the repo into if you desire. ~/bin/ is used as an example.

Downloading the ROCm Source Code¶ The following example shows how to use the repo binary to download the ROCm source code. If you choose a directory other than ~/bin/ to install the repo, you must use that chosen directory in the code as shown below: mkdir - p ~/ ROCm / cd ~/ ROCm / ~/ bin / repo init - u https : // github . com / RadeonOpenCompute / ROCm . git - b roc - 3.8 . x repo sync Note: Using this sample code will cause the repo to download the open source code associated with this ROCm release. Ensure that you have ssh-keys configured on your machine for your GitHub ID prior to the download.