Merge from 'sycl' to 'sycl-web' (6 commits)

Author: iclsrc

.github/workflows/sycl-linux-run-tests.yml

@@ -37,7 +37,7 @@ on:
 
       repo_ref:
         type: string
-        required: True
+        required: False
         description: |
           Commit SHA or branch to checkout the intel/llvm repo.
       tests_ref:
@@ -60,9 +60,10 @@ on:
 
       e2e_binaries_artifact:
         description: |
-          Must be set if `e2e_testing_mode` is equal to `run-only` and the
-          artifact must exist. Can be set in other modes resulting in artifact
-          upload.
+          When set in modes other than `run-only` results in artifact upload.
+          For `run-only` mode, if specified, means downloading pre-built
+          binaries from the artifact, otherwise they are expected to be part of
+          the container.
         type: string
         default: ''
         required: False
@@ -156,6 +157,7 @@ on:
         type: choice
         options:
           - 'ghcr.io/intel/llvm/sycl_ubuntu2404_nightly:latest'
+          - 'ghcr.io/intel/llvm/sycl_prebuilt_tests:sycl-rel-6_2'
           - 'ghcr.io/intel/llvm/ubuntu2404_intel_drivers:alldeps'
       image_options:
         description: |
@@ -205,6 +207,7 @@ on:
         options:
           - "full"
           - "build-only"
+          - "run-only"
 
 permissions:
   contents: read

.github/workflows/sycl-prebuilt-e2e-container.yml

@@ -0,0 +1,118 @@
+name: Create container with pre-built tests
+
+# The purpose of this is to build E2E tests with the latest release toolchain
+# and then run them with the trunk SYCL RT (libsycl.so and friends) to verify
+# that ABI compatibility hasn't been broken.
+
+on:
+  workflow_dispatch:
+    inputs:
+      ref:
+        type: string
+        description: tag/sha
+        required: true
+        default:
+
+  push:
+    branches:
+    - sycl-rel-**
+
+permissions: read-all
+
+jobs:
+  build:
+    uses: ./.github/workflows/sycl-linux-build.yml
+    with:
+      build_ref: ${{ inputs.ref || github.sha }}
+      build_cache_root: "/__w/"
+
+      build_image: "ghcr.io/intel/llvm/sycl_ubuntu2404_nightly:latest"
+      cc: clang
+      cxx: clang++
+
+      changes: '[]'
+
+      toolchain_artifact: toolchain
+      toolchain_artifact_filename: toolchain.tar.zst
+      e2e_binaries_artifact: e2e_bin
+
+  # Couldn't make it work from inside the container, so have to use an extra job
+  # and pass an artifact.
+  docker:
+    runs-on: [Linux, build]
+    needs: build
+    permissions:
+      packages: write
+    if: always()
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            devops/
+
+      - name: Checkout E2E tests
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.sha }}
+          path: llvm
+          sparse-checkout: |
+              llvm/utils/lit
+              sycl/test-e2e
+      - name: Pack sources
+        run: |
+          tar -I 'zstd -9' -cf devops/e2e_sources.tar.zst -C ./llvm .
+
+      - name: Download toolchain
+        uses: actions/download-artifact@v4
+        with:
+          name: toolchain
+          path: devops/
+      - name: Download E2E binaries
+        uses: actions/download-artifact@v4
+        with:
+          name: e2e_bin
+          path: devops/
+
+
+      - name: Build container
+        uses: ./devops/actions/build_container
+        with:
+          push: true
+          file: release_tests_binaries
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          tags: |
+            ghcr.io/${{ github.repository }}/sycl_prebuilt_tests:${{ inputs.ref || github.ref_name }}
+
+  run-e2e:
+    # Ensure those tests can actually pass with the toolchain they were built
+    # with, otherwise testing compatibility with those binaries is pointless.
+    # This job should be aligned with how the image will be used in trunk CI.
+    #
+    # I'll start with just a single configuration, but this might be extended
+    # with a matrix in future (e.g., to run on cpu/CUDA/AMDGPU).
+    name: Run E2E tests with SYCL RT they were built with
+    runs-on: [Linux, pvc]
+    needs: [docker, build]
+    if: ${{ always() && !cancelled() && needs.build.outputs.build_conclusion == 'success' }}
+    container:
+      image: ghcr.io/${{ github.repository }}/sycl_prebuilt_tests:${{ inputs.ref || github.ref_name }}
+      options: -u 1001 --device=/dev/dri -v /dev/dri/by-path:/dev/dri/by-path --privileged --cap-add SYS_ADMIN
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            devops
+      - run: |
+          mkdir toolchain
+          tar -I 'zstd' -xf /sycl-prebuilt/toolchain.tar.zst -C toolchain
+          echo LD_LIBRARY_PATH=$PWD/toolchain/lib:$LD_LIBRARY_PATH >> $GITHUB_ENV
+          echo PATH=$PWD/toolchain/bin:$PATH >> $GITHUB_ENV
+      - run: |
+          sycl-ls
+      - name: Run E2E tests
+        uses: ./devops/actions/run-tests/e2e
+        timeout-minutes: 20
+        with:
+          testing_mode: run-only
+          target_devices: level_zero:gpu

