Merge branch 'main' into nv-subgroup-emu

Author: bashbaug

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
     - name: Check Tabs
       run: |
@@ -39,7 +39,7 @@ jobs:
     runs-on: ${{matrix.os}}
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
     - name: Get Ubuntu OpenGL Dependencies
       if: matrix.os == 'ubuntu-latest'
@@ -48,24 +48,31 @@ jobs:
         sudo apt-get install -y libglfw3-dev
 
     - name: Get OpenCL Headers
-      uses: actions/checkout@v4
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         repository: KhronosGroup/OpenCL-Headers
         path: external/OpenCL-Headers
 
     - name: Get OpenCL ICD Loader
-      uses: actions/checkout@v4
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         repository: KhronosGroup/OpenCL-ICD-Loader
         path: external/opencl-icd-loader
 
     - name: Get OpenCL Extension Loader
       if: matrix.ext == 'YES'
-      uses: actions/checkout@v4
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         repository: bashbaug/opencl-extension-loader
         path: external/opencl-extension-loader
 
+    - name: Get SPIR-V Headers
+      if: matrix.ext == 'YES'
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      with:
+        repository: KhronosGroup/SPIRV-Headers
+        path: external/SPIRV-Headers
+
     - name: Create Build Directory
       run: cmake -E make_directory ${{runner.workspace}}/build
 

CMakeLists.txt

@@ -1,8 +1,8 @@
-# Copyright (c) 2019-2024 Ben Ashbaugh
+# Copyright (c) 2019-2025 Ben Ashbaugh
 #
 # SPDX-License-Identifier: MIT
 
-cmake_minimum_required(VERSION 3.1 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.16 FATAL_ERROR)
 
 set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
 set(CMAKE_CXX_STANDARD 14)
@@ -36,6 +36,12 @@ else()
     message(STATUS "OpenCL Extension Loader is not found.")
 endif()
 
+if(IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/external/SPIRV-Headers)
+    add_subdirectory(external/SPIRV-Headers)
+else()
+    message(STATUS "SPIR-V Headers are not found.")
+endif()
+
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
     enable_testing()
 endif()

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Ben Ashbaugh
+Copyright (c) 2019-2025 Ben Ashbaugh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,6 +1,6 @@
 # Simple OpenCL<sup>TM</sup> Samples
 
-[![build](https://github.com/bashbaug/SimpleOpenCLSamples/workflows/build/badge.svg?branch=main)](https://github.com/bashbaug/SimpleOpenCLSamples/actions?query=workflow%3Abuild+branch%3Amain)
+[![build](https://github.com/bashbaug/SimpleOpenCLSamples/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/bashbaug/SimpleOpenCLSamples/actions?query=workflow%3Abuild+branch%3Amain)
 
 This repo contains simple OpenCL samples that demonstrate how to build
 OpenCL applications using only the Khronos-provided headers and libs.
@@ -39,6 +39,10 @@ Many samples that use extensions additionally require the OpenCL Extension Loade
 
     git clone https://github.com/bashbaug/opencl-extension-loader external/opencl-extension-loader
 
+Several samples that interact with SPIR-V require the SPIR-V headres:
+
+    git clone https://github.com/KhronosGroup/SPIRV-Headers external/SPIRV-Headers
+
 After satisfying the external dependencies create build files using CMake.  For example:
 
     mkdir build && cd build

docs/env/ubuntu/24.04.md

@@ -0,0 +1,82 @@
+# Ubuntu 24.04 Setup Instructions
+
+## Verify Hardware Support
+
+Most modern GPUs support OpenCL. For integrated graphics devices (iGPUs), use `lscpu` to get the processor SKU. Detailed information for Intel SKUs is available from [ark.intel.com](ark.intel.com). Detailed information for AMD processors is available from [AMD's product page](https://www.amd.com/en/products/specifications/processors).
+
+## Build Dependencies
+
+OCL Headers:
+
+```bash
+sudo apt install opencl-c-headers opencl-clhpp-headers
+```
+
+The OpenCL API has its own set of header files; the above command installs both C and C++ headers files. The C header can be found in `<CL/cl.h>`; the C++ header is in `<CL/opencl.hpp>`.
+
+OCL ICD Loader:
+
+```bash
+sudo apt install ocl-icd-opencl-dev
+```
+
+OpenCL applications generally link against an OpenCL Installable Compute Device (ICD) loader instead of a specific OpenCL implementation; see [https://github.com/bashbaug/OpenCLPapers/blob/master/OpenCLOnLinux.asciidoc](https://github.com/bashbaug/OpenCLPapers/blob/master/OpenCLOnLinux.asciidoc) for more information about this system.
+
+## Runtime Dependencies
+
+OpenCL requires a compute runtime to manage the interaction between the OpenCL API and the GPU.
+
+### OCL ICD Loader
+
+```bash
+sudo apt install ocl-icd-libopencl1
+```
+
+OpenCL applications generally link against an OpenCL Installable Compute Device (ICD) loader instead of a specific OpenCL implementation; see [https://github.com/bashbaug/OpenCLPapers/blob/master/OpenCLOnLinux.asciidoc](https://github.com/bashbaug/OpenCLPapers/blob/master/OpenCLOnLinux.asciidoc) for more information about this system.
+
+### AMD Compute Runtime
+
+AMD supports OpenCL through their ROCm platform. Installation instructions are [here](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html#ubuntu).
+
+### Intel Compute Runtime
+
+Intel's OpenCL support is provided through the NEO compute runtime. Download packages from the project's [GitHub releases page](https://github.com/intel/compute-runtime/releases).
+
+### Nvidia Compute Runtime
+
+Nvidia provides OpenCL support through their proprietary driver, available from the [graphics-drivers PPA](https://launchpad.net/~graphics-drivers/+archive/ubuntu/ppa).
+
+```bash
+sudo add-apt-repository ppa:graphics-drivers/ppa
+sudo apt update
+sudo apt install nvidia-graphics-drivers-<version>
+```
+
+### Configure Permissions
+
+```bash
+sudo usermod -a -G video $USER
+sudo usermod -a -G render $USER
+```
+
+Users running OpenCL applications on a GPU require additional permissions granted by the groups above.
+
+## Verification
+
+The `clinfo` utility can be used to verify the environment has been properly configured.
+
+```bash
+$ sudo apt install clinfo
+$ clinfo
+<platform information should show here>
+```
+
+## Troubleshooting
+
+If `clinfo` indicates there are 0 supported platforms:
+
+1. Verify your host has OpenCL-capable hardware attached
+2. Verify clinfo is running as a user with appropriate group membership
+3. Verify new group membership has been applied (this may require logout or reboot)
+4. Verify the correct compute runtime is installed
+5. Check the kernel log (`sudo dmesg`) for related errors