Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md cleanup from release #1

Merged
3 commits merged into from
Apr 18, 2016
Merged

README.md cleanup from release #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7eeb203
readme: use a maximum text width of 80
Andres-design16 Apr 18, 2016
67dc889
readme: minor cleanup
Andres-design16 Apr 18, 2016
aea605f
readme: add instruction to remove pre-release packages
Andres-design16 Apr 18, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 91 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
## Are You Ready to ROCK!
The ROCm Platform delivers on the vision of the Boltzmann Initiative, bringing new opportunities in GPU Computing Research.

On November 16th, 2015, the Radeon Technology Group rolled out Boltzmann Initiative with three core foundation elements:

* New Linux(R) Driver and Runtime Stack optimized for HPC & Ultra-scale class computing,
* Heterogeneous C and C++ compiler which best address the whole system not just a single 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 1.0 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 for the building of key language support. This support starts with AMD’s FIJI Family of dGPU, but support is planned to expand in the future to include future ASICS.
The ROCm Platform delivers on the vision of the Boltzmann Initiative, bringing
new opportunities in GPU Computing Research.

On November 16th, 2015, the Radeon Technology Group rolled out Boltzmann
Initiative with three core foundation elements:

* New Linux(R) Driver and Runtime Stack optimized for HPC & Ultra-scale class
computing,
* Heterogeneous C and C++ compiler which best address the whole system not just
a single 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 1.0
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 for the building of key language support. This support starts with AMD’s
FIJI Family of dGPU, but support is planned to expand to include future ASICS.

### The Latest ROCm Platform - ROCm 1.0
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.0 branch of the following GitHub repositories:
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.0.0 tag
of the following GitHub repositories:

* [ROCK-Kernel-Driver](https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver/tree/dev)
* [ROCR-Runtime](https://github.com/RadeonOpenCompute/ROCR-Runtime/tree/dev)
Expand All @@ -19,48 +33,102 @@ The latest tested version of the drivers, tools, libraries and source code for t
* [LLVM-AMDGPU-Assembler-Extra](https://github.com/RadeonOpenCompute/LLVM-AMDGPU-Assembler-Extra/tree/master)
* [ROCnRDMA](https://github.com/RadeonOpenCompute/ROCnRDMA/tree/dev)

In addition the following mirror repositories that support the HCC compiler are also available on GitHub, and frozen for the roc-1.0 release:
In addition the following mirror repositories that support the HCC compiler are
also available on GitHub, and frozen for the roc-1.0.0 release:

* [llvm](https://github.com/RadeonOpenCompute/llvm/tree/roc-1.0)
* [clang](https://github.com/RadeonOpenCompute/clang/tree/roc-1.0)

### Installing from AMD ROCm Repositories
AMD is hosting both debian and rpm repositories for the ROCm 1.0 packages. The packages in both repositories have been signed to ensure package integrity. Directions for each repository are given below:
AMD is hosting both debian and rpm repositories for the ROCm 1.0 packages. The
packages in both repositories have been signed to ensure package integrity.
Directions for each repository are given below:

#### Debian repository - apt-get
For Debian based systems, like Ubuntu, configure the Debian ROCm repository as follows:

##### Add the ROCm apt repository
For Debian based systems, like Ubuntu, configure the Debian ROCm repository as
follows:

```shell
wget -qO - http://atlpackages01.amd.com:81/rocm/apt/debian/rocm.gpg.key | sudo apt-key add -
sudo sh -c 'echo deb [arch=amd64] http://atlpackages01.amd.com:81/rocm/apt/debian/ trusty main > /etc/apt/sources.list.d/rocm.list'
```

Finally, update the apt-get repository list and install the rocm-rel driver package and the rocm-dev development package:
##### 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 pre-release ROCm packages](https://github.com/RadeonOpenCompute/ROCm#removing-pre-release-packages):

```shell
sudo apt-get update
sudo apt-get install rocm-rel
sudo apt-get install rocm-dev
sudo apt-get install rocm
```

##### Un-install
To un-install the entire rocm-dev development package execute:

```shell
sudo apt-get autoremove rocm-dev
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
```
```shell
for package in $(dpkg -l | grep 'kfd\|rocm' | grep linux | grep -v libc | awk '{print $2}');do
echo "=== Removing $package ==="
sudo apt-get purge $package
done
```
The rocm driver package can be un-installed in a similar way, but the kernel images will remain on the system because apt-get will never remove old kernels by default (refer to the file /etc/apt/apt.conf.d/01autoremove-kernels). Kernel images can be removed manually using dpkg or apt-get directly on the package names.

If possible, we would recommend starting with a fresh OS install.

#### RPM repository - dnf (yum)

##### Add the AMD apt repository
##### Install or Update
##### Un-install
##### Installing development packages for cross compilation


#### 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:
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-rocm-dev

### Getting ROCm Source Code
Modifications can be made to the ROCm 1.0 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.0 manifest file to download the entire ROCm 1.0 source code.
Modifications can be made to the ROCm 1.0 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.0 manifest file to download the entire ROCm 1.0 source code.

#### Installing repo
Google's repo tool allows you to manage multiple git repositories simultaneously. You can install it by executing the following commands:
Google's repo tool allows you to manage multiple git repositories
simultaneously. You can install it by executing the following commands:

```shell
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
Expand All @@ -75,6 +143,7 @@ repo init -u https://github.com/RadeonOpenCompute/ROCm.git -b roc-1.0
repo sync
```

These series of commands will pull all of the open source code associated with the ROCm 1.0 release.
These series of commands will pull all of the open source code associated with
the ROCm 1.0 release.

### Building the open source binaries