Merge branch 'main' into dbk-pr

Author: Henry Linjamäki

.github/workflows/build_full_cts.yml

@@ -7,8 +7,8 @@ permissions:
 on:
   workflow_dispatch:
   schedule:
-# at 14:01 every friday
-    - cron: '01 14 * * 5'
+# at 12:17 UTC every friday
+    - cron: '17 12 * * 5'
 
 jobs:
   cpu_cts:

.github/workflows/build_linux_gh.yml

@@ -107,7 +107,7 @@ jobs:
            sudo ln -s /opt/libjpeg-turbo/lib64 /opt/libjpeg-turbo/lib &&
            sudo ln -s /opt/onnx/lib /opt/onnx/lib64 &&
            sudo mv /opt/onnx/include /opt/onnxruntime && sudo mkdir /opt/onnx/include && sudo mv /opt/onnxruntime /opt/onnx/include/ &&
-           sudo bash -c 'mkdir /opt/source && cd /opt/source && git clone https://github.com/libxsmm/libxsmm.git && cd libxsmm && make -j3 STATIC=0 FORTRAN=0 AVX=2 install DESTDIR=/opt/xsmm'
+           sudo bash -c 'mkdir /opt/source && cd /opt/source && git clone https://github.com/libxsmm/libxsmm.git && cd libxsmm && echo "unstable-1.17.1" > version.txt && make -j3 STATIC=0 FORTRAN=0 AVX=2 install DESTDIR=/opt/xsmm'
 
       - name: CMake
         id: cmake

.github/workflows/build_mingw.yml

