README.md

Warning

Superseded by https://github.com/UoB-HPC/CloverLeaf, which contains a SYCL implementation, along with many other models.

A SYCL port of CloverLeaf

This is a port of CloverLeaf from MPI+Kokkos to MPI+SYCL.

Tested configurations

The program was compiled and tested on the following configurations.

GCC 9.1.0 + ComputeCpp CE 1.1.3

• Intel CPU - Intel OpenCL runtime 18.1
  • 1 x i7-8850H
  • 1 x i7-6700K
  • 1 x i7-6770HQ
  • 1 x Xeon Gold 6126
  • 1 x Xeon E5-2630L v0
• Intel GPU - Intel compute-runtime 19.32.13826
  • 1 x UHD Graphics 630
  • 1 x Iris Pro Graphics 580

oneAPI DPC++ 2020.5.0.0604; ComputeCpp CE 2.1.0

• AMD CPU
  • 1x Ryzen R9 3900X

hipSYCL 0.8.0

• AMD CPU
  • 1x Ryzen R9 3900X

Building

Prerequisites(ComputeCpp):

• CentOS 7
• cmake3
• openmpi, opemmpi-devel
• ComputeCpp community edition
• devtoolset-7

Prerequisites(hipSYCL):

• CentOS 7
• cmake3
• openmpi, opemmpi-devel
• devtoolset-7 * hipSYCL 0.8.0+

Prerequisites(DPCPP):

• CentOS 8
• cmake3
• Intel oneAPI basekit+hpckit

First, generate a build:

cmake3 -Bbuild -H. -DCMAKE_BUILD_TYPE=Release -DSYCL_RUNTIME=COMPUTECPP -DComputeCpp_DIR=<path_to_computecpp> -DOpenCL_INCLUDE_DIR=include/

Flags:

• SYCL_RUNTIME - one of HIPSYCL|COMPUTECPP|DPCPP
  • For SYCL_RUNTIME=HIPSYCL, supply hipSYCL install path with HIPSYCL_INSTALL_DIR
  • For SYCL_RUNTIME=COMPUTECPP, supply ComputeCpp install path with ComputeCpp_DIR
  • For SYCL_RUNTIME=DPCPP, make sure the DPC++ compiler (dpcpp) is available in PATH
• MPI_AS_LIBRARY - BOOL(ON|OFF), enable if CMake is unable to detect the correct MPI implementation or if you want to use a specific MPI installation. Use this a last resort only as your MPI implementation may pass on extra linker flags.
  • Set MPI_C_LIB_DIR to <mpi_root_dir>/lib
  • Set MPI_C_INCLUDE_DIR to <mpi_root_dir>/include
  • Set MPI_C_LIB to the library name, for exampe: mpich for libmpich.so
• CXX_EXTRA_FLAGS - STRING, appends extra flags that will be passed on to the compiler, applies to all configs
• CXX_EXTRA_LINKER_FLAGS - STRING, appends extra linker flags (the comma separated list after the -Wl flag) to the linker, applies to all configs

If parts of your toolchain are installed at different places, you'll have to specify it manually, for example:

cmake3 -Bbuild -H.  \
-DSYCL_RUNTIME=COMPUTECPP \
-DComputeCpp_DIR=/nfs/software/x86_64/computecpp/1.1.3 \
-DCMAKE_C_COMPILER=/nfs/software/x86_64/gcc/9.1.0/bin/gcc \
-DCMAKE_CXX_COMPILER=/nfs/software/x86_64/gcc/9.1.0/bin/g++ \
-DCMAKE_BUILD_TYPE=Release \

For ComputeCpp's experimental NVidia ptx support, add:

-DCOMPUTECPP_BITCODE=ptx64

Proceed with compiling:

cmake3 --build build --target clover_leaf --config Release -j $(nproc)

Running

The main clover_leaf executable takes a clover.in file as parameter and outputs clover.out at working directory.

For example, after successful compilation, at project root:

./build/clover_leaf --file InputDecks/clover_bm16_short.in

See Tested configurations for tested platforms and drivers. Also see ComputeCpp's platform support page for supported configurations.

For help, use the -h flag:

Options:
  -h  --help               Print the message
      --list               List available devices
      --list-detailed      List available devices and capabilities
      --device <INDEX>     Select device at INDEX from output of --list
      --input              Custom clover.in file (defaults to clover.in if unspecified)

To run on a specific device, unload all other drivers or modify the device selector in start.cpp:107 and recompile.

Development

Prerequisites:

• entr

You may also need to install epel-release for some of the packages.

For a quick build, use:

source /opt/rh/devtoolset-7/enable
module load mpi

./dev.sh <ComputeCpp_DIR>
e.g
./dev.sh /home/tom/ComputeCpp-CE-1.1.3-CentOS-x86_64

Known issues

• Due to ComputeCpp's limitation where built-ins are missing when targeting ptx, NVidia based GPUs are not supported yet.