Skip to content

Latest commit

 

History

History
106 lines (88 loc) · 4.69 KB

readme.md

File metadata and controls

106 lines (88 loc) · 4.69 KB
Raw

A collection of bash scripts for use with ComputeCpp, Codeplay's beta implementation of the Khronos SYCL specification. The main executable bash script, syclcc, attempts to provide a drop-in replacement for GCC. For example:

syclcc hello-sycl.cpp

...will create the binary executable, a.out, in the current directory; assuming you have added the location of syclcc to your PATH environment variable. syclcc is a simple script which calls the main script aligned with the version of Codeplay's ComputeCpp which you are working with. The version of ComputeCpp targeted is determined by the environment variable, COMPUTECPP_DIR, which you should set up. COMPUTECPP_DIR should reference the root directory of your ComputeCpp installation, and so $COMPUTECPP_DIR/bin/compute++ should invoke Codeplay's compute++ compiler.

These scripts can be tested with any C++ files; as well as Codeplay's own SYCL examples. They can also be used to build the SYCL module for SLAMBench.

A native host compiler is assumed to be present; and this may be Clang or GCC. Simply modify the HOST_CXX entry at the top of the script invoked by syclcc.

The syclcc script has been tested using the Intel OpenCL drivers on CPU. To ensure ComputeCpp is configured for this, the COMPUTECPP_TARGET environment variable should be set to intel:cpu. This setting can be the difference between runtime success, and a segmentation fault.

You can also cycle through the version of ComputeCpp targeted by syclcc using three helper scripts. The scripts should be invoked using the linux source command (shown using the bash dot/period operator below), and assume that all ComputeCpp releases exist in the same directory (e.g. $HOME/apps/codeplay), with default directory names:

. syclcc-curr.sh # makes no changes, echoes the release in use

. syclcc-next.sh # select the next ComputeCpp release

. syclcc-prev.sh # select the previous ComputeCpp release

syclcc # executes the currently selected SYCL release's syclcc script

The scripts work with the following versions of ComputeCpp:

  • ComputeCpp-15.10-Linux
  • ComputeCpp-16.03-Linux
  • ComputeCpp-16.05-Linux
  • ComputeCpp-CE-0.1-Linux
  • ComputeCpp-CE-0.2.0-Linux
  • ComputeCpp-CE-0.2.1-Linux
  • ComputeCpp-CE-0.3.0-Linux
  • ComputeCpp-CE-0.3.1-Linux
  • ComputeCpp-CE-0.3.2-Linux
  • ComputeCpp-CE-0.3.3-Ubuntu.16.04-64bit
  • ComputeCpp-CE-0.4.0-Ubuntu-16.04-64bit
  • ComputeCpp-CE-0.5.0-Ubuntu-16.04-64bit
  • ComputeCpp-CE-0.5.1-Ubuntu-16.04-64bit
  • ComputeCpp-CE-0.6.0-Ubuntu-16.04-64bit
  • ComputeCpp-CE-0.6.1-Ubuntu-16.04-64bit
  • ComputeCpp-CE-0.7.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-0.8.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-0.9.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-0.9.1-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.0.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.0.1-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.0.2-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.0.3-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.0.4-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.0.5-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.1-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.2-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.3-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.4-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.5-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.1.6-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.2.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-1.3.0-Ubuntu-16.04-x86_64
  • ComputeCpp-CE-2.0.0-x86_64-linux-gnu

SYCLCC Specific Commands

  • -syclcc-use-host : This tells the syclcc driver to use the host compiler rather than the SYCL compiler. Largely to work around the inability to easily swap between compilers within CMake build systems.

SYCLCC Enviornment Variables

    • HOST_CXX : Assign a host compiler to use in place of the SYCL compiler, it will default to g++ if unspecified.
    • SYCLCC_COMPUTECPP_BACKEND : This will be used as an argument to ComputeCpp's -sycl-target compiler command line option. The argument listing is the same. For example, spirv64, spir64, ptx64 etc. This allows you to swap between different SYCL backend targets to allow targeting different devices.
    • COMPUTECPP_DIR : point to a directory contianing ComputeCpp. The parent directory may contain multiple ComputeCpp versions to allow easy swapping between versions using the sycl-next/sycl-curr scripts.

Other Scripts

    • bsyclcc : A simple ComputeCpp compile recipe for use with newer versions of ComputeCpp, currently used by syclcc for ComputeCpp versions 1.2.0+
    • isyclcc - A driver script for Intel's DPC++ SYCL compiler, currently standalone and not integrated with syclcc.