@@ -0,0 +1,134 @@
+---
+name: Windows / MinGW / CPU tests
+
+permissions:
+  contents: read
+
+on:
+  push:
+  workflow_dispatch:
+  pull_request:
+    paths-ignore:
+      - 'doc/**'
+      - 'CHANGES'
+      - 'COPYING'
+      - 'CREDITS'
+      - 'LICENSE'
+      - 'README.*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  mingw_test_matrix:
+    name: LLVM ${{ matrix.llvm_version }} - MinGW ${{ matrix.config }}
+    runs-on: windows-latest
+    defaults:
+      run:
+        shell: msys2 {0}
+    strategy:
+      fail-fast: false
+      matrix:
+        llvm_version: [18, 19]
+        config: [cpu]
+
+    steps:
+      - name: Setup MSYS2
+        uses: msys2/setup-msys2@d44ca8e88d8b43d56cf5670f91747359d5537f97 # v2.26.0
+        with:
+          msystem: MINGW64
+          update: true
+          install: >-
+            mingw-w64-x86_64-gcc
+            mingw-w64-x86_64-cmake
+            mingw-w64-x86_64-ninja
+            mingw-w64-x86_64-hwloc
+            mingw-w64-x86_64-pkg-config
+
+      - name: Checkout PoCL
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+
+      - name: Setup Build Environment
+        run: |
+          # Convert the Windows workspace path to an MSYS2 compatible one
+          WORKSPACE=$(cygpath -u "${{ github.workspace }}")
+          echo "WORKSPACE=${WORKSPACE}" >> $GITHUB_ENV
+
+      - name: Checkout LLVM
+        id: checkout-llvm
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          repository: llvm/llvm-project
+          ref: release/${{ matrix.llvm_version }}.x
+          path: llvm-project
+
+      - name: Restore Cached LLVM
+        id: cache-llvm
+        uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a
+        with:
+          path: install-llvm
+          key: llvm-mingw-${{ matrix.llvm_version }}-${{ runner.os }}
+
+      - if: ${{ steps.cache-llvm.outputs.cache-hit != 'true' }}
+        name: Configure LLVM
+        run: |
+          cmake -S llvm-project/llvm -B build-llvm \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DLLVM_ENABLE_PROJECTS=clang \
+            -DLLVM_TARGETS_TO_BUILD=host \
+            -DCMAKE_INSTALL_PREFIX=${{ env.WORKSPACE }}/install-llvm \
+            -DLLVM_BUILD_LLVM_DYLIB=ON \
+            -DLLVM_LINK_LLVM_DYLIB=ON \
+            -G "Ninja"
+        # XXX: DYLIBs are necessary to work around export ordinal overflows
+
+      - if: ${{ steps.cache-llvm.outputs.cache-hit != 'true' }}
+        name: Build LLVM
+        run: |
+          cmake --build build-llvm
+          cmake --install build-llvm
+
+      - if: ${{ steps.cache-llvm.outputs.cache-hit != 'true' }}
+        name: Save LLVM
+        uses: actions/cache/save@6849a6489940f00c2f30c0fb92c6274307ccb58a
+        with:
+          path: install-llvm
+          key: llvm-mingw-${{ matrix.llvm_version }}-${{ runner.os }}
+
+      - name: Load Env vars
+        id: load-env
+        run: |
+          cat ${{ env.WORKSPACE }}/.github/variables.txt >> $GITHUB_ENV
+
+      - name: Configure PoCL
+        run: |
+          cmake -S ${{ env.WORKSPACE }} -B ${{ env.WORKSPACE }}/build-pocl \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_INSTALL_PREFIX=${{ env.WORKSPACE }}/install-pocl \
+            -DWITH_LLVM_CONFIG=${{ env.WORKSPACE }}/install-llvm/bin/llvm-config.exe \
+            -DBUILD_SHARED_LIBS=OFF \
+            -DENABLE_ICD=OFF \
+            -DENABLE_LOADABLE_DRIVERS=OFF \
+            -G "Ninja"
+        # XXX: ENABLE_ICD=OFF because ocl-icd doesn't support Windows,
+        #      and PoCL doesn't support Khronos' ICD loader
+        # XXX: BUILD_SHARED_LIBS=OFF because the CI workers have OpenCL.dll
+        #      in System32 which takes preference over our version.
+        # XXX: ENABLE_LOADABLE_DRIVERS=OFF because PoCL doesn't know how to
+        #      find drivers when built with BUILD_SHARED_LIBS=OFF
+
+      - name: Build PoCL
+        run: |
+          cmake --build ${{ env.WORKSPACE }}/build-pocl
+
+      - name: Run Tests
+        env:
+          POCL_CACHE_DIR: "${{ runner.temp }}/GH_POCL_CACHE"
+        timeout-minutes: 120
+        run: |
+          rm -rf ${{ env.POCL_CACHE_DIR }}
+          mkdir -p ${{ env.POCL_CACHE_DIR }}
+          cd ${{ env.WORKSPACE }}/build-pocl
+          export PATH=${{ env.WORKSPACE }}/install-llvm/bin:$PATH
+          ${{ env.WORKSPACE }}/tools/scripts/run_cpu_tests mingw $CTEST_FLAGS -j$(nproc)

.github/workflows/build_msvc.yml

@@ -36,7 +36,7 @@ jobs:
 
     steps:
       - name: Checkout PoCL
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
 
       # Source MSVC tools. This is a known way to have the PoCL configuration
       # step to pick up MSVC compiler (cl.exe) instead of MinGW's gcc.
@@ -52,15 +52,15 @@ jobs:
       # packages doesn't include libraries or llvm-config.exe.
       - name: Checkout LLVM
         id: checkout-llvm
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
         with:
           repository: llvm/llvm-project
           ref: release/${{ matrix.llvm_version }}.x
           path: llvm-project
 
       - name: Restore Cached LLVM
         id: cache-llvm
-        uses: actions/cache@v4
+        uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a
         with:
           path: install-llvm\**
           key: llvm-${{ matrix.llvm_version }}-${{ runner.os }}-${{ steps.checkout-llvm.outputs.commit }}
@@ -85,7 +85,7 @@ jobs:
       # it in case a PoCL step fail ahead.
       - if: ${{ steps.cache-llvm.outputs.cache-hit != 'true' }}
         name: Save LLVM
