Note
For those who intend to make a contribution to the project please read our Contribution Guide for more information.
This repo contains the following:
- API specification in YaML
- API programming guide in RST
- Loader and a null adapter implementation (partially generated)
- Example applications
- API C/C++ header files (generated)
- API Python module (generated)
- Sample C++ wrapper (generated)
- Sample C/C++ import library (generated)
The recommended way to integrate this project into another is via CMake's FetchContent, for example:
include(FetchContent)
FetchContent_Declare(
unified-runtime
GIT_REPOSITORY https://github.com/oneapi-src/unified-runtime.git
GIT_TAG main # This will pull the latest changes from the main branch.
)
FetchContent_MakeAvailable(unified-runtime)
add_executable(example example.cpp)
target_link_libraries(example PUBLIC unified-runtime::headers)Each Friday at 23:00 UTC time a prerelease
tag is created which
takes the form weekly-YYYY-MM-DD. These tags should be used by downstream
projects which intend to track development closely but maintain a fixed point in
history to avoid pulling potentially breaking changes from the main branch.
Code is generated using included Python scripts.
Documentation is generated from source code using Sphinx.
Tools can be acquired via instructions in third_party.
Requirements:
- C++ compiler with C++17 support
- cmake >= 3.14.0
- clang-format-15.0 (can be installed with
python -m pip install clang-format==15.0.7)
Project is defined using CMake.
Windows:
Generating Visual Studio Project. EXE and binaries will be in build/bin/{build_config}
$ mkdir build
$ cd build
$ cmake {path_to_source_dir} -G "Visual Studio 15 2017 Win64"
Linux:
Executable and binaries will be in build/bin
$ mkdir build
$ cd build
$ cmake {path_to_source_dir}
$ make
List of options provided by CMake:
| Name | Description | Values | Default |
|---|---|---|---|
| UR_BUILD_TESTS | Build the tests | ON/OFF | ON |
| UR_FORMAT_CPP_STYLE | Format code style | ON/OFF | OFF |
| UR_DEVELOPER_MODE | Treat warnings as errors and enables additional checks | ON/OFF | OFF |
| UR_USE_ASAN | Enable AddressSanitizer | ON/OFF | OFF |
| UR_USE_UBSAN | Enable UndefinedBehavior Sanitizer | ON/OFF | OFF |
| UR_USE_MSAN | Enable MemorySanitizer (clang only) | ON/OFF | OFF |
| UR_ENABLE_TRACING | Enable XPTI-based tracing layer | ON/OFF | OFF |
| UR_BUILD_TOOLS | Build tools | ON/OFF | ON |
General:
To run automated code formatting build with option UR_FORMAT_CPP_STYLE and then run a custom cppformat target:
$ make cppformat
If you've made modifications to the specification, you can also run a custom generate-code or generate target prior to building.
This call will generate the source code:
$ make generate-code
This call will generate the source code and run automated code formatting:
$ make generate
Note: generate target requires UR_FORMAT_CPP_STYLE to bet set.
To maintain consistency and clarity in naming adapter libraries, it is recommended to use the following naming convention:
- On Linux platforms, use
libur_adapter_[name].so. - On Windows platforms, use
ur_adapter_[name].dll.