devops/actions/run-tests/e2e/action.yml

@@ -24,26 +24,34 @@ runs:
   using: "composite"
   steps:
   - name: Checkout E2E tests
+    if: ${{ !(inputs.testing_mode == 'run-only' && inputs.binaries_artifact == '') }}
     uses: actions/checkout@v4
     with:
       path: llvm
       ref: ${{ inputs.ref || github.sha }}
       sparse-checkout: |
         llvm/utils/lit
         sycl/test-e2e
-
   - name: Download E2E Binaries
-    if: inputs.testing_mode == 'run-only'
+    if: ${{ inputs.testing_mode == 'run-only' && inputs.binaries_artifact != '' }}
     uses: actions/download-artifact@v4
     with:
       name: ${{ inputs.binaries_artifact }}
   - name: Extract E2E Binaries
-    if: inputs.testing_mode == 'run-only'
+    if: ${{ inputs.testing_mode == 'run-only' && inputs.binaries_artifact != '' }}
     shell: bash
     run: |
       mkdir build-e2e
       tar -I 'zstd' -xf e2e_binaries.tar.zst -C build-e2e
 
+  - name: Extract E2E tests from container image
+    if: ${{ inputs.testing_mode == 'run-only' && inputs.binaries_artifact == '' }}
+    shell: bash
+    run: |
+      mkdir build-e2e llvm
+      tar -I 'zstd' -xf /sycl-prebuilt/e2e_binaries.tar.zst -C build-e2e
+      tar -I 'zstd' -xf /sycl-prebuilt/e2e_sources.tar.zst -C llvm
+
   - name: Deduce E2E CMake options
     if: inputs.testing_mode != 'run-only'
     id: cmake_opts

devops/containers/release_tests_binaries.Dockerfile

@@ -0,0 +1,28 @@
+ARG base_tag=alldeps
+ARG base_image=ghcr.io/intel/llvm/ubuntu2404_intel_drivers
+
+FROM $base_image:$base_tag
+
+# Actual CI maps volumes via something like "/runner/host/path":"/__w/", so
+# these won't be visible there. They can be used when manually reproducing
+# issues though. Path `/__w/llvm/llvm` is the property of Github Actions and
+# when CMake configures E2E tests this path is hardcoded in both CMake files and
+# e2e binaries themselve. As such, it's useful to have these in the image for
+# local manual experiments.
+#
+# One can map volumes as "/host/system/new/toolchain":"/__w/llvm/llvm/toolchain"
+# to override the toolchain in order to run the tests with local SYCL RT instead
+# of using the release RT included in this image.
+ADD --chown=sycl:sycl toolchain.tar.zst /__w/llvm/llvm/toolchain
+ADD --chown=sycl:sycl e2e_binaries.tar.zst /__w/llvm/llvm/build-e2e
+ADD --chown=sycl:sycl e2e_sources.tar.zst /__w/llvm/llvm/llvm
+
+# Since `/__w/llvm/llvm` above is overriden by GHA, need to provide the
+# following for using in CI:
+COPY e2e_binaries.tar.zst /sycl-prebuilt/
+COPY e2e_sources.tar.zst /sycl-prebuilt/
+COPY toolchain.tar.zst /sycl-prebuilt/
+
+COPY scripts/drivers_entrypoint.sh /drivers_entrypoint.sh
+
+USER sycl