-        uses: actions/cache/save@v4
+        uses: actions/cache/save@6849a6489940f00c2f30c0fb92c6274307ccb58a
         with:
           path: install-llvm\**
           key: llvm-${{ matrix.llvm_version }}-${{ runner.os }}-${{ steps.checkout-llvm.outputs.commit }}

.github/workflows/build_only.yml

@@ -40,8 +40,9 @@ jobs:
         # proxy - proxy driver
         # accel - almaif driver
         # no_llvm_no_debug - pthread driver + ENABLE_LLVM=0 + POCL_DEBUG_MESSAGES=0
+        # only_lib - build only libpocl, no examples or binaries
         # android is currently disabled, need to check NDK license if we can use it in CI
-        config: [cross, proxy, accel, no_llvm_no_debug]
+        config: [cross, proxy, accel, no_llvm_no_debug, only_lib]
 
     steps:
       - name: Checkout
@@ -73,6 +74,8 @@ jobs:
             runCMake -DENABLE_ALMAIF_DEVICE=1 -DENABLE_ICD=0 -DENABLE_LOADABLE_DRIVERS=0 -DENABLE_LLVM=0 -DENABLE_HOST_CPU_DEVICES=0
           elif [ "${{ matrix.config }}" == "no_llvm_no_debug" ]; then
             runCMake -DHOST_DEVICE_BUILD_HASH=1234567 -DENABLE_LLVM=0 -DENABLE_ICD=0 -DENABLE_LOADABLE_DRIVERS=0 -DPOCL_DEBUG_MESSAGES:BOOL=OFF
+          elif [ "${{ matrix.config }}" == "only_lib" ]; then
+            runCMake -DHOST_DEVICE_BUILD_HASH=1234567 -DENABLE_LLVM=0 -DENABLE_ICD=0 -DENABLE_LLVM=0 -DENABLE_LOADABLE_DRIVERS=0 -DENABLE_EXAMPLES=0 -DENABLE_POCLCC=0
           elif [ "${{ matrix.config }}" == "proxy" ]; then
             runCMake -DENABLE_PROXY_DEVICE=1 -DENABLE_PROXY_DEVICE_INTEROP=1 -DENABLE_HOST_CPU_DEVICES=0 -DENABLE_LLVM=0 -DENABLE_ICD=0 -DENABLE_LOADABLE_DRIVERS=0 -DVISIBILITY_HIDDEN=0
           else

.github/workflows/build_remote.yml

@@ -138,7 +138,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
 
       - name: Load Env vars
         id: load-env
@@ -188,7 +188,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
 
       - name: Load Env vars
         id: load-env

.github/workflows/codeql.yml

@@ -66,7 +66,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@f09c1c0a94de965c15400f5634aa42fac8fb8f88
+      uses: github/codeql-action/init@aa578102511db1f4524ed59b8cc2bae4f6e88195
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
@@ -94,6 +94,6 @@ jobs:
         exit 1
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@f09c1c0a94de965c15400f5634aa42fac8fb8f88
+      uses: github/codeql-action/analyze@aa578102511db1f4524ed59b8cc2bae4f6e88195
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/scorecard.yml

@@ -69,6 +69,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@f09c1c0a94de965c15400f5634aa42fac8fb8f88
+        uses: github/codeql-action/upload-sarif@aa578102511db1f4524ed59b8cc2bae4f6e88195
         with:
           sarif_file: results.sarif

CMakeLists.txt

@@ -107,7 +107,7 @@ macro(pass_through_cpack_vars)
 endmacro()
 
 # don't allow implicit function declarations
-if(UNIX)
+if(UNIX OR MINGW)
   if((CMAKE_C_COMPILER_ID STREQUAL "GNU") OR
      (CMAKE_C_COMPILER_ID STREQUAL "Clang") OR
       (CMAKE_C_COMPILER_ID STREQUAL "AppleClang"))
