Merge remote-tracking branch 'origin/main' into matrixperf-i8

Author: bashbaug

CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2024 Ben Ashbaugh
+# Copyright (c) 2019-2025 Ben Ashbaugh
 #
 # SPDX-License-Identifier: MIT
 

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.

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

include/CL/opencl.hpp

@@ -1776,6 +1776,7 @@ CL_HPP_DECLARE_PARAM_TRAITS_(cl_device_info, CL_DEVICE_INTEGRATED_MEMORY_NV, cl_
 #if defined(cl_khr_command_buffer)
 CL_HPP_DECLARE_PARAM_TRAITS_(cl_device_info, CL_DEVICE_COMMAND_BUFFER_CAPABILITIES_KHR, cl_device_command_buffer_capabilities_khr)
 CL_HPP_DECLARE_PARAM_TRAITS_(cl_device_info, CL_DEVICE_COMMAND_BUFFER_REQUIRED_QUEUE_PROPERTIES_KHR, cl_command_queue_properties)
+CL_HPP_DECLARE_PARAM_TRAITS_(cl_device_info, CL_DEVICE_COMMAND_BUFFER_SUPPORTED_QUEUE_PROPERTIES_KHR, cl_command_queue_properties)
 CL_HPP_DECLARE_PARAM_TRAITS_(cl_command_buffer_info_khr, CL_COMMAND_BUFFER_QUEUES_KHR, cl::vector<CommandQueue>)
 CL_HPP_DECLARE_PARAM_TRAITS_(cl_command_buffer_info_khr, CL_COMMAND_BUFFER_NUM_QUEUES_KHR, cl_uint)
 CL_HPP_DECLARE_PARAM_TRAITS_(cl_command_buffer_info_khr, CL_COMMAND_BUFFER_REFERENCE_COUNT_KHR, cl_uint)
@@ -2441,7 +2442,7 @@ class Device : public detail::Wrapper<cl_device_id>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_device_info, name>::param_type param;
+            detail::cl_device_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -2700,7 +2701,7 @@ class Platform : public detail::Wrapper<cl_platform_id>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_platform_info, name>::param_type param;
+            detail::cl_platform_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -3389,7 +3390,7 @@ class Context
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_context_info, name>::param_type param;
+            detail::cl_context_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -3472,7 +3473,7 @@ class Context
             cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-        detail::cl_image_requirements_info_ext, type>::param_type param;
+        detail::cl_image_requirements_info_ext, type>::param_type param{};
         cl_int result = getImageRequirementsInfoExt(type, &param, flags, properties, image_format, image_desc);
         if (err != nullptr) {
             *err = result;
@@ -3590,7 +3591,7 @@ class Event : public detail::Wrapper<cl_event>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_event_info, name>::param_type param;
+            detail::cl_event_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -3613,7 +3614,7 @@ class Event : public detail::Wrapper<cl_event>
     getProfilingInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_profiling_info, name>::param_type param;
+            detail::cl_profiling_info, name>::param_type param{};
         cl_int result = getProfilingInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -3779,7 +3780,7 @@ class Memory : public detail::Wrapper<cl_mem>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_mem_info, name>::param_type param;
+            detail::cl_mem_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -4692,7 +4693,7 @@ class Image : public Memory
     getImageInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_image_info, name>::param_type param;
+            detail::cl_image_info, name>::param_type param{};
         cl_int result = getImageInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -5560,7 +5561,7 @@ class Pipe : public Memory
         getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_pipe_info, name>::param_type param;
+            detail::cl_pipe_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -5667,7 +5668,7 @@ class Sampler : public detail::Wrapper<cl_sampler>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_sampler_info, name>::param_type param;
+            detail::cl_sampler_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -5875,7 +5876,7 @@ class Kernel : public detail::Wrapper<cl_kernel>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_kernel_info, name>::param_type param;
+            detail::cl_kernel_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -5897,7 +5898,7 @@ class Kernel : public detail::Wrapper<cl_kernel>
     getArgInfo(cl_uint argIndex, cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_kernel_arg_info, name>::param_type param;
+            detail::cl_kernel_arg_info, name>::param_type param{};
         cl_int result = getArgInfo(argIndex, name, &param);
         if (err != nullptr) {
             *err = result;
@@ -5921,7 +5922,7 @@ class Kernel : public detail::Wrapper<cl_kernel>
         getWorkGroupInfo(const Device& device, cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-        detail::cl_kernel_work_group_info, name>::param_type param;
+        detail::cl_kernel_work_group_info, name>::param_type param{};
         cl_int result = getWorkGroupInfo(device, name, &param);
         if (err != nullptr) {
             *err = result;
@@ -6755,7 +6756,7 @@ class Program : public detail::Wrapper<cl_program>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_program_info, name>::param_type param;
+            detail::cl_program_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -6778,7 +6779,7 @@ class Program : public detail::Wrapper<cl_program>
     getBuildInfo(const Device& device, cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_program_build_info, name>::param_type param;
+            detail::cl_program_build_info, name>::param_type param{};
         cl_int result = getBuildInfo(device, name, &param);
         if (err != nullptr) {
             *err = result;
@@ -6811,7 +6812,7 @@ class Program : public detail::Wrapper<cl_program>
 
         for (const cl::Device &d : devs) {
             typename detail::param_traits<
-                detail::cl_program_build_info, name>::param_type param;
+                detail::cl_program_build_info, name>::param_type param{};
             result = getBuildInfo(d, name, &param);
             devInfo.push_back(
                 std::pair<cl::Device, typename detail::param_traits<detail::cl_program_build_info, name>::param_type>
@@ -7598,7 +7599,7 @@ class CommandQueue : public detail::Wrapper<cl_command_queue>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_command_queue_info, name>::param_type param;
+            detail::cl_command_queue_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -9269,7 +9270,7 @@ class DeviceCommandQueue : public detail::Wrapper<cl_command_queue>
         getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_command_queue_info, name>::param_type param;
+            detail::cl_command_queue_info, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;
@@ -10765,7 +10766,7 @@ class CommandBuffer : public detail::Wrapper<cl_command_buffer_khr>
     getInfo(cl_int* err = nullptr) const
     {
         typename detail::param_traits<
-            detail::cl_command_buffer_info_khr, name>::param_type param;
+            detail::cl_command_buffer_info_khr, name>::param_type param{};
         cl_int result = getInfo(name, &param);
         if (err != nullptr) {
             *err = result;

include/getenv_util.hpp

@@ -0,0 +1,98 @@
+/*
+// Copyright (c) 2022-2025 Ben Ashbaugh
+//
+// SPDX-License-Identifier: MIT
+*/
+#pragma once
+
+#include <stdlib.h>
+#include <string.h>
+
+#include <string>
+
+#if defined(_WIN32)
+
+#include <windows.h>
+
+#define GETENV( _name, _value ) _dupenv_s( &_value, NULL, _name )
+#define FREEENV( _value ) free( _value )
+
+#else
+
+#define GETENV( _name, _value ) _value = getenv(_name)
+#define FREEENV( _value ) (void)_value
+
+#endif
+
+static inline bool getControlFromEnvironment(
+    const char* name,
+    void* pValue,
+    size_t size )
+{
+    char* envVal = NULL;
+    GETENV( name, envVal );
+
+    if( envVal != NULL )
+    {
+        if( size == sizeof(unsigned int) )
+        {
+            unsigned int* puVal = (unsigned int*)pValue;
+            *puVal = atoi(envVal);
+        }
+        else if( strlen(envVal) < size )
+        {
+            char* pStr = (char*)pValue;
+            strcpy( pStr, envVal );
+        }
+
+        FREEENV( envVal );
+        return true;
+    }
+
+    return false;
+}
+
+template <class T>
+static bool getControl(
+    const char* name,
+    T& value )
+{
+    unsigned int readValue = 0;
+    bool success = getControlFromEnvironment( name, &readValue, sizeof(readValue) );
+    if( success )
+    {
+        value = readValue;
+    }
+
+    return success;
+}
+
+template <>
+bool getControl<bool>(
+    const char* name,
+    bool& value )
+{
+    unsigned int readValue = 0;
+    bool success = getControlFromEnvironment( name, &readValue, sizeof(readValue) );
+    if( success )
+    {
+        value = ( readValue != 0 );
+    }
+
+    return success;
+}
+
+template <>
+bool getControl<std::string>(
+    const char* name,
+    std::string& value )
+{
+    char readValue[256] = "";
+    bool success = getControlFromEnvironment( name, readValue, sizeof(readValue) );
+    if( success )
+    {
+        value = readValue;
+    }
+
+    return success;
+}

include/layer_util.hpp

@@ -1,5 +1,5 @@
 /*
-// Copyright (c) 2022-2024 Ben Ashbaugh
+// Copyright (c) 2022-2025 Ben Ashbaugh
 //
 // SPDX-License-Identifier: MIT
 */

include/util.hpp

@@ -1,5 +1,5 @@
 /*
-// Copyright (c) 2021-2024 Ben Ashbaugh
+// Copyright (c) 2021-2025 Ben Ashbaugh
 //
 // SPDX-License-Identifier: MIT
 */