llvm/lib/SYCLNativeCPUUtils/CMakeLists.txt

@@ -19,10 +19,6 @@ add_llvm_component_library(LLVMSYCLNativeCPUUtils
   ipo
   )
 
-set(OCK_SOURCE_DIR "" CACHE PATH "Root of the local checkout of the oneAPI Construction Kit")
-set(OCK_GIT_REPO "" CACHE STRING "Git repository for the oneAPI Construction Kit FetchContent")
-set(OCK_GIT_TAG "" CACHE STRING "Git tag for the oneAPI Construction Kit FetchContent")
-option(NATIVECPU_OCK_USE_FETCHCONTENT "Use FetchContent to acquire oneAPI Construction Kit source code" On)
 option(NATIVECPU_USE_OCK "Use the oneAPI Construction Kit for Native CPU" ON)
 
 # Don't fetch OCK if Native CPU is not enabled.
@@ -31,8 +27,16 @@ if(NOT "native_cpu" IN_LIST SYCL_ENABLE_BACKENDS)
 endif()
 
 if(NATIVECPU_USE_OCK)
-  if(NATIVECPU_OCK_USE_FETCHCONTENT)
-    set(OCK_GIT_INTERNAL_REPO "https://github.com/uxlfoundation/oneapi-construction-kit.git")
+  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]>
@@ -41,39 +45,31 @@ if(NATIVECPU_USE_OCK)
     #     Merge pull request #878 from hvdijk/specify-fuse-ld-lld
     #     
     #     [RefSi] Explicitly specify -fuse-ld=lld.
-    set(OCK_GIT_INTERNAL_TAG d0a32d701e34b3285de7ce776ea36abfec673df7)
-
-    # Overwrite OCK_GIT_INTERNAL_REPO/OCK_GIT_INTERNAL_TAG if the corresponding options are set
-    if(OCK_GIT_REPO)
-      set(OCK_GIT_INTERNAL_REPO "${OCK_GIT_REPO}")
-    endif()
-    if(OCK_GIT_TAG)
-      set(OCK_GIT_INTERNAL_TAG "${OCK_GIT_TAG}")
-    endif()
+    set(OCK_GIT_TAG d0a32d701e34b3285de7ce776ea36abfec673df7)
+   
     include(FetchContent)
     FetchContent_Declare(oneapi-ck
-     GIT_REPOSITORY "${OCK_GIT_INTERNAL_REPO}"
-     GIT_TAG "${OCK_GIT_INTERNAL_TAG}"
+     GIT_REPOSITORY "${OCK_GIT_REPO}"
+     GIT_TAG "${OCK_GIT_TAG}"
     )
     FetchContent_GetProperties(oneapi-ck)
     if(NOT oneapi-ck_POPULATED)
-      message(STATUS "Cloning oneAPI Construction Kit from ${OCK_GIT_INTERNAL_REPO}, tag ${OCK_GIT_INTERNAL_TAG}")
+      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_INTERNAL ${oneapi-ck_SOURCE_DIR}/compiler_passes)
-      set(OCK_BINARY_DIR_INTERNAL ${oneapi-ck_BINARY_DIR})
+      set(OCK_SOURCE_DIR ${oneapi-ck_SOURCE_DIR}/compiler_passes)
+      set(OCK_BINARY_DIR ${oneapi-ck_BINARY_DIR})
     endif()
