Run SYCL workflows with both nightly and release version of DPC++ (#246)

carlewis · aacostadiaz · web-flow · commit c587b63b30bb · 2025-03-07T18:35:51.000Z
This will create a job for each version of the compiler (nightly and
release), on both Intel PVC Test and Intel PVC Python Interface Test.

The workflow is still callable with a custom tag of the compiler nightly
build using the `workflow_dispatch` form.

Running Intel PVC tests for the release compiler only works with `icpx`
(not with `clang++`)

---------

Co-authored-by: Alejandro Acosta &lt;alejandro.acosta@codeplay.com&gt;
diff --git a/.github/actions/install-dpcpp/action.yml b/.github/actions/install-dpcpp/action.yml
@@ -1,34 +1,65 @@
 name: install-dpcpp
 description: Download and unpack DPC++ nightly release
 inputs:
+  DPCPP_RELEASE:
+    description: "Use RELEASE or NIGHTLY DPC++ release"
+    type: string
+    default: NIGHTLY
   DPCPP_VERSION:
     description: "DPC++ version to use"
     type: string
   DPCPP_PATH:
     description: Path to DPC++
     type: string
+    default: ~/dpcpp
 runs:
   using: "composite"
   steps:
     - name: Install DPCPP
-      id: install_dpcpp
+      if: inputs.DPCPP_RELEASE == 'NIGHTLY'
       shell: bash
       run: |
         export DPCPP_PATH=${{ inputs.DPCPP_PATH }}
-        mkdir $DPCPP_PATH
+        mkdir -p $DPCPP_PATH
         pushd $DPCPP_PATH
-        if [[ "${{ inputs.DPCPP_VERSION }}" != "" ]]; then \
-          echo "Will use DPCPP ${{ inputs.DPCPP_VERSION }}."; \
-          echo "Downloading DPCPP from https://github.com/intel/llvm/releases/download/${{ inputs.DPCPP_VERSION }}/sycl_linux.tar.gz"; \
-          wget -q https://github.com/intel/llvm/releases/download/${{ inputs.DPCPP_VERSION }}/sycl_linux.tar.gz; \
+        if [[ "${{ inputs.DPCPP_VERSION }}" != "" ]]; then
+          echo "Will use DPCPP ${{ inputs.DPCPP_VERSION }}"
+          URL=https://github.com/intel/llvm/releases/download/${{ inputs.DPCPP_VERSION }}/sycl_linux.tar.gz;
         else
-          echo "Will use latest DPCPP version."; \
-          latest=$(curl -sS https://api.github.com/repos/intel/llvm/releases | jq -r '[.[].tag_name|select(match("nightly-[0-9]{4}-[0-9]{2}-[0-9]{2}"))][0]') && \
-          echo "Downloading DPCPP from https://github.com/intel/llvm/releases/download/${latest}/sycl_linux.tar.gz"; \
-          wget -q https://github.com/intel/llvm/releases/download/${latest}/sycl_linux.tar.gz; \
+          echo "Will use latest DPCPP version"
+          latest=$(curl -sS https://api.github.com/repos/intel/llvm/releases | jq -r '[.[].tag_name|select(match("nightly-[0-9]{4}-[0-9]{2}-[0-9]{2}"))][0]')
+          URL=https://github.com/intel/llvm/releases/download/${latest}/sycl_linux.tar.gz;
         fi
-        tar -xf sycl_linux.tar.gz
-        rm sycl_linux.tar.gz
+        echo "Downloading DPCPP from ${URL}"
+        sudo wget -q $URL
+        sudo tar -xf sycl_linux.tar.gz
+        sudo rm sycl_linux.tar.gz
         popd
-
+        cat <<EOF | tee setvars.sh
+        export PATH=$DPCPP_PATH/bin:$PATH
+        export C_INCLUDE_PATH=$DPCPP_PATH/include:$C_INCLUDE_PATH
+        export CPLUS_INCLUDE_PATH=$DPCPP_PATH/include:$CPLUS_INCLUDE_PATH
+        export LD_LIBRARY_PATH=$DPCPP_PATH/lib:$LD_LIBRARY_PATH
+        export CC=$DPCPP_PATH/bin/clang
+        export CXX=$DPCPP_PATH/bin/clang++
+        EOF
+    - name: Install DPCPP
+      if: inputs.DPCPP_RELEASE == 'RELEASE'
+      shell: bash
+      run: |
+        wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
+        sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
+        rm GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
+        echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list
+        sudo apt update
+        sudo apt install -y intel-oneapi-runtime-libs intel-oneapi-compiler-dpcpp-cpp
+        . /opt/intel/oneapi/setvars.sh
+        cat <<EOF | tee setvars.sh
+        . /opt/intel/oneapi/setvars.sh
+        export CC=icx
+        export CXX=icpx
+        export C_INCLUDE_PATH=$CMPLR_ROOT/include:$C_INCLUDE_PATH
+        export CPLUS_INCLUDE_PATH=$CMPLR_ROOT/include:$CPLUS_INCLUDE_PATH
+        export LD_LIBRARY_PATH=$CMPLR_ROOT/lib:$LD_LIBRARY_PATH
+        EOF
 
diff --git a/.github/actions/install-dpctl/action.yml b/.github/actions/install-dpctl/action.yml
@@ -7,8 +7,6 @@ inputs:
     description: Name of the DPCTL branch to use.
   DPCTL_PATH:
     description: Path where to put DPCTL
-  DPCPP_PATH:
-    description: Path to DPC++
   VENV_PATH:
     description: Path to virtualenv
 
@@ -22,11 +20,8 @@ runs:
         git clone --depth=1 --branch ${{ inputs.DPCTL_BRANCH }} ${{ inputs.DPCTL_URL }} $DPCTL_PATH
         pushd $DPCTL_PATH
         source ${{ inputs.VENV_PATH }}/bin/activate
-        export DPCPP_PATH=${{ inputs.DPCPP_PATH }}
-        export PATH=$DPCPP_PATH/bin:$PATH
-        export LD_LIBRARY_PATH=$DPCPP_PATH/lib:$LD_LIBRARY_PATH
         pip install --no-cache-dir numpy cython scikit-build cmake ninja pytest versioneer
-        python scripts/build_locally.py --c-compiler=$DPCPP_PATH/bin/clang \
-          --cxx-compiler=$DPCPP_PATH/bin/clang++ \
-          --compiler-root=$DPCPP_PATH/bin \
+        python scripts/build_locally.py --c-compiler=$(which $CC) \
+          --cxx-compiler=$(which $CXX) \
+          --compiler-root=$(dirname `which $CXX`) \
           --cmake-opts="-DCMAKE_INCLUDE_PATH=/lib/x86_64-linux-gnu -DLIBZE_LOADER_FILENAME=libze_loader.so.1"
diff --git a/.github/workflows/intel_pvc_test.yml b/.github/workflows/intel_pvc_test.yml
@@ -21,6 +21,9 @@ concurrency:
 
 jobs:
   run-tests:
+    strategy:
+      matrix:
+        compiler: [ NIGHTLY, RELEASE ]
     name: Run Intel PVC tests
     runs-on: cp-gpumax-1100-gpu
     timeout-minutes: 30
@@ -31,22 +34,18 @@ jobs:
       # For a specific DPC++ nightly build define the repository variable DPCPP_VERSION
       # for example using the tag: 'nightly-2024-04-22'
       - name: Install DPC++
-        id: install_dpcpp
         uses: ./.github/actions/install-dpcpp
         with:
+          DPCPP_RELEASE: ${{ matrix.compiler }}
           DPCPP_VERSION: ${{ inputs.DPCPP_VERSION }}
-          DPCPP_PATH: ~/dpcpp
       - name: Build
         shell: bash
         run: |
-          export DPCPP_PATH=~/dpcpp
-          export PATH=$DPCPP_PATH/bin/:$PATH
-          export C_INCLUDE_PATH=$DPCPP_PATH/include/:$C_INCLUDE_PATH
-          export CPLUS_INCLUDE_PATH=$DPCPP_PATH/include/:$CPLUS_INCLUDE_PATH
-          export LD_LIBRARY_PATH=$DPCPP_PATH/lib/:$LD_LIBRARY_PATH
-          export CC=clang
-          export CXX=clang++
-          clang++ --version
+          . setvars.sh
+          # Persist environment variables to following steps
+          env >> $GITHUB_ENV
+          which $CXX
+          $CXX --version
           cmake -G Ninja  \
             -DCUTLASS_ENABLE_SYCL=ON \
             -DDPCPP_SYCL_TARGET=intel_gpu_pvc
@@ -55,13 +54,9 @@ jobs:
       - name: Unit test
         shell: bash
         run: |
-          export DPCPP_PATH=~/dpcpp
-          export LD_LIBRARY_PATH=$DPCPP_PATH/lib/:$LD_LIBRARY_PATH
           cmake --build . --target test_unit -j 24
 
       - name: Examples
         shell: bash
         run: |
-          export DPCPP_PATH=~/dpcpp
-          export LD_LIBRARY_PATH=$DPCPP_PATH/lib/:$LD_LIBRARY_PATH
           cmake --build . --target test_examples -j 24
diff --git a/.github/workflows/sycl_python_test.yml b/.github/workflows/sycl_python_test.yml
@@ -1,4 +1,4 @@
-name: "SYCL Intel PVC Python Interface Test"
+name: "SYCL Python Interface Test"
 
 on:
   push:
@@ -21,7 +21,10 @@ concurrency:
 
 jobs:
   run-tests:
-    name: Run Intel PVC tests
+    name: Run Python Interface tests on Intel PVC
+    # strategy:
+    #   matrix:
+    #     compiler: [ NIGHTLY, RELEASE ]
     runs-on: cp-gpumax-1100-gpu
     timeout-minutes: 60
 
@@ -36,20 +39,25 @@ jobs:
         id: install_dpcpp
         uses: ./.github/actions/install-dpcpp
         with:
+          # DPCPP_RELEASE: ${{ matrix.compiler }}
           DPCPP_VERSION: ${{ inputs.DPCPP_VERSION }}
           DPCPP_PATH: ~/dpcpp
       - name: Setup virtual environment
         shell: bash
         run: |
           python3 -m venv ~/.venv
+          source ~/.venv/bin/activate
+          . setvars.sh
+          # Persist environment variables to following steps
+          env >> $GITHUB_ENV
+
       - name: Install DPCTL
         id: install_dpctl
         uses: ./.github/actions/install-dpctl
         with:
           DPCTL_URL: https://github.com/sommerlukas/dpctl.git
           DPCTL_BRANCH: rebase-kernel-param
           DPCTL_PATH: ~/dpctl
-          DPCPP_PATH: ~/dpcpp
           VENV_PATH: ~/.venv
       - name: Install Torch XPU
         shell: bash
@@ -60,9 +68,6 @@ jobs:
       - name: Run Python Interface GEMM Tests
         shell: bash
         run: |
-          export DPCPP_PATH=~/dpcpp
-          export PATH=$DPCPP_PATH/bin:$PATH
-          export LD_LIBRARY_PATH=$DPCPP_PATH/lib:$LD_LIBRARY_PATH
           source ~/.venv/bin/activate
           pip install -e .
           export CUTLASS_USE_SYCL=1