@@ -404,10 +404,6 @@ if(ENABLE_LLVM_PLATFORM_SUPPORT)
   if(NOT ENABLE_LLVM)
     message(FATAL_ERROR "ENABLE_LLVM_PLATFORM_SUPPORT requires also ENABLE_LLVM")
   endif()
-  if(ENABLE_LOADABLE_DRIVERS)
-    message(WARNING "LLVM dynlibs implementation doesn't support loadable drivers, disabling.")
-    set(ENABLE_LOADABLE_DRIVERS 0)
-  endif()
   if(ENABLE_PRINTF_IMMEDIATE_FLUSH)
     message(WARNING "LLVM dynlibs implementation doesn't support printf() immediate flush, disabling.")
     set(ENABLE_PRINTF_IMMEDIATE_FLUSH 0)
@@ -494,11 +490,22 @@ set(COMMAND_USES_TERMINAL USES_TERMINAL)
 
 include(GNUInstallDirs)
 
-# for libpocl.so
-set(POCL_INSTALL_PUBLIC_LIBDIR "${CMAKE_INSTALL_FULL_LIBDIR}" CACHE PATH "POCL public libdir")
+# for (lib)pocl.(so|dll|dylib)
+if(WIN32)
+  set(POCL_INSTALL_PUBLIC_LIBDIR "${CMAKE_INSTALL_FULL_BINDIR}" CACHE PATH "POCL public libdir")
+else()
+  set(POCL_INSTALL_PUBLIC_LIBDIR "${CMAKE_INSTALL_FULL_LIBDIR}" CACHE PATH "POCL public libdir")
+endif()
+
+# for (lib)pocl-devices-*.(so|dll|dylib)
+set(POCL_INSTALL_PRIVATE_LIBDIR "${POCL_INSTALL_PUBLIC_LIBDIR}/pocl" CACHE PATH "POCL private libdir")
 
-# for libpocl-devices-*.so
-set(POCL_INSTALL_PRIVATE_LIBDIR "${CMAKE_INSTALL_FULL_LIBDIR}/pocl" CACHE PATH "POCL private libdir")
+# for libpocl.(a|dll.a)
+if(WIN32)
+  set(POCL_INSTALL_STATIC_LIBDIR "${CMAKE_INSTALL_FULL_LIBDIR}" CACHE PATH "POCL public libdir")
+else()
+  set(POCL_INSTALL_STATIC_LIBDIR "${POCL_INSTALL_PUBLIC_LIBDIR}/static" CACHE PATH "POCL public libdir")
+endif()
 
 # for pocl.icd
 set(POCL_INSTALL_ICD_VENDORDIR "${CMAKE_INSTALL_FULL_SYSCONFDIR}/OpenCL/vendors" CACHE PATH "POCL ICD file destination")
@@ -742,7 +749,7 @@ endif()
 
 ######################################################################################
 
-if(UNIX)
+if(UNIX OR MINGW)
   include(CheckCSourceCompiles)
   include(CheckSymbolExists)
 
@@ -909,6 +916,10 @@ if(NOT DEFINED DEFAULT_ENABLE_IPO)
 
     if(DEVELOPER_MODE)
       set(IPO 0)
+    elseif(MINGW)
+      # XXX: IPO on MinGW runs into linker errors (such as `two or more sections
+      # for .gnu.lto__ZN4llvm12DenseMapInfoIPKNS_8MetadataEvE7isEqualES3_S3_.65576.2f694590`)
+      set(IPO 0)
     else()
       include(CheckIPOSupported)
       check_ipo_supported(RESULT IPO OUTPUT IPO_OUTPUT)
@@ -1133,14 +1144,17 @@ endif()
 ######################################################################################
 
 if(ENABLE_HOST_CPU_DEVICES AND PKG_CONFIG_FOUND AND NOT ENABLE_CONFORMANCE)
