mirror of
https://github.com/ROCm/ROCm.git
synced 2026-01-11 07:38:17 -05:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
35676eb054 | ||
|
|
bf2f4ddf4b | ||
|
|
3e5f9fc8c9 | ||
|
|
98e035f0ce |
335
README.md
335
README.md
@@ -1,312 +1,34 @@
|
||||
## Are You Ready to ROCK?
|
||||
The ROCm Platform brings a rich foundation to advanced computing by seamlessly
|
||||
integrating the CPU and GPU with the goal of solving real-world problems.
|
||||
The ROCm Platform bringing a rich foundation to advanced computing by better
|
||||
integrating the CPU and GPU to solve real-world problems.
|
||||
|
||||
On April 25th, 2016, we delivered ROCm 1.0 built around three pillars:
|
||||
On April 25th, 2016, we delivered ROCm 1.0 built around three core foundation
|
||||
elements:
|
||||
|
||||
1) Open Heterogeneous Computing Platform (Linux Driver and Runtime Stack),
|
||||
optimized for HPC & Ultra-scale class computing;
|
||||
|
||||
2) Heterogeneous C and C++ Single Source Compiler, to approach computation
|
||||
holistically, on a system level, rather than as a discrete GPU artifact;
|
||||
|
||||
3) HIP, acknowledging the need for freedom of choice when it comes to platforms
|
||||
and APIs for GPU computing.
|
||||
Open Hetrogenous Computing Platform (Linux(R) Driver and Runtime Stack)
|
||||
optimized for HPC & Ultra-scale class computing Heterogeneous C and C++
|
||||
Single Source to better address the whole system computation not just a GPU
|
||||
device HIP acknowledging the need for platform choice when utilizing GPU
|
||||
computing API
|
||||
|
||||
Using our knowledge of the HSA Standards and, more importantly, the HSA
|
||||
Runtime, we have been able to successfully extended support to the dGPU with
|
||||
critical features for accelerating NUMA computation. As a result, the ROCK
|
||||
driver is composed of several components based on our efforts to develop the
|
||||
Runtime we have been able to successfully extended support to the dGPU with
|
||||
critical features for NUMA class acceleration. As a result, the ROCK driver is
|
||||
composed of several components based on our efforts to develop the
|
||||
Heterogeneous System Architecture for APUs, including the new AMDGPU driver,
|
||||
the Kernel Fusion Driver (KFD), the HSA+ Runtime and an LLVM based compilation
|
||||
stack which provides support for key languages. This support starts with AMD’s
|
||||
Fiji family of dGPUs, and has expanded to include the Hawaii dGPU family in ROCm
|
||||
1.2. ROCm 1.3 further extends support to include the Polaris family of ASICs.
|
||||
stack for the building of key language support. This support starts with AMD’s
|
||||
Fiji Family of dGPU, and has expanded to include the Hawaii dGPU Family in
|
||||
ROCm 1.2.
|
||||
|
||||
#### Supported CPUs
|
||||
The ROCm Platform leverages PCIe Atomics (Fetch ADD, Compare and SWAP,
|
||||
Unconditional SWAP, AtomicsOpCompletion).
|
||||
[PCIe atomics](https://github.com/RadeonOpenCompute/RadeonOpenCompute.github.io/blob/master/ROCmPCIeFeatures.md)
|
||||
are only supported on PCIe Gen3 Enabled CPUs and PCIe Gen3 Switches like
|
||||
Broadcom PLX. When you install your GPUs make sure you install them in a fully
|
||||
PCIe Gen3 x16 or x8 slot attached either directly to the CPU's Root I/O
|
||||
controller or via a PCIe switch directly attached to the CPU's Root I/O
|
||||
controller. In our experience many issues stem from trying to use consumer
|
||||
motherboards which provide Physical x16 Connectors that are electrically
|
||||
connected as e.g. PCIe Gen2 x4. This typically occurs when connecting via the
|
||||
Southbridge PCIe I/O controller. If you motherboard is part of this category,
|
||||
please do not use this connector for your GPUs, if you intend to exploit ROCm.
|
||||
### Overview and Installation Instructions
|
||||
For an overview of the ROCm stack, installation instructions, and other supporting
|
||||
documentation, please refer to https://radeonopencompute.github.io
|
||||
|
||||
|
||||
Our GFX8 GPU's (Fiji & Polaris Family) use PCIe Gen 3 and PCIe Atomics.
|
||||
|
||||
Current CPUs which support PCIe Gen3 + PCIe Atomics are:
|
||||
* Intel Xeon E5 v3 or newer CPUs;
|
||||
* Intel Xeon E3 v3 or newer CPUs;
|
||||
* Intel Core i7 v4, Core i5 v4, Core i3 v4 or newer CPUs (i.e. Haswell family or newer).
|
||||
* AMD Ryzen CPUs;
|
||||
|
||||
Upcoming CPUs which will support PCIe Gen3 + PCIe Atomics are:
|
||||
* AMD Naples Server CPUs;
|
||||
* Cavium Thunder X Server Processor.
|
||||
|
||||
Experimental support for our GFX7 GPUs Radeon R9 290, R9 390, AMD FirePro S9150, S9170 note they do not support or
|
||||
take advantage of PCIe Atomics. However, we still recommend that you use a CPU
|
||||
from the list provided above.
|
||||
|
||||
#### Not supported or very limited support under ROCm
|
||||
* We do not support ROCm with PCIe Gen 2 enabled CPUs such as the AMD Opteron,
|
||||
Phenom, Phenom II, Athlon, Athlon X2, Athlon II and Older Intel Xeon and Intel
|
||||
Core Architecture and Pentium CPUs.
|
||||
* We also do not support AMD Carrizo and Kaveri APU as host for compliant dGPU
|
||||
attachments.
|
||||
* Thunderbolt 1 and 2 enabled GPU's are not supported by ROCm. Thunderbolt 1 & 2
|
||||
are PCIe Gen2 based.
|
||||
* AMD Carrizo based APUs have limited support due to OEM & ODM's choices when it
|
||||
comes to some key configuration parameters. On point, we have observed that
|
||||
Carrizo Laptops, AIOs and Desktop systems showed inconsistencies in exposing and
|
||||
enabling the System BIOS parameters required by the ROCm stack. Before
|
||||
purchasing a Carrizo system for ROCm, please verify that the BIOS provides an
|
||||
option for enabling IOMMUv2. If this is the case, the final requirement is
|
||||
associated with correct CRAT table support - please inquire with the OEM about
|
||||
the latter.
|
||||
* AMD Merlin/Falcon Embedded System is also not currently supported by the public Repo.
|
||||
|
||||
#### Support for future APUs
|
||||
We are well aware of the excitement and anticipation built around using ROCm
|
||||
with an APU system which fully exposes Shared Virtual Memory alongside and cache
|
||||
coherency between the CPU and GPU. To this end, in mid 2017 we plan on testing
|
||||
commercial AM4 motherboards for the Bristol Ridge and Raven Ridge families of
|
||||
APUs. Just like you, we still waiting for access to them! Once we have the first
|
||||
boards in the lab we will detail our experiences via our blog, as well as build
|
||||
a list of motherboard that are qualified for use with ROCm.
|
||||
|
||||
### New Features to ROCm
|
||||
|
||||
#### Developer preview of the new OpenCL 1.2 compatible language runtime and compiler
|
||||
|
||||
* OpenCL 2.0 compatible kernel language support with OpenCL 1.2 compatible
|
||||
runtime
|
||||
* Supports offline ahead of time compilation today;
|
||||
during the Beta phase we will add in-process/in-memory compilation.
|
||||
* Binary Package support for Ubuntu 16.04 and Fedora 24
|
||||
* Dropping binary package support for Ubuntu 14.04 and Fedora 23
|
||||
|
||||
#### IPC support
|
||||
|
||||
### The latest ROCm platform - ROCm 1.6
|
||||
### The Latest ROCm Platform - ROCm 1.3
|
||||
The latest tested version of the drivers, tools, libraries and source code for
|
||||
the ROCm platform have been released and are available under the roc-1.6.0 or rocm-1.6.0 tag
|
||||
of the following GitHub repositories:
|
||||
|
||||
* [ROCK-Kernel-Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/tree/roc-1.6.0)
|
||||
* [ROCR-Runtime](https://github.com/RadeonOpenCompute/ROCR-Runtime/tree/roc-1.6.0)
|
||||
* [ROCT-Thunk-Interface](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/tree/roc-1.6.0)
|
||||
* [ROC-smi](https://github.com/RadeonOpenCompute/ROC-smi/tree/roc-1.6.0)
|
||||
* [HCC compiler](https://github.com/RadeonOpenCompute/hcc/tree/rocm-1.6.0)
|
||||
* [compiler-runtime](https://github.com/RadeonOpenCompute/compiler-rt/tree/rocm-1.6.0)
|
||||
* [HIP](https://github.com/GPUOpen-ProfessionalCompute-Tools/HIP/tree/roc-1.6.0)
|
||||
* [HIP-Examples](https://github.com/GPUOpen-ProfessionalCompute-Tools/HIP-Examples/tree/roc-1.6.0)
|
||||
* [atmi](https://github.com/RadeonOpenCompute/atmi/tree/0.3.7)
|
||||
|
||||
Additionally, the following mirror repositories that support the HCC compiler
|
||||
are also available on GitHub, and frozen for the rocm-1.6.0 release:
|
||||
|
||||
* [llvm](https://github.com/RadeonOpenCompute/llvm/tree/rocm-1.6.0)
|
||||
* [lld](https://github.com/RadeonOpenCompute/lld/tree/rocm-1.6.0)
|
||||
* [hcc-clang-upgrade](https://github.com/RadeonOpenCompute/hcc-clang-upgrade/tree/rocm-1.6.0)
|
||||
* [ROCm-Device-Libs](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/tree/rocm-1.6.0)
|
||||
|
||||
#### Supported Operating Systems
|
||||
|
||||
The ROCm platform has been tested on the following operating systems:
|
||||
* Ubuntu 16.04
|
||||
* Fedora 24
|
||||
|
||||
### Installing from AMD ROCm repositories
|
||||
AMD is hosting both debian and rpm repositories for the ROCm 1.6 packages.
|
||||
|
||||
The packages in the Debian repository have been signed to ensure package integrity.
|
||||
Directions for each repository are given below:
|
||||
|
||||
#### Packaging server update
|
||||
The packaging server has been changed from the old http://packages.amd.com
|
||||
to the new repository site http://repo.radeon.com.
|
||||
|
||||
#### Debian repository - apt-get
|
||||
|
||||
##### Add the ROCm apt repository
|
||||
For Debian based systems, like Ubuntu, configure the Debian ROCm repository as
|
||||
follows:
|
||||
|
||||
```shell
|
||||
wget -qO - http://repo.radeon.com/rocm/apt/debian/rocm.gpg.key | sudo apt-key add -
|
||||
sudo sh -c 'echo deb [arch=amd64] http://repo.radeon.com/rocm/apt/debian/ xenial main > /etc/apt/sources.list.d/rocm.list'
|
||||
```
|
||||
The gpg key might change, so it may need to be updated when installing a new
|
||||
release. The current rocm.gpg.key is not avialable in a standard key ring distribution,
|
||||
but has the following sha1sum hash:
|
||||
|
||||
f0d739836a9094004b0a39058d046349aacc1178 rocm.gpg.key
|
||||
|
||||
##### Install or Update
|
||||
Next, update the apt-get repository list and install/update the rocm package:
|
||||
|
||||
>**Warning**: Before proceeding, make sure to completely
|
||||
>[uninstall any previous ROCm package](https://github.com/RadeonOpenCompute/ROCm#removing-pre-release-packages):
|
||||
|
||||
```shell
|
||||
sudo apt-get update
|
||||
sudo apt-get install rocm
|
||||
```
|
||||
Then, make the ROCm kernel your default kernel. If using grub2 as your
|
||||
bootloader, you can edit the `GRUB_DEFAULT` variable in the following file:
|
||||
|
||||
```shell
|
||||
sudo vi /etc/default/grub
|
||||
sudo update-grub
|
||||
```
|
||||
|
||||
Once complete, reboot your system.
|
||||
|
||||
We recommend you [verify your installation](https://github.com/RadeonOpenCompute/ROCm#verify-installation) to make sure everything completed successfully.
|
||||
|
||||
#### To install ROCm with Developer Preview of OpenCL
|
||||
|
||||
##### Start by following the instruction of installing ROCm with Debian repository:
|
||||
|
||||
at the step "sudo apt-get install rocm" replace it with:
|
||||
|
||||
```shell
|
||||
sudo apt-get install rocm rocm-opencl
|
||||
```
|
||||
|
||||
To install the development kit for OpenCL, which includes the OpenCL header files, execute this installation command:
|
||||
|
||||
```shell
|
||||
sudo apt-get install rocm-opencl-dev
|
||||
```
|
||||
|
||||
Then follow the direction for Debian Repository
|
||||
|
||||
###### Upon restart, To test your OpenCL instance
|
||||
|
||||
Build and run Hello World OCL app..
|
||||
|
||||
HelloWorld sample:
|
||||
```
|
||||
wget https://raw.githubusercontent.com/bgaster/opencl-book-samples/master/src/Chapter_2/HelloWorld/HelloWorld.cpp
|
||||
wget https://raw.githubusercontent.com/bgaster/opencl-book-samples/master/src/Chapter_2/HelloWorld/HelloWorld.cl
|
||||
```
|
||||
|
||||
Build it using the default ROCm OpenCL include and library locations:
|
||||
```
|
||||
g++ -I /opt/rocm/opencl/include/ ./HelloWorld.cpp -o HelloWorld -L/opt/rocm/opencl/lib/x86_64 -lOpenCL
|
||||
```
|
||||
|
||||
Run it:
|
||||
```
|
||||
./HelloWorld
|
||||
```
|
||||
|
||||
##### Un-install
|
||||
To un-install the entire rocm development package execute:
|
||||
|
||||
```shell
|
||||
sudo apt-get autoremove rocm
|
||||
```
|
||||
|
||||
##### Installing development packages for cross compilation
|
||||
It is often useful to develop and test on different systems. In this scenario,
|
||||
you may prefer to avoid installing the ROCm Kernel to your development system.
|
||||
|
||||
In this case, install the development subset of packages:
|
||||
|
||||
```shell
|
||||
sudo apt-get update
|
||||
sudo apt-get install rocm-dev
|
||||
```
|
||||
|
||||
>**Note:** To execute ROCm enabled apps you will require a system with the full
|
||||
>ROCm driver stack installed
|
||||
|
||||
##### Removing pre-release packages
|
||||
If you installed any of the ROCm pre-release packages from github, they will
|
||||
need to be manually un-installed:
|
||||
|
||||
```shell
|
||||
sudo apt-get purge libhsakmt
|
||||
sudo apt-get purge radeon-firmware
|
||||
sudo apt-get purge $(dpkg -l | grep 'kfd\|rocm' | grep linux | grep -v libc | awk '{print $2}')
|
||||
```
|
||||
|
||||
If possible, we would recommend starting with a fresh OS install.
|
||||
|
||||
#### RPM repository - dnf (yum)
|
||||
|
||||
A dnf (yum) repository is also available for installation of rpm packages.
|
||||
To configure a system to use the ROCm rpm directory create the file
|
||||
/etc/yum.repos.d/rocm.repo with the following contents:
|
||||
|
||||
```shell
|
||||
[remote]
|
||||
|
||||
name=ROCm Repo
|
||||
|
||||
baseurl=http://repo.radeon.com/rocm/yum/rpm/
|
||||
|
||||
enabled=1
|
||||
|
||||
gpgcheck=0
|
||||
```
|
||||
Execute the following commands:
|
||||
|
||||
```shell
|
||||
sudo dnf clean all
|
||||
sudo dnf install rocm
|
||||
```
|
||||
|
||||
As with the debian packages, it is possible to install rocm-dev individually.
|
||||
To uninstall the packages execute:
|
||||
|
||||
```shell
|
||||
sudo dnf remove rocm
|
||||
```
|
||||
|
||||
Just like Ubuntu installs, the ROCm kernel must be the default kernel used at boot time.
|
||||
|
||||
#### Manual installation steps for Fedora
|
||||
|
||||
A fully functional Fedora installation requires a few manual steps to properly
|
||||
setup, including:
|
||||
* [Building compatible libc++ and libc++abi libraries for Fedora](https://github.com/RadeonOpenCompute/hcc/wiki#fedora)
|
||||
|
||||
#### Verify installation
|
||||
|
||||
To verify that the ROCm stack completed successfully you can execute to HSA
|
||||
vectory\_copy sample application (we do recommend that you copy it to a
|
||||
separate folder and invoke make therein):
|
||||
|
||||
```shell
|
||||
cd /opt/rocm/hsa/sample
|
||||
make
|
||||
./vector_copy
|
||||
```
|
||||
|
||||
#### Closed source components
|
||||
The ROCm platform relies on a few closed source components to provide legacy
|
||||
functionality like HSAIL finalization and debugging/profiling support. These
|
||||
components are only available through the ROCm repositories, and will either be
|
||||
deprecated or become open source components in the future. These components are
|
||||
made available in the following packages:
|
||||
|
||||
* hsa-ext-rocr-dev
|
||||
|
||||
### Getting ROCm source code
|
||||
Modifications can be made to the ROCm 1.6 components by modifying the open
|
||||
source code base and rebuilding the components. Source code can be cloned from
|
||||
each of the GitHub repositories using git, or users can use the repo command
|
||||
and the ROCm 1.6 manifest file to download the entire ROCm 1.6 source code.
|
||||
the ROCm platform have been released and are available under the roc-1.3.0 tag.
|
||||
The repo tool can be used to checkout the full software stack.
|
||||
|
||||
#### Installing repo
|
||||
Google's repo tool allows you to manage multiple git repositories
|
||||
@@ -321,12 +43,15 @@ Note: make sure ~/bin exists and it is part of your PATH
|
||||
#### Cloning the code
|
||||
```shell
|
||||
mkdir ROCm && cd ROCm
|
||||
repo init -u https://github.com/RadeonOpenCompute/ROCm.git -b roc-1.6.0
|
||||
repo init -u https://github.com/RadeonOpenCompute/ROCm.git -b roc-1.3.0
|
||||
repo sync
|
||||
```
|
||||
These series of commands will pull all of the open source code associated with
|
||||
the ROCm 1.6 release. Please ensure that ssh-keys are configured for the
|
||||
target machine on GitHub for your GitHub ID.
|
||||
|
||||
* OpenCL Runtime and Compiler will be submitted to the Khronos Group, prior to
|
||||
the final release, for conformance testing.
|
||||
#### Closed Source Components
|
||||
The ROCm platform relies on a few closed source components to provide legacy
|
||||
functionality like HSAIL finalization and debugging/profiling support. These
|
||||
components are only available through the ROCm repositories, and will either be
|
||||
deprecated or become open source components in the future. These components are
|
||||
made available in the following packages:
|
||||
|
||||
* hsa-ext-rocr-dev
|
||||
|
||||
22
default.xml
22
default.xml
@@ -6,22 +6,22 @@
|
||||
<remote name="pctools-github"
|
||||
fetch="http://git@github.com/GPUOpen-ProfessionalCompute-Tools/" />
|
||||
|
||||
<default revision="roc-1.6.x"
|
||||
<default revision="refs/tags/roc-1.3.0"
|
||||
remote="roc-github"
|
||||
sync-j="4" />
|
||||
|
||||
<project path="ROCK-Kernel-Driver" name="ROCK-Kernel-Driver" />
|
||||
<project path="ROCT-Thunk-Interface" name="ROCT-Thunk-Interface" />
|
||||
<project path="ROC-smi" name="ROC-smi" />
|
||||
<project path="ROCR-Runtime" name="ROCR-Runtime" />
|
||||
<project path="llvm" name="llvm" />
|
||||
<project path="llvm-amdgpu-assembler-extra" name="LLVM-AMDGPU-Assembler-Extra" />
|
||||
<project path="clang" name="clang" />
|
||||
|
||||
<project path="hcc" name="hcc" />
|
||||
<project path="compiler-rt" name="compiler-rt" />
|
||||
<project path="ROCT-Thunk-Interface" name="ROCT-Thunk-Interface" />
|
||||
<project path="ROCK-Kernel-Driver" name="ROCK-Kernel-Driver" />
|
||||
<project path="ROC-smi" name="ROC-smi" />
|
||||
<project path="ROCnRDMA" name="ROCnRDMA" />
|
||||
<project path="rdma-perftest" name="rdma-perftest" />
|
||||
<project path="ROCR-Runtime" name="ROCR-Runtime" />
|
||||
<project path="HIP" remote="pctools-github" name="HIP" />
|
||||
<project path="HIP-Examples" remote="pctools-github" name="HIP-Examples" />
|
||||
<project path="atmi" name="atmi" revision="master" />
|
||||
<project path="llvm" name="llvm" />
|
||||
<project path="lld" name="lld" />
|
||||
<project path="hcc-clang-upgrade" name="hcc-clang-upgrade" />
|
||||
<project path="ROCm-Device-Libs" name="ROCm-Device-Libs" />
|
||||
|
||||
</manifest>
|
||||
|
||||
Reference in New Issue
Block a user