[NATIVE_CPU][SYCL] Switch to using native_cpu compiler pipeline inline instead of OCK fetchContent

.github/workflows/sycl-linux-build.yml

@@ -202,8 +202,7 @@ jobs:
           --ci-defaults ${{ inputs.build_configure_extra_args }} \
           -DCMAKE_C_COMPILER_LAUNCHER=ccache \
           -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-          -DLLVM_INSTALL_UTILS=ON \
-          -DNATIVECPU_USE_OCK=Off
+          -DLLVM_INSTALL_UTILS=ON
     - name: Compile
       id: build
       # Emulate default value for manual dispatch as we've run out of available arguments.

llvm/lib/SYCLNativeCPUUtils/CMakeLists.txt

@@ -1,3 +1,16 @@
+set(OCK_LIBS)
+option(NATIVECPU_USE_OCK "Use the oneAPI Construction Kit for Native CPU" ON)
+
+# Don't use OCK compiler_passes if Native CPU is not enabled.
+if(NOT "native_cpu" IN_LIST SYCL_ENABLE_BACKENDS)
+  set(NATIVECPU_USE_OCK Off CACHE BOOL "Use the oneAPI Construction Kit for Native CPU" FORCE)
+endif()
+
+if(NATIVECPU_USE_OCK)
+  add_subdirectory(compiler_passes EXCLUDE_FROM_ALL)
+  set(OCK_LIBS NativeCPUPipeline NativeCPUVecz)
+endif()
+
 add_llvm_component_library(LLVMSYCLNativeCPUUtils
   PipelineSYCLNativeCPU.cpp
   PrepareSYCLNativeCPU.cpp
@@ -17,80 +30,13 @@ add_llvm_component_library(LLVMSYCLNativeCPUUtils
   TargetParser
   TransformUtils
   ipo
-  )
+  ${OCK_LIBS}
+)
 
-option(NATIVECPU_USE_OCK "Use the oneAPI Construction Kit for Native CPU" ON)
-
-# Don't fetch OCK if Native CPU is not enabled.
-if(NOT "native_cpu" IN_LIST SYCL_ENABLE_BACKENDS)
-  set(NATIVECPU_USE_OCK Off CACHE BOOL "Use the oneAPI Construction Kit for Native CPU" FORCE)
-endif()
 
 if(NATIVECPU_USE_OCK)
