Move spec changes to adapter.yml, removed 'loader_only' so the new entry point gets added to the ddi tables.

Author: martygrant

include/ur_api.h

@@ -226,7 +226,7 @@ typedef enum ur_function_t {
     UR_FUNCTION_BINDLESS_IMAGES_IMPORT_EXTERNAL_MEMORY_EXP = 226,         ///< Enumerator for ::urBindlessImagesImportExternalMemoryExp
     UR_FUNCTION_BINDLESS_IMAGES_IMPORT_EXTERNAL_SEMAPHORE_EXP = 227,      ///< Enumerator for ::urBindlessImagesImportExternalSemaphoreExp
     UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP = 228,                         ///< Enumerator for ::urEnqueueNativeCommandExp
-    UR_FUNCTION_LOADER_CONFIG_SET_LOGGER_CALLBACK = 229,                  ///< Enumerator for ::urLoaderConfigSetLoggerCallback
+    UR_FUNCTION_SET_LOGGER_CALLBACK = 230,                                ///< Enumerator for ::urSetLoggerCallback
     /// @cond
     UR_FUNCTION_FORCE_UINT32 = 0x7fffffff
     /// @endcond
@@ -787,30 +787,6 @@ UR_APIEXPORT ur_result_t UR_APICALL
 urLoaderTearDown(
     void);
 
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Callback function to retrieve output from the logger.
-typedef void (*ur_logger_output_callback_t)(
-    const char *pLoggerMsg, ///< [in][out] pointer to data to be passed to callback
-    void *pUserData         ///< [in][out] pointer to data to be passed to callback
-);
-
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Set a callback function for use by the logger to retrieve logging
-///        output.
-///
-/// @returns
-///     - ::UR_RESULT_SUCCESS
-///     - ::UR_RESULT_ERROR_UNINITIALIZED
-///     - ::UR_RESULT_ERROR_DEVICE_LOST
-///     - ::UR_RESULT_ERROR_ADAPTER_SPECIFIC
-///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
-///         + `NULL == pfnLoggerCallback`
-UR_APIEXPORT ur_result_t UR_APICALL
-urLoaderConfigSetLoggerCallback(
-    ur_logger_output_callback_t pfnLoggerCallback, ///< [in] Function pointer to callback from the logger.
-    void *pUserData                                ///< [in][out][optional] pointer to data to be passed to callback
-);
-
 #if !defined(__GNUC__)
 #pragma endregion
 #endif
@@ -1011,6 +987,33 @@ typedef enum ur_adapter_backend_t {
 
 } ur_adapter_backend_t;
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Callback function to retrieve output from the logger.
+typedef void (*ur_logger_output_callback_t)(
+    const char *pLoggerMsg, ///< [in][out] pointer to data to be passed to callback
+    void *pUserData         ///< [in][out] pointer to data to be passed to callback
+);
+
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Set a callback function for use by the logger to retrieve logging
+///        output.
+///
+/// @returns
+///     - ::UR_RESULT_SUCCESS
+///     - ::UR_RESULT_ERROR_UNINITIALIZED
+///     - ::UR_RESULT_ERROR_DEVICE_LOST
+///     - ::UR_RESULT_ERROR_ADAPTER_SPECIFIC
+///     - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE
+///         + `NULL == hAdapter`
+///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
+///         + `NULL == pfnLoggerCallback`
+UR_APIEXPORT ur_result_t UR_APICALL
+urSetLoggerCallback(
+    ur_adapter_handle_t hAdapter,                  ///< [in] handle of the adapter
+    ur_logger_output_callback_t pfnLoggerCallback, ///< [in] Function pointer to callback from the logger.
+    void *pUserData                                ///< [in][out][optional] pointer to data to be passed to callback
+);
+
 #if !defined(__GNUC__)
 #pragma endregion
 #endif
@@ -9667,15 +9670,6 @@ typedef struct ur_loader_config_set_code_location_callback_params_t {
     void **ppUserData;
 } ur_loader_config_set_code_location_callback_params_t;
 
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Function parameters for urLoaderConfigSetLoggerCallback
-/// @details Each entry is a pointer to the parameter passed to the function;
-///     allowing the callback the ability to modify the parameter's value
-typedef struct ur_loader_config_set_logger_callback_params_t {
-    ur_logger_output_callback_t *ppfnLoggerCallback;
-    void **ppUserData;
-} ur_loader_config_set_logger_callback_params_t;
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Function parameters for urPlatformGet
 /// @details Each entry is a pointer to the parameter passed to the function;
@@ -10585,6 +10579,16 @@ typedef struct ur_adapter_get_info_params_t {
     size_t **ppPropSizeRet;
 } ur_adapter_get_info_params_t;
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Function parameters for urSetLoggerCallback
+/// @details Each entry is a pointer to the parameter passed to the function;
+///     allowing the callback the ability to modify the parameter's value
+typedef struct ur_set_logger_callback_params_t {
+    ur_adapter_handle_t *phAdapter;
+    ur_logger_output_callback_t *ppfnLoggerCallback;
+    void **ppUserData;
+} ur_set_logger_callback_params_t;
+
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Function parameters for urEnqueueKernelLaunch
 /// @details Each entry is a pointer to the parameter passed to the function;

include/ur_ddi.h

@@ -1037,6 +1037,13 @@ typedef ur_result_t(UR_APICALL *ur_pfnAdapterGetInfo_t)(
     void *,
     size_t *);
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Function-pointer for urSetLoggerCallback
+typedef ur_result_t(UR_APICALL *ur_pfnSetLoggerCallback_t)(
+    ur_adapter_handle_t,
+    ur_logger_output_callback_t,
+    void *);
+
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Table of Global functions pointers
 typedef struct ur_global_dditable_t {
@@ -1045,6 +1052,7 @@ typedef struct ur_global_dditable_t {
     ur_pfnAdapterRetain_t pfnAdapterRetain;
     ur_pfnAdapterGetLastError_t pfnAdapterGetLastError;
     ur_pfnAdapterGetInfo_t pfnAdapterGetInfo;
+    ur_pfnSetLoggerCallback_t pfnSetLoggerCallback;
 } ur_global_dditable_t;
 
 ///////////////////////////////////////////////////////////////////////////////

include/ur_print.h

@@ -1106,14 +1106,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigEnableLayerParams(const s
 ///         - `buff_size < out_size`
 UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigSetCodeLocationCallbackParams(const struct ur_loader_config_set_code_location_callback_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
 
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Print ur_loader_config_set_logger_callback_params_t struct
-/// @returns
-///     - ::UR_RESULT_SUCCESS
-///     - ::UR_RESULT_ERROR_INVALID_SIZE
-///         - `buff_size < out_size`
-UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigSetLoggerCallbackParams(const struct ur_loader_config_set_logger_callback_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Print ur_platform_get_params_t struct
 /// @returns
@@ -1810,6 +1802,14 @@ UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterGetLastErrorParams(const struc
 ///         - `buff_size < out_size`
 UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterGetInfoParams(const struct ur_adapter_get_info_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Print ur_set_logger_callback_params_t struct
+/// @returns
+///     - ::UR_RESULT_SUCCESS
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         - `buff_size < out_size`
+UR_APIEXPORT ur_result_t UR_APICALL urPrintSetLoggerCallbackParams(const struct ur_set_logger_callback_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
+
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Print ur_enqueue_kernel_launch_params_t struct
 /// @returns

include/ur_print.hpp

@@ -942,8 +942,8 @@ inline std::ostream &operator<<(std::ostream &os, enum ur_function_t value) {
     case UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP:
         os << "UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP";
         break;
-    case UR_FUNCTION_LOADER_CONFIG_SET_LOGGER_CALLBACK:
-        os << "UR_FUNCTION_LOADER_CONFIG_SET_LOGGER_CALLBACK";
+    case UR_FUNCTION_SET_LOGGER_CALLBACK:
+        os << "UR_FUNCTION_SET_LOGGER_CALLBACK";
         break;
     default:
         os << "unknown enumerator";
@@ -10269,26 +10269,6 @@ inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct
     return os;
 }
 
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Print operator for the ur_loader_config_set_logger_callback_params_t type
-/// @returns
-///     std::ostream &
-inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_loader_config_set_logger_callback_params_t *params) {
-
-    os << ".pfnLoggerCallback = ";
-
-    os << reinterpret_cast<void *>(
-        *(params->ppfnLoggerCallback));
-
-    os << ", ";
-    os << ".pUserData = ";
-
-    ur::details::printPtr(os,
-                          *(params->ppUserData));
-
-    return os;
-}
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Print operator for the ur_platform_get_params_t type
 /// @returns
@@ -12767,6 +12747,32 @@ inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct
     return os;
 }
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Print operator for the ur_set_logger_callback_params_t type
+/// @returns
+///     std::ostream &
+inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_set_logger_callback_params_t *params) {
+
+    os << ".hAdapter = ";
+
+    ur::details::printPtr(os,
+                          *(params->phAdapter));
+
+    os << ", ";
+    os << ".pfnLoggerCallback = ";
+
+    os << reinterpret_cast<void *>(
+        *(params->ppfnLoggerCallback));
+
+    os << ", ";
+    os << ".pUserData = ";
+
+    ur::details::printPtr(os,
+                          *(params->ppUserData));
+
+    return os;
+}
+
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Print operator for the ur_enqueue_kernel_launch_params_t type
 /// @returns
@@ -17338,9 +17344,6 @@ inline ur_result_t UR_APICALL printFunctionParams(std::ostream &os, ur_function_
     case UR_FUNCTION_LOADER_CONFIG_SET_CODE_LOCATION_CALLBACK: {
         os << (const struct ur_loader_config_set_code_location_callback_params_t *)params;
     } break;
-    case UR_FUNCTION_LOADER_CONFIG_SET_LOGGER_CALLBACK: {
-        os << (const struct ur_loader_config_set_logger_callback_params_t *)params;
-    } break;
     case UR_FUNCTION_PLATFORM_GET: {
         os << (const struct ur_platform_get_params_t *)params;
     } break;
@@ -17602,6 +17605,9 @@ inline ur_result_t UR_APICALL printFunctionParams(std::ostream &os, ur_function_
     case UR_FUNCTION_ADAPTER_GET_INFO: {
         os << (const struct ur_adapter_get_info_params_t *)params;
     } break;
+    case UR_FUNCTION_SET_LOGGER_CALLBACK: {
+        os << (const struct ur_set_logger_callback_params_t *)params;
+    } break;
     case UR_FUNCTION_ENQUEUE_KERNEL_LAUNCH: {
         os << (const struct ur_enqueue_kernel_launch_params_t *)params;
     } break;

scripts/core/adapter.yml

@@ -200,3 +200,31 @@ etors:
     - name: NATIVE_CPU
       value: "5"
       desc: "The backend is Native CPU"
+--- #--------------------------------------------------------------------------
+type: fptr_typedef
+desc: "Callback function to retrieve output from the logger."
+name: $x_logger_output_callback_t
+return: "void"
+params:
+    - type: const char*
+      name: pLoggerMsg
+      desc: "[in][out] pointer to data to be passed to callback"
+    - type: void*
+      name: pUserData
+      desc: "[in][out] pointer to data to be passed to callback"
+--- #--------------------------------------------------------------------------
+type: function
+desc: "Set a callback function for use by the logger to retrieve logging output."
+class: $x
+name: SetLoggerCallback
+decl: static
+params:
+    - type: $x_adapter_handle_t
+      name: hAdapter
+      desc: "[in] handle of the adapter"
+    - type: $x_logger_output_callback_t
+      name: pfnLoggerCallback
+      desc: "[in] Function pointer to callback from the logger."
+    - type: void*
+      name: pUserData
+      desc: "[in][out][optional] pointer to data to be passed to callback"

scripts/core/loader.yml

@@ -225,29 +225,3 @@ ordinal: "1"
 params: []
 returns:
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
---- #--------------------------------------------------------------------------
-type: fptr_typedef
-desc: "Callback function to retrieve output from the logger."
-name: $x_logger_output_callback_t
-return: "void"
-params:
-    - type: const char*
-      name: pLoggerMsg
-      desc: "[in][out] pointer to data to be passed to callback"
-    - type: void*
-      name: pUserData
-      desc: "[in][out] pointer to data to be passed to callback"
---- #--------------------------------------------------------------------------
-type: function
-desc: "Set a callback function for use by the logger to retrieve logging output."
-class: $xLoaderConfig
-loader_only: True
-name: SetLoggerCallback
-decl: static
-params:
-    - type: $x_logger_output_callback_t
-      name: pfnLoggerCallback
-      desc: "[in] Function pointer to callback from the logger."
-    - type: void*
-      name: pUserData
-      desc: "[in][out][optional] pointer to data to be passed to callback"

scripts/core/registry.yml

@@ -592,9 +592,9 @@ etors:
 - name: ENQUEUE_NATIVE_COMMAND_EXP
   desc: Enumerator for $xEnqueueNativeCommandExp
   value: '228'
-- name: LOADER_CONFIG_SET_LOGGER_CALLBACK
-  desc: Enumerator for $xLoaderConfigSetLoggerCallback
-  value: '229'
+- name: SET_LOGGER_CALLBACK
+  desc: Enumerator for $xSetLoggerCallback
+  value: '230'
 ---
 type: enum
 desc: Defines structure types

source/adapters/cuda/ur_interface_loader.cpp

@@ -209,6 +209,7 @@ UR_DLLEXPORT ur_result_t UR_APICALL urGetGlobalProcAddrTable(
   pDdiTable->pfnAdapterRetain = urAdapterRetain;
   pDdiTable->pfnAdapterGetLastError = urAdapterGetLastError;
   pDdiTable->pfnAdapterGetInfo = urAdapterGetInfo;
+  pDdiTable->pfnSetLoggerCallback = urSetLoggerCallback;
 
   return UR_RESULT_SUCCESS;
 }

source/adapters/hip/ur_interface_loader.cpp

@@ -209,6 +209,7 @@ UR_DLLEXPORT ur_result_t UR_APICALL urGetGlobalProcAddrTable(
   pDdiTable->pfnAdapterGetLastError = urAdapterGetLastError;
   pDdiTable->pfnAdapterRelease = urAdapterRelease;
   pDdiTable->pfnAdapterRetain = urAdapterRetain;
+  pDdiTable->pfnSetLoggerCallback = urSetLoggerCallback;
 
   return UR_RESULT_SUCCESS;
 }

source/adapters/level_zero/ur_interface_loader.cpp

@@ -44,6 +44,7 @@ UR_DLLEXPORT ur_result_t UR_APICALL urGetGlobalProcAddrTable(
   pDdiTable->pfnAdapterRetain = urAdapterRetain;
   pDdiTable->pfnAdapterGetLastError = urAdapterGetLastError;
   pDdiTable->pfnAdapterGetInfo = urAdapterGetInfo;
+  pDdiTable->pfnSetLoggerCallback = urSetLoggerCallback;
 
   return retVal;
 }