Welcome to oneAPI Construction Kit’s documentation!

The documentation herein refers to version 4.0.0 of the oneAPI Construction Kit.

The heterogeneous language toolkit.

The oneAPI Construction Kit is a framework to provide implementations of open standards, such as OpenCL, for a wide range of devices. The oneAPI Construction Kit can be used to build with the oneAPI Toolkit. The oneAPI Toolkit includes support for various open standards, such as OpenMP, SYCL, and DPC++. DPC++ is based on the SYCL programming model, which allows to write single-source C++ code that can target both CPUs and GPUs. To get more information on oneAPI, please visit oneAPI.

Note

It is not intended to be used as a standalone OpenCL implementation. It does not support the oneAPI Level Zero API.

• oneAPI Construction Kit Overview
  • Preface
  • Introduction
    • oneAPI Construction Kit Architecture
    • Compiler View
  • Mapping ComputeMux to Hardware
    • Memory Requirements
    • Atomic Requirements
    • Floating-Point Requirements
    • Synchronization Requirements
  • Runtime Information
    • ComputeMux Runtime
    • Driver Requirements
    • Supported Toolchains
  • Compiler Information
    • ComputeMux Compiler
    • Intermediate Representation
    • Supported LLVM Versions
    • ComputeMux Compiler Non-Requirements
  • Example Hardware Feature Scenarios
    • Mapping Custom Instructions To Builtin Functions
    • Mapping Custom IP Blocks To Builtin Kernels
    • How To Support Large Scratchpad Memories
    • Mapping Algorithms To Vector Hardware
    • RefSi In-Kernel DMA for RISC-V
  • oneAPI Construction Kit
    • Abacus
  • Creating a New ComputeMux Target: Quick Start
    • Clik
    • HAL
    • Quick Start Process
  • Tutorials
    • Creating a New HAL
    • Creating a New ComputeMux Target
  • Codeplay Reference Silicon
    • Codeplay Reference Silicon Overview
    • Command Processor Reference
    • DMA Controller Reference
    • DMA Programming Guide
    • RefSi Driver Interface
    • How The Platform Maps to SYCL and OpenCL
• Getting Started
  • Platform Dependencies
    • Ubuntu 22.04
    • Ubuntu 24.04
    • Windows 10
    • Windows 11
    • SPIRV-Tools
• Specifications
  • Versioning Scheme
    • Deprecation Policy
  • ComputeMux Runtime Specification
    • Glossary
    • Introduction
    • Allocators
    • Callbacks
    • Devices
    • Executables
    • Descriptors
    • Kernels
    • Memory
    • Buffers
    • Images
    • Queries
    • Command Buffers
    • Fences
    • Semaphores
    • Queues
    • Execution Model
  • ComputeMux Compiler Specification
    • Glossary
    • Introduction
    • Cargo
    • Context
    • Info
    • Target
    • Module
    • Kernel
    • LLVM intermediate representation
    • Mangling
    • Builtins
    • Memory and Control Barriers
    • Atomics and Fences
    • Metadata
    • Function Attributes
• Developer Guide
  • Supported Software
  • Directory layout
  • Branches
  • Coding style
    • C++ Style
    • CMake Style
    • Python Style
  • Khronos OpenCL ICD
    • Linux Registration
    • Windows Registration
    • Android Registration
    • Building ICD From Source
  • CMake
    • CMake Flags
    • CMake Options
    • CMake Build Targets
  • Compiling
    • Compiling LLVM
    • Compiling LLVM-SPIRV
    • Compiling oneAPI Construction Kit
    • Compiling the oneAPI Construction Kit without LLVM
  • Cross-compiling
  • Cross-platform building LLVM and oneAPI Construction Kit for Linux
    • Cross-compiling LLVM
    • Cross-compiling the oneAPI Construction Kit
  • Testing
    • Testing OpenCL
    • Testing oneapi-construction-kit application examples using official Intel oneAPI Base Toolkit
  • Providing extra options
  • Debugging the LLVM compiler
    • -print-after-all (and -print-before-all)
    • -print-after=X (and -print-before=X)
    • -print-changed
    • -verify-each
    • -debug-pass-manager
    • -time-passes
    • Debugging passes with the muxc tool
  • Running with extra debug support
    • Extracting Kernels From Tests
  • Perf Support for Linux CPU kernels
  • Reducing Rebuild Times With ccache
  • Enhanced GDB Debugging
    • Pretty Printers
  • Tracer Guards
  • Benchmarking driver performance with Flamegraphs
• Tutorials
  • Adding A Custom Builtins Extension
    • Registering A New Compiler Extension
    • Builtin Replacement
    • Final Result
    • Lit Testing
  • Custom Lowering Work-Item Builtins
    • Scenario
    • Example #1
    • Example #2
    • Example #3
    • Other Approaches
  • Adding Target-Specific Metadata
    • Defining the metadata struct and handler
    • Define a Function Analysis
    • Register the pass
    • Reading back the metadata (mux side)
