menu_bookGuides

  1. arrow_forward
    Welcome to oneAPI Construction Kit’s documentation!
    1. subdirectory_arrow_right
      oneAPI Construction Kit Overview
      1. arrow_forward
        Preface
        1. subdirectory_arrow_right
          Introduction
          1. arrow_forward
            oneAPI Construction Kit Architecture
            1. arrow_forward
              Compiler View
            2. subdirectory_arrow_right
              Mapping ComputeMux to Hardware
              1. arrow_forward
                Memory Requirements
                1. arrow_forward
                  Atomic Requirements
                  1. arrow_forward
                    Floating-Point Requirements
                    1. arrow_forward
                      Synchronization Requirements
                    2. subdirectory_arrow_right
                      Runtime Information
                      1. arrow_forward
                        ComputeMux Runtime
                        1. arrow_forward
                          Driver Requirements
                          1. arrow_forward
                            Supported Toolchains
                          2. subdirectory_arrow_right
                            Compiler Information
                            1. arrow_forward
                              ComputeMux Compiler
                              1. arrow_forward
                                Intermediate Representation
                                1. arrow_forward
                                  Supported LLVM Versions
                                  1. arrow_forward
                                    ComputeMux Compiler Non-Requirements
                                  2. subdirectory_arrow_right
                                    Example Hardware Feature Scenarios
                                    1. arrow_forward
                                      Mapping Custom Instructions To Builtin Functions
                                      1. arrow_forward
                                        Mapping Custom IP Blocks To Builtin Kernels
                                        1. arrow_forward
                                          How To Support Large Scratchpad Memories
                                          1. arrow_forward
                                            Mapping Algorithms To Vector Hardware
                                            1. arrow_forward
                                              RefSi In-Kernel DMA for RISC-V
                                            2. arrow_forward
                                              oneAPI Construction Kit
                                              1. arrow_forward
                                                Creating a New ComputeMux Target: Quick Start
                                                1. subdirectory_arrow_right
                                                  Tutorials
                                                  1. subdirectory_arrow_right
                                                    Creating a New HAL
                                                    1. arrow_forward
                                                      Initial Setup
                                                      1. arrow_forward
                                                        Kernel Compilation
                                                        1. arrow_forward
                                                          Running clik Tests
                                                          1. arrow_forward
                                                            Overview of the Skeleton HAL Code
                                                            1. arrow_forward
                                                              Implementing HAL Operations
                                                            2. subdirectory_arrow_right
                                                              Creating a New ComputeMux Target
                                                              1. arrow_forward
                                                                Running the create_target.py Script
                                                                1. arrow_forward
                                                                  Building and Running Tests
                                                                  1. arrow_forward
                                                                    Adapting the Pass Pipeline for the Target
                                                                    1. arrow_forward
                                                                      Extending it Further
                                                                  2. subdirectory_arrow_right
                                                                    Codeplay Reference Silicon
                                                                    1. arrow_forward
                                                                      Codeplay Reference Silicon Overview
                                                                      1. arrow_forward
                                                                        Command Processor Reference
                                                                        1. arrow_forward
                                                                          DMA Controller Reference
                                                                          1. arrow_forward
                                                                            DMA Programming Guide
                                                                            1. arrow_forward
                                                                              RefSi Driver Interface
                                                                              1. arrow_forward
                                                                                How The Platform Maps to SYCL and OpenCL
                                                                            2. arrow_forward
                                                                              Getting Started
                                                                              1. subdirectory_arrow_right
                                                                                Specifications
                                                                                1. arrow_forward
                                                                                  Versioning Scheme
                                                                                  1. arrow_forward
                                                                                    ComputeMux Runtime Specification
                                                                                    1. arrow_forward
                                                                                      ComputeMux Compiler Specification
                                                                                    2. arrow_forward
                                                                                      Developer Guide
                                                                                      1. subdirectory_arrow_right
                                                                                        Tutorials
                                                                                        1. arrow_forward
                                                                                          Adding A Custom Builtins Extension
                                                                                          1. arrow_forward
                                                                                            Custom Lowering Work-Item Builtins
                                                                                            1. arrow_forward
                                                                                              Adding Target-Specific Metadata
                                                                                            2. arrow_forward
                                                                                              Design
                                                                                              1. subdirectory_arrow_right
                                                                                                OpenCL
                                                                                                1. arrow_forward
                                                                                                  OpenCL CMake
                                                                                                  1. arrow_forward
                                                                                                    How OpenCL Concepts Are Mapped Onto ComputeMux
                                                                                                    1. subdirectory_arrow_right
                                                                                                      OpenCL Extensions
                                                                                                      1. arrow_forward
                                                                                                        Kernel Debug - cl_codeplay_kernel_debug
                                                                                                        1. arrow_forward
                                                                                                          Extra Build Options - cl_codeplay_extra_build_options
                                                                                                          1. arrow_forward
                                                                                                            Kernel Exec Info - cl_codeplay_kernel_exec_info
                                                                                                            1. arrow_forward
                                                                                                              Performance Counters - cl_codeplay_performance_counters
                                                                                                              1. arrow_forward
                                                                                                                Program Snapshot - cl_codeplay_program_snapshot
                                                                                                                1. arrow_forward
                                                                                                                  Soft Math - cl_codeplay_soft_math
                                                                                                                  1. arrow_forward
                                                                                                                    Whole Function Vectorization - cl_codeplay_wfv
                                                                                                                    1. arrow_forward
                                                                                                                      USM - cl_intel_unified_shared_memory
                                                                                                                    2. arrow_forward
                                                                                                                      OpenCL External Extensions
                                                                                                                      1. arrow_forward
                                                                                                                        OpenCL ICD Loader
                                                                                                                        1. arrow_forward
                                                                                                                          OpenCL Intercept Layer
                                                                                                                          1. arrow_forward
                                                                                                                            Tools
                                                                                                                            1. subdirectory_arrow_right
                                                                                                                              Tests
                                                                                                                              1. arrow_forward
                                                                                                                                UnitCL
                                                                                                                            2. arrow_forward
                                                                                                                              Vulkan
                                                                                                                              1. subdirectory_arrow_right
                                                                                                                                Modules
                                                                                                                                1. subdirectory_arrow_right
                                                                                                                                  Builtins
                                                                                                                                  1. arrow_forward
                                                                                                                                    Abacus
                                                                                                                                    1. arrow_forward
                                                                                                                                      Image Library
                                                                                                                                    2. subdirectory_arrow_right
                                                                                                                                      ComputeMux
                                                                                                                                      1. arrow_forward
                                                                                                                                        Change Log
                                                                                                                                        1. arrow_forward
                                                                                                                                          Compiler
                                                                                                                                          1. arrow_forward
                                                                                                                                            CMake
                                                                                                                                            1. arrow_forward
                                                                                                                                              Bumping the Specification Version
                                                                                                                                            2. subdirectory_arrow_right
                                                                                                                                              Host CPU
                                                                                                                                              1. arrow_forward
                                                                                                                                                cl_codeplay_host_builtins
                                                                                                                                                1. arrow_forward
                                                                                                                                                  cl_codeplay_set_threads
                                                                                                                                                  1. arrow_forward
                                                                                                                                                    Host lit test suite
                                                                                                                                                    1. arrow_forward
                                                                                                                                                      Host Debug Features
                                                                                                                                                    2. arrow_forward
                                                                                                                                                      RISC-V
                                                                                                                                                      1. subdirectory_arrow_right
                                                                                                                                                        Compiler
                                                                                                                                                        1. arrow_forward
                                                                                                                                                          Overview
                                                                                                                                                          1. arrow_forward
                                                                                                                                                            Compiler Utilities
                                                                                                                                                            1. subdirectory_arrow_right
                                                                                                                                                              Tools
                                                                                                                                                              1. arrow_forward
                                                                                                                                                                muxc
                                                                                                                                                            2. arrow_forward
                                                                                                                                                              ELF loader
                                                                                                                                                              1. subdirectory_arrow_right
                                                                                                                                                                Vecz
                                                                                                                                                                1. arrow_forward
                                                                                                                                                                  Vecz Documentation
                                                                                                                                                                  1. arrow_forward
                                                                                                                                                                    Vecz Coding Guidelines
                                                                                                                                                                  2. arrow_forward
                                                                                                                                                                    spirv-ll
                                                                                                                                                                    1. arrow_forward
                                                                                                                                                                      Debug Module
                                                                                                                                                                      1. arrow_forward
                                                                                                                                                                        Cargo Module
                                                                                                                                                                        1. arrow_forward
                                                                                                                                                                          Metadata API
                                                                                                                                                                        2. arrow_forward
                                                                                                                                                                          API Reference
                                                                                                                                                                          1. arrow_forward
                                                                                                                                                                            CMake Development
                                                                                                                                                                            1. arrow_forward
                                                                                                                                                                              Scripts
                                                                                                                                                                              info
                                                                                                                                                                              Please note that you are viewing a guide targeting an older version of oneAPI Construction Kit. This guide was designed for version 2.0.0.

                                                                                                                                                                              API Reference

                                                                                                                                                                              Here you will find documentation generated from the oneAPI Construction Kit’s source code.

                                                                                                                                                                              cl module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “cl” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              compiler module

                                                                                                                                                                              link

                                                                                                                                                                              The OpenCL C frontend compiler and a set of LLVM passes to transform the generated LLVM IR before hand off to mux are contained in the compiler module.

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “cl_compiler” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              extension module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “cl_extension” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              cargo module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “cargo” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              vecz module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “vecz” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              builtins module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “builtins” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus

                                                                                                                                                                              link

                                                                                                                                                                              abacus cast

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_cast” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus common

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_common” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus config

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_config” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus extra

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_extra” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus geometric

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_geometric” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus integer

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_integer” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus math

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_math” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus memory

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_memory” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus misc

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_misc” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus relational

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_relational” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              abacus type traits

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “abacus_type_traits” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              libimg

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “libimg” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              mux module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “mux” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              compiler::utils

                                                                                                                                                                              link

                                                                                                                                                                              A set of C++ utilities are provides along side mux, whilst it is not required to make use of them they prove useful when implementing and maintaining an implementation of the API for a specific device.

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “utils” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              host mux target

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “host” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              tracer module

                                                                                                                                                                              link

                                                                                                                                                                              Warning

                                                                                                                                                                              doxygengroup: Cannot find group “tracer” in doxygen xml output for project “ComputeAorta” from directory: /builds/webservices/oneapi-construction-kit-documentation-sync/oneapi-construction-kit/build_doc/doc/doxygen/xml

                                                                                                                                                                              Select a Product

                                                                                                                                                                              Please select a product

                                                                                                                                                                              oneAPI

                                                                                                                                                                              oneAPI is a cross-industry, open, standards-based unified programming model that delivers a common developer experience across accelerator architecture - for faster application performance, more productivity, and greater innovation.

                                                                                                                                                                              Dark Mode
                                                                                                                                                                              brightness_2

                                                                                                                                                                              Dark Mode

                                                                                                                                                                              Light text on a dark background.

                                                                                                                                                                              Light Mode
                                                                                                                                                                              lightbulb_outline

                                                                                                                                                                              Light Mode

                                                                                                                                                                              Dark text on a light background.

                                                                                                                                                                              public

                                                                                                                                                                              Also,

                                                                                                                                                                              part of our network

                                                                                                                                                                              search
                                                                                                                                                                              No results found, please try another search term.
                                                                                                                                                                              sync
                                                                                                                                                                              Searching, Please Wait...

                                                                                                                                                                              Please type to begin searching or try these:


                                                                                                                                                                              • oneapi nvidia
                                                                                                                                                                              • cl::sycl
                                                                                                                                                                              • 2.5.0
                                                                                                                                                                              • download oneapi amd
                                                                                                                                                                              • getting started guide
                                                                                                                                                                              • construction kit
                                                                                                                                                                              Tip: Press 'enter' key to select first result.
                                                                                                                                                                              There was a problem searching, please try again later.