Skip to content

Latest commit

 

History

History
220 lines (172 loc) · 19.7 KB

README.md

File metadata and controls

220 lines (172 loc) · 19.7 KB
Raw

alpaka - Abstraction Library for Parallel Kernel Acceleration

Continuous Integration Documentation Status Doxygen Language Platforms License

alpaka

The alpaka library is a header-only C++17 abstraction library for accelerator development.

Its aim is to provide performance portability across accelerators through the abstraction (not hiding!) of the underlying levels of parallelism.

It is platform independent and supports the concurrent and cooperative use of multiple devices such as the hosts CPU as well as attached accelerators as for instance CUDA GPUs and Xeon Phis (currently native execution only). A multitude of accelerator back-end variants using CUDA, OpenMP (2.0/5.0), std::thread and also serial execution is provided and can be selected depending on the device. Only one implementation of the user kernel is required by representing them as function objects with a special interface. There is no need to write special CUDA, OpenMP or custom threading code. Accelerator back-ends can be mixed within a device queue. The decision which accelerator back-end executes which kernel can be made at runtime.

The abstraction used is very similar to the CUDA grid-blocks-threads division strategy. Algorithms that should be parallelized have to be divided into a multi-dimensional grid consisting of small uniform work items. These functions are called kernels and are executed in parallel threads. The threads in the grid are organized in blocks. All threads in a block are executed in parallel and can interact via fast shared memory. Blocks are executed independently and can not interact in any way. The block execution order is unspecified and depends on the accelerator in use. By using this abstraction the execution can be optimally adapted to the available hardware.

Software License

alpaka is licensed under MPL-2.0.

Documentation

The alpaka documentation can be found in the online manual. The documentation files in .rst (reStructuredText) format are located in the docs subfolder of this repository. The source code documentation is generated with doxygen.

Accelerator Back-ends

Accelerator Back-end Lib/API Devices Execution strategy grid-blocks Execution strategy block-threads
Serial n/a Host CPU (single core) sequential sequential (only 1 thread per block)
OpenMP 2.0+ blocks OpenMP 2.0+ Host CPU (multi core) parallel (preemptive multitasking) sequential (only 1 thread per block)
OpenMP 2.0+ threads OpenMP 2.0+ Host CPU (multi core) sequential parallel (preemptive multitasking)
std::thread std::thread Host CPU (multi core) sequential parallel (preemptive multitasking)
TBB TBB 2.2+ Host CPU (multi core) parallel (preemptive multitasking) sequential (only 1 thread per block)
CUDA CUDA 9.0+ NVIDIA GPUs parallel (undefined) parallel (lock-step within warps)
HIP(clang) HIP 5.1+ AMD GPUs parallel (undefined) parallel (lock-step within warps)

Supported Compilers

This library uses C++17 (or newer when available).

Accelerator Back-end gcc 9.5
(Linux)		 gcc 10.4 / 11.1
(Linux)		 gcc 12.3
(Linux)		 gcc 13.1
(Linux)		 clang 9
(Linux)		 clang 10 / 11
(Linux)		 clang 12
(Linux)		 clang 13
(Linux)		 clang 14
(Linux)		 clang 15
(Linux)		 clang 16
(Linux)		 clang 17
(Linux)		 icpx 2023.1.0 / 2023.2.0 (Linux) Xcode 13.2.1 / 14.2 / 14.3.1
(macOS)		 Visual Studio 2022
(Windows)
Serial ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
OpenMP 2.0+ blocks ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅1 ✅ ✅
OpenMP 2.0+ threads ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅1 ✅ ✅
std::thread ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
TBB ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
CUDA (nvcc) ✅
(CUDA 11.0 - 12.3)2		 ✅
(CUDA 11.4 - 12.0)2		 ✅
(CUDA 12.0 - 12.3)		 ❌ ✅
(CUDA 11.0-11.2; 11.6 - 12.0)2		 ✅
(CUDA 11.2, 11.6 - 12.0)2		 ✅
(CUDA 11.6 - 12.0)2		 ✅
(CUDA 11.7 - 12.0)		 ✅
(CUDA 11.8 - 12.0)		 ✅
(CUDA 12.2)		 ✅
(CUDA 12.3)		 ❌ ❌ ❌ ❌
CUDA (clang) - - - ❌ ❌ ❌ ❌ ❌ ✅ (CUDA 11.0 - 11.5) ✅ (CUDA 11.0 - 11.5)3 ✅ (CUDA 11.0 - 11.5)3 ✅ (CUDA 11.0 - 11.8)3 ❌ - -
HIP (clang) - - - ❌ ❌ ❌ ❌ ❌ ✅ (HIP 5.1 - 5.2) ✅ (HIP 5.3 - 5.4) ✅ (HIP 5.5 - 5.6) ✅ (HIP 5.7 - 6.0) ❌ - -
SYCL ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ❌ ✅4 ❌ ❌

Other compilers or combinations marked with ❌ in the table above may work but are not tested in CI and are therefore not explicitly supported.

Dependencies

Boost 1.74.0+ is the only mandatory external dependency. The alpaka library itself just requires header-only libraries. However some of the accelerator back-end implementations require different boost libraries to be built.

