Skip to content

Latest commit

 

History

History
119 lines (75 loc) · 6.64 KB

installing.md

File metadata and controls

119 lines (75 loc) · 6.64 KB

Building and installing Open SYCL

Manual installation (Linux)

Software dependencies

In order to successfully build and install Open SYCL, the following dependencies must be installed for all backends:

  • python 3 (for the syclcc and syclcc-clang compiler wrappers)
  • cmake
  • the Boost C++ libraries (in particular boost.fiber, boost.context and for the unit tests boost.test)
    • it may be helpful to set the BOOST_ROOT cmake variable to the path to the root directory of Boost you wish to use if cmake does not find it automatically
    • Note for boost 1.78 users: There seems to be a bug in the build system for boost 1.78, causing the compiled fiber and context libraries not to be copied to the installation directory. You will have to copy these libraries manually to the installation directory. In binary packages from some distribution repositories this issue is fixed. You might be only affected when building boost manually from source.

In addition, the various supported compilation flows have additional requirements (see here for more information on available compilation flows):

Compilation flow Target hardware Short description Requirements
omp.library-only Any CPU OpenMP CPU backend Any OpenMP compiler
omp.accelerated Any CPU supported by LLVM OpenMP CPU backend (compiler-accelerated) LLVM >= 11
cuda.integrated-multipass NVIDIA GPUs CUDA backend (clang) CUDA >= 10, LLVM >= 10
cuda.explicit-multipass NVIDIA GPUs CUDA backend (clang, can be targeted simultaneously with other backends) CUDA >= 10, LLVM 11 or 13+
cuda-nvcxx NVIDIA GPUs CUDA backend (nvc++) Latest NVIDIA HPC SDK
hip.integrated-multipass AMD GPUs (supported by ROCm) HIP backend (clang) ROCm >= 4.0, LLVM >= 10
spirv Intel GPUs SPIR-V/Level Zero backend Level Zero driver and loader, clang with SYCL patches (e.g DPC++)
generic NVIDIA, AMD, Intel GPUs Generic single-pass compiler LLVM >= 14. When dispatching kernels to AMD hardware, ROCm >= 5.3 is recommended. When dispatching to NVIDIA, clang needs nvptx64 backend enabled. Open SYCL runtime backends for the respective target hardware need to be available.

Please make sure to read the instructions below for the dependencies that apply to your use case.

LLVM (skip if you only want flows without LLVM dependency)

Follow these instructions.

CUDA (skip if you don't need CUDA support)

Follow these instructions

ROCm (skip if you don't need ROCm support)

Follow these instructions

SPIR-V/Level Zero (skip if you don't need SPIR-V/Level Zero support)

Follow these instructions.

Building and installing

Once the software requirements mentioned above are met, clone the repository:

$ git clone https://github.com/OpenSYCL/OpenSYCL

Then, create a build directory and compile Open SYCL. As described below, some backends and compilation flows must be configured with specific cmake arguments which should be passed during the cmake step.

$ cd <build directory>
$ cmake -DCMAKE_INSTALL_PREFIX=<installation prefix> <more optional options, e.g. to configure the LLVM dependency> <Open SYCL source directory>
$ make install

The default installation prefix is /usr/local. Change this to your liking. Note: Open SYCL needs to be installed to function correctly; don't replace "make install" with just "make"!

CMake options to configure the Open SYCL build
General
  • -DCMAKE_CXX_COMPILER should be pointed to the C++ compiler to compile Open SYCL with. Note that this also sets the default C++ compiler for the CPU backend when using syclcc once Open SYCL is installed. This can however also be modified later using HIPSYCL_CPU_CXX.
omp.library-only
  • -DCMAKE_CXX_COMPILER can be used to set the default OpenMP compiler.
omp.accelerated
  • -DWITH_ACCELERATED_CPU=OFF/ON can be used to explicitly disable/enable CPU acceleration. Support for CPU acceleration is enabled by default when enabling the LLVM dependency, and LLVM is sufficiently new.
cuda.*
cuda-nvcxx
hip.*
spirv
  • No specific cmake flags are currently available.

Manual installation (Mac)

On Mac, only the CPU backends are supported. The required steps are analogous to Linux.

Manual installation (Windows)

For experimental building on Windows (CPU and CUDA backends) see the corresponding wiki. The omp.accelerated CPU compilation flow is unsupported on Windows.

Repositories (Linux)

Note: The software repositories mentioned below are outdated and in the process of being restructured. They do not contain modern Open SYCL versions.

Another way to install Open SYCL is to use our repositories. We provide repositories for several distributions (currently Ubuntu 18.04, CentOS 7, Arch Linux). A description of the repositories is available here

Our repositories cover the entire software stack, i.e. they include a compatible clang/LLVM distribution and ROCm stacks. The following packages are available:

  • hipSYCL - contains the actual Open SYCL libraries, tools and headers
  • hipSYCL-base - contains the LLVM/clang stack used by Open SYCL. Installation of this package is mandatory.
  • hipSYCL-rocm - contains a ROCm stack. This package is only required if you wish to target AMD ROCm GPUs.
  • hipSYCL-nightly - built from the current develop branch every day.
  • hipSYCL-base-nightly - contains the LLVM/clang stack for the nightly Open SYCL packages
  • hipSYCL-rocm-nightly - contains a ROCm stach compatible with the nighlty Open SYCL packages

Note: For legal reasons, we do not redistribute the Open SYCL-cuda package This package is only required if you wish to target CUDA GPUs. You will either have to create a CUDA package using install/scripts/packaging/make-<distribution>-cuda-pkg.sh or you can install CUDA directly using the install/scripts/install-cuda.sh script.

Installation scripts

We also provide scripts for packaging Open SYCL and its dependencies. For more information on packaging and how to create your own Open SYCL packages, please see the documentation.