Skip to content

Latest commit

 

History

History
168 lines (128 loc) · 5.87 KB

README.md

File metadata and controls

168 lines (128 loc) · 5.87 KB
Raw

Table of contents

Overview

This directory contains SYCL-related tests distributed in subdirectories based on testing scope.

Prerequisites

  • DPC++ compiler. Can be built following these instructions or taken prebuilt from releases.
  • LIT tools (llvm-lit, llvm-size). They are not available at prebuilts above, but can be built in compiler project (e.g. with "ninja check").
  • Target runtime(s) to execute tests on devices other than host. See installation instructions

Build and run tests

Get sources

git clone https://github.com/intel/llvm-test-suite
cd llvm-test-suite
mkdir build
cd build

With compiler tools available in the PATH:

# Configure
cmake \
 -DCMAKE_CXX_COMPILER=clang++ \
 -DTEST_SUITE_SUBDIRS=SYCL \
 -DCHECK_SYCL_ALL="opencl:host" \
 ..

# Build and Run
make check-sycl-all

To use ninja build run as:

# Configure
cmake -G Ninja ...

# Build and Run
ninja check-sycl-all

Cmake parameters

These parameters can be used to configure tests:

CMAKE_CXX_COMPILER path DPCPP compiler

TEST_SUITE_LLVM_SIZE path to llvm-size tool, required for code size collection

TEST_SUITE_COLLECT_COMPILE_TIME=OFF can be used to turn off compile time collection

TEST_SUITE_COLLECT_CODE_SIZE=OFF can be used to turn off code size collection

TEST_SUITE_LIT path to llvm-lit tool

CHECK_SYCL_ALL defines selection of multiple SYCL backends with set of target devices per each to be tested iteratively. Value is semicolon-separated list of configurations. Each configuration includes backend separated from comma-separated list of target devices with colon. Example:

-DCHECK_SYCL_ALL="opencl:cpu,host;level_zero:gpu,host;cuda:gpu"

SYCL_BE SYCL backend to be used for testing. Supported values are:

  • opencl - for OpenCL backend;
  • cuda - for CUDA backend;
  • level_zero - Level Zero backend.

SYCL_TARGET_DEVICES comma separated list of target devices for testing. Default value is cpu,gpu,acc,host. Supported values are:

  • cpu - CPU device available in OpenCL backend only;
  • gpu - GPU device available in OpenCL, Level Zero and CUDA backends;
  • acc - FPGA emulator device available in OpenCL backend only;
  • host - SYCL Host device available with all backends.

OpenCL_LIBRARY path to OpenCL ICD loader library. OpenCL interoperability tests require OpenCL ICD loader to be linked with. For such tests OpenCL ICD loader library should be installed in the system or available at the full path specified by this variable.

LEVEL_ZERO_INCLUDE path to Level Zero headers.

LEVEL_ZERO_LIBS_DIR path to Level Zero libraries.

Special test categories

There are two special directories for extended testing. See documentation at:

Creating or modifying tests

LIT feature checks

Following features can be checked in tests to limit test execution to the specific environment via REQUIRES, UNSUPPORTED, etc. filters. For example if REQUIRES:sycl-ls specified, test will run only if sycl-ls tool is available. If UNSUPPORTED:sycl-ls specified, test will run only if sycl-ls tool is unavailable.

  • windows, linux - host OS;
  • cpu, gpu, host, accelerator - target device;
  • cuda, opencl, level_zero - target backend;
  • sycl-ls - sycl-ls tool availability;
  • cl_options - CL command line options recognized (or not) by compiler;
  • opencl_icd - OpenCL ICD loader availability;
  • aot_tool - Ahead-of-time compilation tools availability;
  • aoc, ocloc, opencl-aot - Specific AOT tool availability;
  • level_zero_dev_kit - Level_Zero headers and libraries availability;
  • gpu-intel-dg1 - Intel GPU DG1 availability;
  • dump_ir: - compiler can / cannot dump IR;

llvm-lit parameters

Following options can be passed to llvm-lit tool through --param option to configure specific single test execution in the command line:

  • dpcpp_compiler - full path to dpcpp compiler;
  • target_device - comma-separated list of target devices (cpu, gpu, acc, host);
  • sycl_be - SYCL backend to be used (opencl, level_zero, cuda);
  • dump_ir - if IR dumping is supported for compiler (True, False);
  • gpu-intel-dg1 - tells LIT infra that Intel GPU DG1 is present in the system. It is developer / CI infra responsibility to make sure that the device is available in the system. Tests requiring DG1 to run must use proper device selector to ensure that. Use SYCL_DEVICE_ALLOWLIST or SYCL_DEVICE_FILTER to get proper configuration (see EnvironmentVariables.md);
  • extra_environment - comma-separated list of variables with values to be added to test environment. Can be also set by LIT_EXTRA_ENVIRONMENT variable in cmake.
  • level_zero_include - directory containing Level_Zero native headers, can be also set by CMake variable LEVEL_ZERO_INCLUDE.
  • level_zero_libs_dir - directory containing Level_Zero native libraries, can be also set by CMake variable LEVEL_ZERO_LIBS_DIR.

Example:

llvm-lit --param target_devices=host,gpu --param sycl_be=level_zero \
         --param dpcpp_compiler=path/to/clang++ --param dump_ir=True \
         SYCL/External/RSBench