-  set(OCK_SEARCH_LOC "oneapi-construction-kit/compiler_passes")
-  if(NOT FETCHCONTENT_SOURCE_DIR_ONEAPI-CK)
-    find_path(OCK_SOURCE_DIR ${OCK_SEARCH_LOC} PATHS ${CMAKE_PREFIX_PATH})
-  endif()
-  if(OCK_SOURCE_DIR)
-    message(STATUS "Found system source location of oneAPI Construction Kit in ${OCK_SOURCE_DIR}")
-    set(OCK_SOURCE_DIR "${OCK_SOURCE_DIR}/${OCK_SEARCH_LOC}")
-    set(OCK_BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/oneapi-construction-kit")
-  else()
-    set(OCK_GIT_REPO "https://github.com/uxlfoundation/oneapi-construction-kit.git")
-    # commit d0a32d701e34b3285de7ce776ea36abfec673df7
-    # Merge: a9f848e0e8 56473a8c25
-    # Author: Harald van Dijk <[email protected]>
-    # Date:   Mon Jun 30 12:24:46 2025 +0100
-    # 
-    #     Merge pull request #878 from hvdijk/specify-fuse-ld-lld
-    #     
-    #     [RefSi] Explicitly specify -fuse-ld=lld.
-    set(OCK_GIT_TAG d0a32d701e34b3285de7ce776ea36abfec673df7)
-
-    include(FetchContent)
-    FetchContent_Declare(oneapi-ck
-     GIT_REPOSITORY "${OCK_GIT_REPO}"
-     GIT_TAG "${OCK_GIT_TAG}"
-    )
-    FetchContent_GetProperties(oneapi-ck)
-    if(NOT oneapi-ck_POPULATED)
-      if(FETCHCONTENT_SOURCE_DIR_ONEAPI-CK)
-        message(STATUS "Using specified oneAPI Construction Kit repo location at ${FETCHCONTENT_SOURCE_DIR_ONEAPI-CK}")
-      else()
-        message(STATUS "Cloning oneAPI Construction Kit from ${OCK_GIT_REPO}, tag ${OCK_GIT_TAG}")
-      endif()
-      FetchContent_Populate(oneapi-ck)
-      message(STATUS "oneAPI Construction Kit cloned in ${oneapi-ck_SOURCE_DIR}")
-      set(OCK_SOURCE_DIR ${oneapi-ck_SOURCE_DIR}/compiler_passes)
-      set(OCK_BINARY_DIR ${oneapi-ck_BINARY_DIR})
-    endif()
-  endif()
-
-  set(CA_ENABLE_API "cl" CACHE STRING "" FORCE)
-  add_subdirectory(
-    ${OCK_SOURCE_DIR}
-    ${OCK_BINARY_DIR} EXCLUDE_FROM_ALL)
-
-  install(TARGETS compiler-pipeline
-  EXPORT;LLVMExports
-          LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT compiler-pipeline
-          ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT compiler-pipeline
-          RUNTIME DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT compiler-pipeline)
-  set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS compiler-pipeline)
-  install(TARGETS vecz
-  EXPORT;LLVMExports
-          LIBRARY DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT vecz
-          ARCHIVE DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT vecz
-          RUNTIME DESTINATION lib${LLVM_LIBDIR_SUFFIX} COMPONENT vecz)
-  set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS vecz)
-  install(TARGETS multi_llvm EXPORT;LLVMExports)
-  set_property(GLOBAL APPEND PROPERTY LLVM_EXPORTS multi_llvm)
   target_compile_definitions(LLVMSYCLNativeCPUUtils PRIVATE  NATIVECPU_USE_OCK)
   target_include_directories(LLVMSYCLNativeCPUUtils PRIVATE 
-    ${oneapi-ck_SOURCE_DIR}/modules/compiler/multi_llvm/include
-    ${oneapi-ck_SOURCE_DIR}/modules/cargo/include
-    ${oneapi-ck_SOURCE_DIR}/modules/compiler/vecz/include
-    ${oneapi-ck_SOURCE_DIR}/modules/compiler/utils/include)
-  target_link_libraries(LLVMSYCLNativeCPUUtils PRIVATE compiler-pipeline vecz)
-
+    ${CMAKE_CURRENT_SOURCE_DIR}/compiler_passes/compiler_pipeline/include
+    ${CMAKE_CURRENT_SOURCE_DIR}/compiler_passes/vecz/include)
 endif()

llvm/lib/SYCLNativeCPUUtils/compiler_passes/CMakeLists.txt

@@ -0,0 +1,2 @@
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/compiler_pipeline)
+add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/vecz)

llvm/lib/SYCLNativeCPUUtils/compiler_passes/compiler_passes.rst