When an accelerator back-end using CUDA is enabled, version 11.0 (with nvcc as CUDA compiler) or version 9.2 (with clang as CUDA compiler) of the CUDA SDK is the minimum requirement. NOTE: When using clang as a native CUDA compiler, the CUDA accelerator back-end can not be enabled together with any OpenMP accelerator back-end because this combination is currently unsupported. NOTE: Separable compilation is disabled by default and can be enabled via the CMake flag CMAKE_CUDA_SEPARABLE_COMPILATION.

When an accelerator back-end using OpenMP is enabled, the compiler and the platform have to support the corresponding minimum OpenMP version.

When an accelerator back-end using TBB is enabled, the compiler and the platform have to support the corresponding minimum TBB version.

Usage

The library is header only so nothing has to be built. CMake 3.22+ is required to provide the correct defines and include paths. Just call alpaka_add_executable instead of add_executable and the difficulties of the CUDA nvcc compiler in handling .cu and .cpp files are automatically taken care of. Source files do not need any special file ending. Examples of how to utilize alpaka within CMake can be found in the example folder.

The whole alpaka library can be included with: #include <alpaka/alpaka.hpp> Code that is not intended to be utilized by the user is hidden in the detail namespace.

Furthermore, for a CUDA-like experience when adopting alpaka we provide the library cupla. It enables a simple and straightforward way of porting existing CUDA applications to alpaka and thus to a variety of accelerators.

Single header

The CI creates a single-header version of alpaka on each commit, which you can find on the single-header branch.

This is especially useful, if you would like to play with alpaka on Compiler explorer. Just include alpaka like

#include <https://raw.githubusercontent.com/alpaka-group/alpaka/single-header/include/alpaka/alpaka.hpp>

and enable the desired backend on the compiler's command line using the corresponding macro, e.g. via -DALPAKA_ACC_CPU_B_SEQ_T_SEQ_ENABLED.

Introduction

For a quick introduction, feel free to playback the recording of our presentation at GTC 2016:

Citing alpaka

Currently all authors of alpaka are scientists or connected with research. For us to justify the importance and impact of our work, please consider citing us accordingly in your derived work and publications:

% Peer-Reviewed Publication %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Peer reviewed and accepted publication in
%   "2nd International Workshop on Performance Portable
%    Programming Models for Accelerators (P^3MA)"
% colocated with the
%   "2017 ISC High Performance Conference"
%   in Frankfurt, Germany
@inproceedings{MathesP3MA2017,
  author    = {{Matthes}, A. and {Widera}, R. and {Zenker}, E. and {Worpitz}, B. and
               {Huebl}, A. and {Bussmann}, M.},
  title     = {Tuning and optimization for a variety of many-core architectures without changing a single line of implementation code
               using the Alpaka library},
  archivePrefix = "arXiv",
  eprint    = {1706.10086},
  keywords  = {Computer Science - Distributed, Parallel, and Cluster Computing},
  day       = {30},
  month     = {Jun},
  year      = {2017},
  url       = {https://arxiv.org/abs/1706.10086},
}

% Peer-Reviewed Publication %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Peer reviewed and accepted publication in
%   "The Sixth International Workshop on
%    Accelerators and Hybrid Exascale Systems (AsHES)"
% at the
%   "30th IEEE International Parallel and Distributed
%    Processing Symposium" in Chicago, IL, USA
@inproceedings{ZenkerAsHES2016,
  author    = {Erik Zenker and Benjamin Worpitz and Ren{\'{e}} Widera
               and Axel Huebl and Guido Juckeland and
               Andreas Kn{\"{u}}pfer and Wolfgang E. Nagel and Michael Bussmann},
  title     = {Alpaka - An Abstraction Library for Parallel Kernel Acceleration},
  archivePrefix = "arXiv",
  eprint    = {1602.08477},
  keywords  = {Computer science;CUDA;Mathematical Software;nVidia;OpenMP;Package;
               performance portability;Portability;Tesla K20;Tesla K80},
  day       = {23},
  month     = {May},
  year      = {2016},
  publisher = {IEEE Computer Society},
  url       = {http://arxiv.org/abs/1602.08477},
}


% Original Work: Benjamin Worpitz' Master Thesis %%%%%%%%%%
%
@MasterThesis{Worpitz2015,
  author = {Benjamin Worpitz},
  title  = {Investigating performance portability of a highly scalable
            particle-in-cell simulation code on various multi-core
            architectures},
  school = {{Technische Universit{\"{a}}t Dresden}},
  month  = {Sep},
  year   = {2015},
  type   = {Master Thesis},
  doi    = {10.5281/zenodo.49768},
  url    = {http://dx.doi.org/10.5281/zenodo.49768}
}

Contributing

Rules for contributions can be found in CONTRIBUTING.md. Any pull request will be reviewed by a maintainer.

Thanks to all active and former contributors.

Footnotes

  1. Due to an icpx bug the OpenMP back-ends cannot be used together with the SYCL back-end. ↩ ↩2

  2. Due to a CUDA bug debug builds are only supported for CUDA versions >= 11.7. ↩ ↩2 ↩3 ↩4 ↩5

  3. Due to an LLVM bug in debug mode only release builds are supported. ↩ ↩2 ↩3

  4. Currently, the unit tests are compiled but not executed. ↩