Merge branch 'main' into fix_kernel_arg_indices

Author: fabiomestre

.github/workflows/benchmarks-reusable.yml

@@ -236,3 +236,8 @@ jobs:
       with:
         path: ur-repo/benchmark_results.html
         key: benchmark-results-${{ matrix.adapter.str_name }}-${{ github.run_id }}
+
+    - name: Get information about platform
+      if: ${{ always() }}
+      working-directory: ${{ github.workspace }}/ur-repo/
+      run: .github/scripts/get_system_info.sh

.github/workflows/e2e_core.yml

@@ -192,6 +192,11 @@ jobs:
       id: tests
       run: ninja -C build-e2e check-sycl-e2e || echo "e2e tests have failed. Ignoring failure."
 
+    - name: Get information about platform
+      if: ${{ always() }}
+      working-directory: ${{github.workspace}}/ur-repo
+      run: .github/scripts/get_system_info.sh
+
     # FIXME: Requires pull-request: write permissions but this is only granted
     # on pull requests from forks if using pull_request_target workflow
     # trigger but not the pull_request trigger..

README.md

@@ -76,7 +76,14 @@ history to avoid pulling potentially breaking changes from the `main` branch.
 
 ## Third-Party tools
 
-Tools can be acquired via instructions in [third_party](/third_party/README.md).
+The recommended method to install the third-party tools is using a Python
+virtual environment, for example:
+
+```bash
+$ python -m venv .venv
+$ source .venv/bin/activate
+$ pip install -r third_party/requirements.txt
+```
 
 ## Building
 

cmake/helpers.cmake

@@ -83,7 +83,7 @@ set(CFI_FLAGS "")
 if (CFI_HAS_CFI_SANITIZE)
     # cfi-icall requires called functions in shared libraries to also be built with cfi-icall, which we can't
     # guarantee. -fsanitize=cfi depends on -flto
-    set(CFI_FLAGS "-flto -fsanitize=cfi -fno-sanitize=cfi-icall -fsanitize-ignorelist=${CMAKE_SOURCE_DIR}/sanitizer-ignorelist.txt")
+    set(CFI_FLAGS "-flto -fsanitize=cfi -fno-sanitize=cfi-icall -fsanitize-ignorelist=${PROJECT_SOURCE_DIR}/sanitizer-ignorelist.txt")
 endif()
 
 function(add_ur_target_compile_options name)

examples/collector/CMakeLists.txt

@@ -10,7 +10,7 @@ add_ur_library(${TARGET_NAME} SHARED
 )
 
 target_include_directories(${TARGET_NAME} PRIVATE
-    ${CMAKE_SOURCE_DIR}/include
+    ${PROJECT_SOURCE_DIR}/include
 )
 
 target_link_libraries(${TARGET_NAME} PRIVATE ${TARGET_XPTI})

include/ur_api.h

@@ -651,6 +651,7 @@ typedef ur_result_t(UR_APICALL *ur_pfnGetKernelProcAddrTable_t)(
 /// @brief Function-pointer for urKernelSuggestMaxCooperativeGroupCountExp
 typedef ur_result_t(UR_APICALL *ur_pfnKernelSuggestMaxCooperativeGroupCountExp_t)(
     ur_kernel_handle_t,
+    ur_device_handle_t,
     uint32_t,
     const size_t *,
     size_t,

include/ur_ddi.h

@@ -2074,6 +2074,9 @@ inline std::ostream &operator<<(std::ostream &os, enum ur_platform_info_t value)
     case UR_PLATFORM_INFO_BACKEND:
         os << "UR_PLATFORM_INFO_BACKEND";
         break;
+    case UR_PLATFORM_INFO_ADAPTER:
+        os << "UR_PLATFORM_INFO_ADAPTER";
+        break;
     default:
         os << "unknown enumerator";
         break;
@@ -2127,6 +2130,19 @@ inline ur_result_t printTagged(std::ostream &os, const void *ptr, ur_platform_in
 
         os << ")";
     } break;
+    case UR_PLATFORM_INFO_ADAPTER: {
+        const ur_adapter_handle_t *tptr = (const ur_adapter_handle_t *)ptr;
+        if (sizeof(ur_adapter_handle_t) > size) {
+            os << "invalid size (is: " << size << ", expected: >=" << sizeof(ur_adapter_handle_t) << ")";
+            return UR_RESULT_ERROR_INVALID_SIZE;
+        }
+        os << (const void *)(tptr) << " (";
+
+        ur::details::printPtr(os,
+                              *tptr);
+
+        os << ")";
+    } break;
     default:
         os << "unknown enumerator";
         return UR_RESULT_ERROR_INVALID_ENUMERATION;
@@ -13187,6 +13203,12 @@ inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct
     ur::details::printPtr(os,
                           *(params->phKernel));
 
+    os << ", ";
+    os << ".hDevice = ";
+
+    ur::details::printPtr(os,
+                          *(params->phDevice));
+
     os << ", ";
     os << ".workDim = ";
 

include/ur_print.hpp

@@ -336,6 +336,7 @@ plural form *enumerators* is abbreviated to `etors`.
   - An etor requires the following scalar fields: {`name`, `desc`}
     + `desc` will be used as the etors's description comment
     + If the enum has `typed_etors`, `desc` must begin with type identifier: {`"[type]"`}
+    + `desc` may contain the [optional-query] annotation. This denotes the etor as an info query which is optional for adapters to implement, and may legally result in a non-success error code.
     + `name` must be a unique ISO-C standard identifier, and be all caps
   - An etor may take the following optional scalar field: {`value`, `version`}
     + `value` must be an ISO-C standard identifier

scripts/YaML.md

@@ -26,6 +26,7 @@ class Options:
     # these two should probably be merged into one setting
     stddev_threshold: float = 0.02
     epsilon: float = 0.02
+    iterations_stddev: int = 5
 
 options = Options()