8f5a2f0ae8
* Initial command-buffer tests Introduce some basic testing of the [cl_khr_command_buffer](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_Ext.html#cl_khr_command_buffer) extension. This is intended as a starting point from which we can iteratively build up tests for the extension collaboratively. * Move tests into derived classes * Move tests from methods into derived classes implementing a `Run()` interface. * Fix memory leak when command_buffer isn't freed when a test is skipped. * Print correct error code for `CL_DEVICE_COMMAND_BUFFER_CAPABILITIES_KHR` * Pass `nullptr` for queue parameter to command recording entry-points * Define command-buffer type wrapper Other OpenCL object have a wrapper to reference count their use and free the wrapped object. The command-buffer object can't use the generic type wrappers which are templated on the appropriate release/retain function, as the release/retain functions are queried at runtime. Instead, define our own command-buffer wrapper class where a base object is passed on construction which contains function pointers to the release/retain functions that can be used in the wrapper. * Use create_single_kernel_helper_create_program Use `create_single_kernel_helper_create_program` rather than hardcoding `clCreateProgramWithSource` to allow for other types of program input. Also fix bug using wrong enum for passing properties on command-buffer creation, should be `CL_COMMAND_BUFFER_FLAGS_KHR` * Add out-of-order command-buffer test Introduce a basic test for checking sync-point use with out-of-order command-buffers. This also includes better checking of required queue properties.
OpenCL Conformance Test Suite (CTS)
This it the OpenCL CTS for all versions of the Khronos OpenCL standard.
Building the CTS
The CTS supports Linux, Windows, macOS, and Android platforms. In particular, GitHub Actions CI builds against Ubuntu 20.04, Windows-latest, and macos-latest.
Compiling the CTS requires the following CMake configuration options to be set:
CL_INCLUDE_DIRPoints to the unified OpenCL-Headers.CL_LIB_DIRDirectory containing the OpenCL library to build against.OPENCL_LIBRARIESName of the OpenCL library to link.
It is advised that the OpenCL ICD-Loader
is used as the OpenCL library to build against. Where CL_LIB_DIR points to a
build of the ICD loader and OPENCL_LIBRARIES is "OpenCL".
Example Build
Steps on a Linux platform to clone dependencies from GitHub sources, configure a build, and compile.
git clone https://github.com/KhronosGroup/OpenCL-CTS.git
git clone https://github.com/KhronosGroup/OpenCL-Headers.git
git clone https://github.com/KhronosGroup/OpenCL-ICD-Loader.git
mkdir OpenCL-ICD-Loader/build
cmake -S OpenCL-ICD-Loader -B OpenCL-ICD-Loader/build \
-DOPENCL_ICD_LOADER_HEADERS_DIR=$PWD/OpenCL-Headers
cmake --build ./OpenCL-ICD-Loader/build --config Release
mkdir OpenCL-CTS/build
cmake -S OpenCL-CTS -B OpenCL-CTS/build \
-DCL_INCLUDE_DIR=$PWD/OpenCL-Headers \
-DCL_LIB_DIR=$PWD/OpenCL-ICD-Loader/build \
-DOPENCL_LIBRARIES=OpenCL
cmake --build OpenCL-CTS/build --config Release
Running the CTS
A build of the CTS contains multiple executables representing the directories in
the test_conformance folder. Each of these executables contains sub-tests, and
possibly smaller granularities of testing within the sub-tests.
See the --help output on each executable for the list of sub-tests available,
as well as other options for configuring execution.
If the OpenCL library built against is the ICD Loader, and the vendor library to be tested is not registered in the default ICD Loader location then the OCL_ICD_FILENAMES environment variable will need to be set for the ICD Loader to detect the OpenCL library to use at runtime. For example, to run the basic tests on a Linux platform:
OCL_ICD_FILENAMES=/path/to/vendor_lib.so ./test_basic
Offline Compilation
Testing OpenCL drivers which do not have a runtime compiler can be done by using additional command line arguments provided by the test harness for tests which require compilation, these are:
-
--compilation-modeSelects if OpenCL-C source code should be compiled using an external tool before being passed on to the OpenCL driver in that form for testing. Online is the default mode, but also accepts the valuesspir-v, andbinary. -
--compilation-cache-modeControls how the compiled OpenCL-C source code should be cached on disk. -
--compilation-cache-pathAccepts a path to a directory where the compiled binary cache should be stored on disk. -
--compilation-programAccepts a path to an executable (default: cl_offline_compiler) invoked by the test harness to perform offline compilation of OpenCL-C source code. This executable must match the interface description.
Generating a Conformance Report
The Khronos Conformance Process Document details the steps required for a conformance submissions. In this repository opencl_conformance_tests_full.csv defines the full list of tests which must be run for conformance. The output log of which must be included alongside a filled in submission details template.
Utility script run_conformance.py can be used to help generating the submission log, although it is not required.
Git tags are used to define the version of the repository conformance submissions are made against.
Contributing
Contributions are welcome to the project from Khronos members and non-members alike via GitHub Pull Requests (PR). Alternatively, if you've found a bug or have a questions please file an issue in the GitHub project. First time contributors will be required to sign the Khronos Contributor License Agreement (CLA) before their PR can be merged.
PRs to the repository are required to be clang-format clean to pass CI.
Developers can either use the git-clang-format tool locally to verify this
before contributing, or update their PR based on the diff provided by a failing
CI job.