• Design
  • Project Structure
  • Modules
    • Builtins
    • ComputeMux Runtime
    • ComputeMux Compiler
    • Host
    • Vecz
    • Cargo
    • Serialization Format
• OpenCL
  • OpenCL CMake
    • Options
    • Modules
  • How OpenCL Concepts Are Mapped Onto ComputeMux
    • Programs and Kernels
    • Queues and Synchronization
    • Memory Objects
  • OpenCL Extensions
    • OpenCL C 1.2 - khr_opencl_c_1_2
    • Installable Client Driver (ICD) - cl_khr_icd
    • Kernel Debug - cl_codeplay_kernel_debug
    • Extra build options - cl_codeplay_extra_build_options
    • Kernel Exec Info - cl_codeplay_kernel_exec_info
    • Performance Counter - cl_codeplay_performance_counters
    • Soft Math - cl_codeplay_soft_math
    • Whole Function Vectorization - cl_codeplay_wfv
    • USM - cl_intel_unified_shared_memory
    • SPIR-V USM Generic Storage Class - SPV_codeplay_usm_generic_storage_class
    • Command-Buffers (Provisional) - cl_khr_command_buffer
    • Command Buffers: Mutable Dispatch - cl_khr_command_buffer_mutable_dispatch
    • Extended Async Copies - cl_khr_extended_async_copies
    • Required subgroup sizes for kernels - cl_intel_required_subgroup_size
  • OpenCL External Extensions
    • Tutorials
    • How to …
    • Explanation
    • Reference
  • OpenCL ICD Loader
  • OpenCL Intercept Layer
    • Configuration
    • Injection Testing
  • Tools
    • clc OpenCL Offline Kernel Compiler
    • oclc OpenCL-C Compiler and Intermediate State Kernel Inspector
  • Tests
    • UnitCL
  • Supported Features and Implementation Details
  • Data Types
    • Scalar Data Types
    • Vector Data Types
  • Platform Info
  • Device Info
    • Profiles
  • Program Compilation
    • clCreateProgramWithSource
    • clCreateProgramWithBinary
    • clCreateProgramWithBuiltInKernels
    • clCompileProgram
    • clLinkProgram
    • clBuildProgram
    • clGetProgramInfo
    • clGetProgramBuildInfo
  • Image Support
  • Debugging OpenCL kernels
    • Build flags
    • Viewing kernel source in the debugger
    • LLDB sample session
    • GDB sample session
  • Deprecated Entry Points
    • clGetExtensionFunctionAddress
    • clEnqueueWaitForEvents
    • clEnqueueBarrier
    • clEnqueueMarker
    • clUnloadCompiler
    • clCreateImage2D
    • clCreateImage3D
• Modules
  • Builtins
    • Abacus
    • Image Library
  • ComputeMux
    • Change Log
    • Compiler
    • CMake
    • Bumping the Specification Version
    • Dependencies
    • Integrating a Runtime Target
    • Capability CMake Details
    • Integrating a Compiler Target
    • Changes
  • Host CPU
    • cl_codeplay_host_builtins
    • cl_codeplay_set_threads
    • Host lit test suite
    • Host Debug Features
    • Host Device
    • Host Binaries
    • Host Scheduled Kernel
    • LLVM Passes
  • RISC-V
    • HAL
    • RISC-V standard function arguments
    • RISC-V Device
    • Environment Variables
    • RISC-V Binaries
    • Executable
    • Kernel Objects
    • Compilation
    • Processing commands
  • Compiler
    • Overview
    • Compiler Utilities
    • Tools
  • ELF loader
    • The steps to execute code in an ELF file
  • Vecz
    • Vecz Documentation
  • spirv-ll
    • Standalone Mode
    • Internal SPIR-V Extensions
    • External SPIR-V extensions
  • Debug Module
    • Debug Pass Instrumentations
    • Debug Backtrace
  • Cargo Module
    • CMake Options
  • Metadata API
    • Design
    • Hooks
    • Basic Usage
  • Creating a Module
    • Directory Layout
    • Code Layout
    • CMake
• API Reference
  • cl module
    • compiler module
    • extension module
  • cargo module
  • vecz module
  • builtins module
    • abacus
    • libimg
  • mux module
    • compiler::utils
    • host mux target
  • tracer module
• CMake Development
  • CA Modules
    • AddCA Module
    • Bin2H Module
    • CAOption Module
    • CAPlatform Module
    • ConfigureFileScript Module
    • Coverage Module
    • DetectLLVMMSVCCRT Module
    • Find Modules
    • Format Module
    • ImportLLVM Module
    • ReleaseAssert Module
    • Sanitizers Module
    • OpenCL CMake
    • ComputeMux CMake
  • Toolchain Files
  • Shared Library Naming and Versioning
  • Generator Expression Usage
• Scripts
  • Jenkins Scripts
    • Sanitizers
    • CTS Summary
  • Frameworks
    • City Runner
    • Linux Perf Support Script