-  elseif(OCK_SOURCE_DIR)
-    set(OCK_SOURCE_DIR_INTERNAL "${OCK_SOURCE_DIR}/compiler_passes")
-    set(OCK_BINARY_DIR_INTERNAL "${CMAKE_CURRENT_BINARY_DIR}/oneapi-construction-kit")
-  else()
-    message(FATAL_ERROR "NATIVECPU_OCK_USE_FETCHCONTENT is Off and OCK_SOURCE_DIR not set")
   endif()
 
   set(CA_ENABLE_API "cl" CACHE STRING "" FORCE)
   add_subdirectory(
-    ${OCK_SOURCE_DIR_INTERNAL}
-    ${OCK_BINARY_DIR_INTERNAL} EXCLUDE_FROM_ALL)
+    ${OCK_SOURCE_DIR}
+    ${OCK_BINARY_DIR} EXCLUDE_FROM_ALL)
 
   install(TARGETS compiler-pipeline
   EXPORT;LLVMExports

opencl/CMakeLists.txt

@@ -11,71 +11,12 @@ if (MSVC)
   )
 endif()
 
-# Repo URLs
-
-set(OCL_HEADERS_REPO
-  "https://github.com/KhronosGroup/OpenCL-Headers.git")
-set(OCL_LOADER_REPO
-  "https://github.com/KhronosGroup/OpenCL-ICD-Loader.git")
-
-# Repo tags/hashes
-
-set(OCL_HEADERS_TAG 6eabe90aa7b6cff9c67800a2fe25a0cd88d8b749)
-set(OCL_LOADER_TAG ddf6c70230a79cdb8fcccfd3c775b09e6820f42e)
-
-# OpenCL Headers
-if(NOT OpenCL_HEADERS)
-  message(STATUS "Will fetch OpenCL headers from ${OCL_HEADERS_REPO}")
-
-  FetchContent_Declare(ocl-headers
-    GIT_REPOSITORY    ${OCL_HEADERS_REPO}
-    GIT_TAG           ${OCL_HEADERS_TAG}
-  )
-else()
-  message(STATUS "OpenCL headers are added manually ${OpenCL_HEADERS}")
-
-  FetchContent_Declare(ocl-headers
-    URL               ${OpenCL_HEADERS}
-  )
-endif()
-
-FetchContent_MakeAvailable(ocl-headers)
-FetchContent_GetProperties(ocl-headers)
-set(OpenCL_INCLUDE_DIR
-  ${ocl-headers_SOURCE_DIR} CACHE PATH "Path to OpenCL Headers")
-
-target_compile_definitions(Headers INTERFACE -DCL_TARGET_OPENCL_VERSION=300)
-add_library(OpenCL-Headers ALIAS Headers)
-
-# OpenCL Library (ICD Loader)
-
-# Set OPENCL_ICD_LOADER_HEADERS_DIR, as prerequisite for ICD build
-set(OPENCL_ICD_LOADER_HEADERS_DIR
-  ${OpenCL_INCLUDE_DIR} CACHE PATH "Path to OpenCL Headers")
-
 # LLVM build sets this OFF by default, but we need OpenCL to be built as shared
 # library.
 set(BUILD_SHARED_LIBS ON)
 
-if(NOT OpenCL_LIBRARY_SRC)
-  message(STATUS "Will fetch OpenCL ICD Loader from ${OCL_LOADER_REPO}")
-
-  FetchContent_Declare(ocl-icd
-    GIT_REPOSITORY    ${OCL_LOADER_REPO}
-    GIT_TAG           ${OCL_LOADER_TAG}
-  )
-else()
-  # TODO: add possibility to use prebuilt OpenCL library rather than building
-  #       together with llvm.
-  message(STATUS
-    "OpenCL ICD Loader sources added manually ${OpenCL_LIBRARY_SRC}")
-
-  FetchContent_Declare(ocl-icd
-    URL               ${OpenCL_LIBRARY_SRC}
-  )
-endif()
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/../unified-runtime/cmake")
 
-FetchContent_MakeAvailable(ocl-icd)
-add_library(OpenCL-ICD ALIAS OpenCL)
+include(FetchOpenCL)
 
 add_subdirectory(opencl-aot)

opencl/opencl-aot/CMakeLists.txt

@@ -25,4 +25,4 @@ endif()
 target_link_libraries(${OPENCL_AOT_PROJECT_NAME}
   PRIVATE
     OpenCL-Headers
-    OpenCL-ICD)
+    ${OpenCL_LIBRARY})