Compare commits

..

2 Commits

Author SHA1 Message Date
James Edwards
5eec8e9897 Change extraction protocol to http. 2018-06-13 10:58:24 -05:00
Gregory Stoner
d273e165ec Update README.md 2017-10-15 10:24:25 -05:00
2 changed files with 130 additions and 76 deletions

204
README.md
View File

@@ -2,6 +2,27 @@
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.
On April 25th, 2016, we delivered ROCm 1.0 built around three pillars:
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.
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
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 AMDs
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.
#### Supported CPUs
The ROCm Platform leverages PCIe Atomics (Fetch ADD, Compare and SWAP,
Unconditional SWAP, AtomicsOpCompletion).
@@ -17,7 +38,7 @@ 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.
Our GFX8 GPU's (Fiji & Polaris Family) and GFX9 (Vega) use PCIe Gen 3 and PCIe Atomics.
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;
@@ -50,16 +71,17 @@ 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.
* AMD Raven Ridge APU are currently not supported
### New Features to ROCm 1.7
#### 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.
#### DKMS driver installation
* New driver installation uses Dynamic Kernel Module Support (DKMS)
* Only amdkfd and amdgpu kernel modules are installed to support AMD hardware
* Currently only Debian packages are provided for DKMS (no Fedora suport available)
* See the [ROCT-Thunk-Interface](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/tree/roc-1.7.x) and [ROCK-Kernel-Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/tree/roc-1.7.x) for additional documentation on driver setup
### New Features to ROCm
#### Developer preview of the new OpenCL 1.2 compatible language runtime and compiler
@@ -67,68 +89,51 @@ the latter.
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
* Binary Package support for Fedora 24 is not currently available
* Dropping binary package support for Ubuntu 14.04, Fedora 23
* 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.7
### The latest ROCm platform - ROCm 1.6
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.7.x or rocm-1.7.x tag
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.7.x)
* [ROCR-Runtime](https://github.com/RadeonOpenCompute/ROCR-Runtime/tree/roc-1.7.x)
* [ROCT-Thunk-Interface](https://github.com/RadeonOpenCompute/ROCT-Thunk-Interface/tree/roc-1.7.x)
* [ROC-smi](https://github.com/RadeonOpenCompute/ROC-smi/tree/roc-1.7.x)
* [HCC compiler](https://github.com/RadeonOpenCompute/hcc/tree/roc-1.7.x)
* [compiler-runtime](https://github.com/RadeonOpenCompute/compiler-rt/tree/roc-1.7.x)
* [HIP](https://github.com/GPUOpen-ProfessionalCompute-Tools/HIP/tree/roc-1.7.x)
* [HIP-Examples](https://github.com/GPUOpen-ProfessionalCompute-Tools/HIP-Examples/tree/roc-1.7.x)
* [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.7.1 release:
are also available on GitHub, and frozen for the rocm-1.6.0 release:
* [llvm](https://github.com/RadeonOpenCompute/llvm/tree/roc-1.7.x)
* [ldd](https://github.com/RadeonOpenCompute/lld/tree/roc-1.7.x)
* [hcc-clang-upgrade](https://github.com/RadeonOpenCompute/hcc-clang-upgrade/tree/roc-1.7.x)
* [ROCm-Device-Libs](https://github.com/RadeonOpenCompute/ROCm-Device-Libs/tree/roc-1.7.x)
* [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 1.7 platform has been tested on the following 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 only debian repositories for the ROCm 1.7 packages at this time. It is expected
that an rpm repository will be available in the next point release.
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:
##### First make sure your system is up to date
```shell
sudo apt update
sudo apt upgrade
sudo apt dist-upgrade
sudo apt install libnuma-dev
sudo reboot
```
#### Optional: Upgrade to 4.13 kernel
Although not required, it is recommended as of ROCm 1.7.1 that the system's kernel is upgraded to the latest 4.13 version available:
```shell
sudo apt install linux-headers-4.13.0-32-generic linux-image-4.13.0-32-generic linux-image-extra-4.13.0-32-generic linux-signed-image-4.13.0-32-generic
sudo reboot
```
#### 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
#### Debian repository - apt-get
##### Add the ROCm apt repository
For Debian based systems, like Ubuntu, configure the Debian ROCm repository as
@@ -145,32 +150,23 @@ but has the following sha1sum hash:
f0d739836a9094004b0a39058d046349aacc1178 rocm.gpg.key
##### Install or Update
Next, update the apt repository list and install/update the rocm package:
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 update
sudo apt install rocm-dkms
sudo apt-get update
sudo apt-get install rocm
```
###### Next set your permsions
With move to upstreaming the KFD driver and the support of DKMS, for all Console aka headless user, you will need to add all your users to the 'video" group by setting the Unix permissions
Configure
Ensure that your user account is a member of the "video" group prior to using the ROCm driver. You can find which groups you are a member of with the following command:
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
groups
sudo vi /etc/default/grub
sudo update-grub
```
To add yourself to the video group you will need the sudo password and can use the following command:
```shell
sudo usermod -a -G video $LOGNAME
```
Once complete, reboot your system.
We recommend you [verify your installation](https://github.com/RadeonOpenCompute/ROCm#verify-installation) to make sure everything completed successfully.
@@ -179,8 +175,19 @@ We recommend you [verify your installation](https://github.com/RadeonOpenCompute
##### Start by following the instruction of installing ROCm with Debian repository:
No additional steps are required. The rocm-opencl package is now installed with rocm-dkms as a dependency. This includes the development package, rocm-opencl-dev.
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
@@ -206,7 +213,7 @@ g++ -I /opt/rocm/opencl/include/ ./HelloWorld.cpp -o HelloWorld -L/opt/rocm/open
To un-install the entire rocm development package execute:
```shell
sudo apt autoremove rocm-dkms
sudo apt-get autoremove rocm
```
##### Installing development packages for cross compilation
@@ -216,8 +223,8 @@ 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 update
sudo apt install rocm-dev
sudo apt-get update
sudo apt-get install rocm-dev
```
>**Note:** To execute ROCm enabled apps you will require a system with the full
@@ -228,16 +235,63 @@ If you installed any of the ROCm pre-release packages from github, they will
need to be manually un-installed:
```shell
sudo apt purge libhsakmt
sudo apt purge compute-firmware
sudo apt purge $(dpkg -l | grep 'kfd\|rocm' | grep linux | grep -v libc | awk '{print $2}')
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 repository containing rpm packages is currently not available for the ROCm 1.7 release.
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
@@ -249,10 +303,10 @@ made available in the following packages:
* hsa-ext-rocr-dev
### Getting ROCm source code
Modifications can be made to the ROCm 1.7 components by modifying the open
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.7 manifest file to download the entire ROCm 1.7 source code.
and the ROCm 1.6 manifest file to download the entire ROCm 1.6 source code.
#### Installing repo
Google's repo tool allows you to manage multiple git repositories
@@ -267,11 +321,11 @@ 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.7.1
repo init -u https://github.com/RadeonOpenCompute/ROCm.git -b roc-1.6.0
repo sync
```
These series of commands will pull all of the open source code associated with
the ROCm 1.7 release. Please ensure that ssh-keys are configured for the
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

View File

@@ -6,7 +6,7 @@
<remote name="pctools-github"
fetch="http://git@github.com/GPUOpen-ProfessionalCompute-Tools/" />
<default revision="roc-1.7.x"
<default revision="roc-1.6.x"
remote="roc-github"
sync-j="4" />