@@ -0,0 +1,63 @@
+Compiler passes
+===============
+
+Introduction
+------------
+
+Files under this directory are integrated from the `oneAPI Construction Kit`_
+using `git-filter-repo`. They are used by Native CPU to help create a pipeline for
+turning a base kernel into something which can be executed across multiple work
+items, including auto-vectorization.
+
+These files are largely from the sub-directories
+**modules/compiler/compiler_pipeline**, **modules/compiler/vecz** and
+**modules/compiler/multi_llvm**. Only files that are used have been integrated
+and the **CMake** files have been updated to fit in with LLVM components.
+
+These sub-directories are used as follows:
+
+* **compiler_pipeline** provides the passes to build a pipeline from the initial
+  kernel, including generating working item loops, handling local memory,
+  handling metadata and calling the vectorizer **vecz**.
+
+* **vecz** provides a full function vectorizer, which generates a copy of the
+  original function but vectorized across the work group, taking into account
+  subgroups.
+
+* **multi_llvm**. This provides some support for these functions to work across
+  multiple LLVM versions. Although this is not strictly needed in LLVM, it has
+  been integrated to allow the integration to go smoothly, without changing files
+  directly. Note this is header only and exists under
+  **compiler_pipeline/include/multi_llvm**.
+
+**compiler_pipeline** and **vecz** will be documented under `sycl/docs`. Note
+that there are several limitations in the code that are a result of the initial
+integration. These should be addressed over time for maintainability reasons,
+they are not necessary for correctness or performance reasons.
+
+General limitations
+-------------------
+
+To simplify the integration and reduce risk, most of the files were integrated
+with no changes at all. This means there are currently the following limitations:
+
+* The namespace in **compiler_pipeline** is **compiler/utils**, the namespace in
+  multi_llvm is **multi_llvm** and the namespace in **vecz** is **vecz**. These should
+  be updated to reflect being under **LLVM**.
+* include files should ideally be moved to under **llvm/include** but remain under
+  these directories after the integration.
+* **vecz** has a test tool **veczc** and associated **lit** tests. This tool if
+  required should be moved under **llvm/tools** or **llvm/test**. This is also
+  requires `NATIVE_CPU_BUILD_VECZ_TEST_TOOLS` **CMake** option to build. This can be
+  run using the target `check-sycl-vecz`.
+* **compiler_pipeline** has lit tests for the passes which have not been integrated.
+  This is because they use a tool **muxc**, but these passes should be
+  able to be tested using **opt**. These lit tests can be found in the
+  `pipeline pass tests`_.
+* There are many integrated files that are unlikely to have any code coverage but because
+  there are referred to in other files which we do need, they exist here. These
+  should be pruned over time as a better understanding is made of what is
+  essential.
+
+.. _oneAPI Construction Kit: https://github.com/uxlfoundation/oneapi-construction-kit
+.. _pipeline pass tests: https://github.com/uxlfoundation/oneapi-construction-kit/tree/main/modules/compiler/test/lit/passes

llvm/lib/SYCLNativeCPUUtils/compiler_passes/compiler_pipeline/CMakeLists.txt

@@ -0,0 +1,32 @@
+add_llvm_component_library(LLVMNativeCPUPipeline
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/attributes.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/barrier_regions.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/builtin_info.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/cl_builtin_info.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/define_mux_builtins_pass.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/dma.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/encode_kernel_metadata_pass.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/group_collective_helpers.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/mangling.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/metadata.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/mux_builtin_info.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/pass_functions.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/optimal_builtin_replacement_pass.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/pass_machinery.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/prepare_barriers_pass.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/replace_local_module_scope_variables_pass.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/scheduling.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/sub_group_analysis.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/target_extension_types.cpp
+  ${CMAKE_CURRENT_SOURCE_DIR}/source/work_item_loops_pass.cpp
+
+  LINK_COMPONENTS
+  Passes
+  Core
+  )
+
+# TODO: Move to under LLVM include and work out why ADDITIONAL_HEADER_DIRS
+# does not capture it.
+target_include_directories(LLVMNativeCPUPipeline PUBLIC
+$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+)

llvm/lib/SYCLNativeCPUUtils/compiler_passes/compiler_pipeline/include/compiler/utils/address_spaces.h

@@ -0,0 +1,38 @@
+// Copyright (C) Codeplay Software Limited
+//
+// Licensed under the Apache License, Version 2.0 (the "License") with LLVM
+// Exceptions; you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://github.com/uxlfoundation/oneapi-construction-kit/blob/main/LICENSE.txt
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+// License for the specific language governing permissions and limitations
+// under the License.
+//
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+/// @file
+///
+/// LLVM address space identifiers.
+
+#ifndef COMPILER_UTILS_ADDRESS_SPACES_H_INCLUDED
+#define COMPILER_UTILS_ADDRESS_SPACES_H_INCLUDED
+
+namespace compiler {
+namespace utils {
+namespace AddressSpace {
+enum {
+  Private = 0,
+  Global = 1,
+  Constant = 2,
+  Local = 3,
+  Generic = 4,
+};
+}
+} // namespace utils
+} // namespace compiler
+
+#endif // COMPILER_UTILS_ADDRESS_SPACES_H_INCLUDED