+  # PoCL requires libxsmm to support LIBXSMM_DATATYPE_F16, which was added after the
+  # 1.17 release. Until there is a new release, building libxsmm from git and
+  # manually updating the version number in version.txt before building is necessary.
   if(BUILD_SHARED_LIBS)
-    pkg_check_modules(LIBXSMM IMPORTED_TARGET libxsmm-shared>=1.15)
+    pkg_check_modules(LIBXSMM IMPORTED_TARGET libxsmm-shared>1.17.0)
   endif()
   if(NOT LIBXSMM_FOUND)
-    pkg_check_modules(LIBXSMM IMPORTED_TARGET libxsmm-static>=1.15)
+    pkg_check_modules(LIBXSMM IMPORTED_TARGET libxsmm-static>1.17.0)
   endif()
   if(NOT LIBXSMM_FOUND)
-    pkg_check_modules(LIBXSMM IMPORTED_TARGET libxsmm>=1.15)
+    pkg_check_modules(LIBXSMM IMPORTED_TARGET libxsmm>1.17.0)
   endif()
 
   # libxsmm needs BLAS as fallback
@@ -1155,6 +1169,8 @@ if(LIBXSMM_FOUND AND TARGET BLAS::BLAS)
 else()
   set(HAVE_LIBXSMM 0)
   message(STATUS "libxsmm or libblas not found, XSMM disabled")
+  message(STATUS "NOTE: If you meant to use a git build of libxsmm you may have to manually bump "
+          "the version in its version.txt before building.")
 endif()
 
 function(print_target_properties target)
@@ -1193,7 +1209,9 @@ if(ENABLE_HOST_CPU_DEVICES AND NOT ENABLE_CONFORMANCE)
       set(HAVE_ONNXRT ON)
     endif ()
   else ()
-    find_package(onnxruntime QUIET)
+    # PoCL requires SetUserLoggingFunction which was introduced in 1.17,
+    # search for a version that is compatible with this.
+    find_package(onnxruntime 1.17 QUIET)
     set(HAVE_ONNXRT ${onnxruntime_FOUND})
     if (${HAVE_ONNXRT})
       # TODO: this is a hack, just passing onnxruntime::onnxruntime
@@ -2177,9 +2195,11 @@ configure_file("cl_offline_compiler.sh.in.cmake" "cl_offline_compiler.sh.config.
 rename_if_different(
   "${CMAKE_BINARY_DIR}/cl_offline_compiler.sh.config.new"
   "${CMAKE_BINARY_DIR}/cl_offline_compiler.sh.config" 1)
-file(GENERATE
-  OUTPUT "${CMAKE_BINARY_DIR}/cl_offline_compiler.sh"
-  INPUT "${CMAKE_BINARY_DIR}/cl_offline_compiler.sh.config")
+if(ENABLE_SPIRV)
+  file(GENERATE
+    OUTPUT "${CMAKE_BINARY_DIR}/cl_offline_compiler.sh"
+    INPUT "${CMAKE_BINARY_DIR}/cl_offline_compiler.sh.config")
+endif()
 
 include_directories("${CMAKE_BINARY_DIR}")
 
@@ -2226,7 +2246,7 @@ endif()
 
 ##########################################################
 
-if(UNIX)
+if(UNIX OR MINGW)
   configure_file("${CMAKE_SOURCE_DIR}/pocl.pc.in.cmake" "${CMAKE_BINARY_DIR}/pocl.pc" @ONLY)
   install(FILES "${CMAKE_BINARY_DIR}/pocl.pc"
           DESTINATION "${POCL_INSTALL_PKGCONFIG_DIR}" COMPONENT "dev")
@@ -2296,7 +2316,7 @@ set(POCLU_LINK_OPTIONS poclu ${OPENCL_LIBS} ${LIBMATH})
 message(STATUS "POCLU LINK OPTS: ${POCLU_LINK_OPTIONS}")
 
 # poclcc bin
-if(ENABLE_POCLCC)
+if(ENABLE_POCLCC OR ENABLE_SPIRV)
     add_subdirectory("bin")
 endif()