Skip to content

Commit 7c297fc

Browse files
martygrantmartygrant
committed
Rerun generate target after applying suggestions from Github web ui. Move entry points from global ddi table to adapter.
Rename the callback function pointer to ur_logger_callback_t.
1 parent 7411e0f commit 7c297fc

31 files changed

+477
-231
lines changed

‎include/ur_api.h‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,8 @@ typedef enum ur_function_t {
226226
UR_FUNCTION_BINDLESS_IMAGES_IMPORT_EXTERNAL_MEMORY_EXP = 226, ///< Enumerator for ::urBindlessImagesImportExternalMemoryExp
227227
UR_FUNCTION_BINDLESS_IMAGES_IMPORT_EXTERNAL_SEMAPHORE_EXP = 227, ///< Enumerator for ::urBindlessImagesImportExternalSemaphoreExp
228228
UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP = 228, ///< Enumerator for ::urEnqueueNativeCommandExp
229-
UR_FUNCTION_SET_LOGGER_CALLBACK = 229, ///< Enumerator for ::urSetLoggerCallback
230-
UR_FUNCTION_SET_LOGGER_CALLBACK_LEVEL = 230, ///< Enumerator for ::urSetLoggerCallbackLevel
229+
UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK = 229, ///< Enumerator for ::urAdapterSetLoggerCallback
230+
UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK_LEVEL = 230, ///< Enumerator for ::urAdapterSetLoggerCallbackLevel
231231
/// @cond
232232
UR_FUNCTION_FORCE_UINT32 = 0x7fffffff
233233
/// @endcond
@@ -1005,7 +1005,7 @@ typedef enum ur_logger_level_t {
10051005

10061006
///////////////////////////////////////////////////////////////////////////////
10071007
/// @brief Callback function to retrieve output from the logger.
1008-
typedef void (*ur_logger_output_callback_t)(
1008+
typedef void (*ur_logger_callback_t)(
10091009
ur_logger_level_t level, ///< [out] Minimum level of messages to be processed by the logger.
10101010
const char *pLoggerMsg, ///< [in][out] pointer to data to be passed to callback
10111011
void *pUserData ///< [in][out] pointer to data to be passed to callback
@@ -1028,11 +1028,11 @@ typedef void (*ur_logger_output_callback_t)(
10281028
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
10291029
/// + `::UR_LOGGER_LEVEL_QUIET < level`
10301030
UR_APIEXPORT ur_result_t UR_APICALL
1031-
urSetLoggerCallback(
1032-
ur_adapter_handle_t hAdapter, ///< [in] handle of the adapter
1033-
ur_logger_output_callback_t pfnLoggerCallback, ///< [in] Function pointer to callback from the logger.
1034-
void *pUserData, ///< [in][out][optional] pointer to data to be passed to callback
1035-
ur_logger_level_t level ///< [in] logging level
1031+
urAdapterSetLoggerCallback(
1032+
ur_adapter_handle_t hAdapter, ///< [in] handle of the adapter
1033+
ur_logger_callback_t pfnLoggerCallback, ///< [in] Function pointer to callback from the logger.
1034+
void *pUserData, ///< [in][out][optional] pointer to data to be passed to callback
1035+
ur_logger_level_t level ///< [in] logging level
10361036
);
10371037

10381038
///////////////////////////////////////////////////////////////////////////////
@@ -1048,7 +1048,7 @@ urSetLoggerCallback(
10481048
/// - ::UR_RESULT_ERROR_INVALID_ENUMERATION
10491049
/// + `::UR_LOGGER_LEVEL_QUIET < level`
10501050
UR_APIEXPORT ur_result_t UR_APICALL
1051-
urSetLoggerCallbackLevel(
1051+
urAdapterSetLoggerCallbackLevel(
10521052
ur_adapter_handle_t hAdapter, ///< [in] handle of the adapter
10531053
ur_logger_level_t level ///< [in] logging level
10541054
);
@@ -9720,6 +9720,26 @@ typedef struct ur_loader_config_set_code_location_callback_params_t {
97209720
void **ppUserData;
97219721
} ur_loader_config_set_code_location_callback_params_t;
97229722

9723+
///////////////////////////////////////////////////////////////////////////////
9724+
/// @brief Function parameters for urAdapterSetLoggerCallback
9725+
/// @details Each entry is a pointer to the parameter passed to the function;
9726+
/// allowing the callback the ability to modify the parameter's value
9727+
typedef struct ur_adapter_set_logger_callback_params_t {
9728+
ur_adapter_handle_t *phAdapter;
9729+
ur_logger_callback_t *ppfnLoggerCallback;
9730+
void **ppUserData;
9731+
ur_logger_level_t *plevel;
9732+
} ur_adapter_set_logger_callback_params_t;
9733+
9734+
///////////////////////////////////////////////////////////////////////////////
9735+
/// @brief Function parameters for urAdapterSetLoggerCallbackLevel
9736+
/// @details Each entry is a pointer to the parameter passed to the function;
9737+
/// allowing the callback the ability to modify the parameter's value
9738+
typedef struct ur_adapter_set_logger_callback_level_params_t {
9739+
ur_adapter_handle_t *phAdapter;
9740+
ur_logger_level_t *plevel;
9741+
} ur_adapter_set_logger_callback_level_params_t;
9742+
97239743
///////////////////////////////////////////////////////////////////////////////
97249744
/// @brief Function parameters for urPlatformGet
97259745
/// @details Each entry is a pointer to the parameter passed to the function;
@@ -10629,26 +10649,6 @@ typedef struct ur_adapter_get_info_params_t {
1062910649
size_t **ppPropSizeRet;
1063010650
} ur_adapter_get_info_params_t;
1063110651

10632-
///////////////////////////////////////////////////////////////////////////////
10633-
/// @brief Function parameters for urSetLoggerCallback
10634-
/// @details Each entry is a pointer to the parameter passed to the function;
10635-
/// allowing the callback the ability to modify the parameter's value
10636-
typedef struct ur_set_logger_callback_params_t {
10637-
ur_adapter_handle_t *phAdapter;
10638-
ur_logger_output_callback_t *ppfnLoggerCallback;
10639-
void **ppUserData;
10640-
ur_logger_level_t *plevel;
10641-
} ur_set_logger_callback_params_t;
10642-
10643-
///////////////////////////////////////////////////////////////////////////////
10644-
/// @brief Function parameters for urSetLoggerCallbackLevel
10645-
/// @details Each entry is a pointer to the parameter passed to the function;
10646-
/// allowing the callback the ability to modify the parameter's value
10647-
typedef struct ur_set_logger_callback_level_params_t {
10648-
ur_adapter_handle_t *phAdapter;
10649-
ur_logger_level_t *plevel;
10650-
} ur_set_logger_callback_level_params_t;
10651-
1065210652
///////////////////////////////////////////////////////////////////////////////
1065310653
/// @brief Function parameters for urEnqueueKernelLaunch
1065410654
/// @details Each entry is a pointer to the parameter passed to the function;

‎include/ur_ddi.h‎

Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,48 @@
2121
extern "C" {
2222
#endif
2323

24+
///////////////////////////////////////////////////////////////////////////////
25+
/// @brief Function-pointer for urAdapterSetLoggerCallback
26+
typedef ur_result_t(UR_APICALL *ur_pfnAdapterSetLoggerCallback_t)(
27+
ur_adapter_handle_t,
28+
ur_logger_callback_t,
29+
void *,
30+
ur_logger_level_t);
31+
32+
///////////////////////////////////////////////////////////////////////////////
33+
/// @brief Function-pointer for urAdapterSetLoggerCallbackLevel
34+
typedef ur_result_t(UR_APICALL *ur_pfnAdapterSetLoggerCallbackLevel_t)(
35+
ur_adapter_handle_t,
36+
ur_logger_level_t);
37+
38+
///////////////////////////////////////////////////////////////////////////////
39+
/// @brief Table of Adapter functions pointers
40+
typedef struct ur_adapter_dditable_t {
41+
ur_pfnAdapterSetLoggerCallback_t pfnSetLoggerCallback;
42+
ur_pfnAdapterSetLoggerCallbackLevel_t pfnSetLoggerCallbackLevel;
43+
} ur_adapter_dditable_t;
44+
45+
///////////////////////////////////////////////////////////////////////////////
46+
/// @brief Exported function for filling application's Adapter table
47+
/// with current process' addresses
48+
///
49+
/// @returns
50+
/// - ::UR_RESULT_SUCCESS
51+
/// - ::UR_RESULT_ERROR_UNINITIALIZED
52+
/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
53+
/// - ::UR_RESULT_ERROR_UNSUPPORTED_VERSION
54+
UR_DLLEXPORT ur_result_t UR_APICALL
55+
urGetAdapterProcAddrTable(
56+
ur_api_version_t version, ///< [in] API version requested
57+
ur_adapter_dditable_t *pDdiTable ///< [in,out] pointer to table of DDI function pointers
58+
);
59+
60+
///////////////////////////////////////////////////////////////////////////////
61+
/// @brief Function-pointer for urGetAdapterProcAddrTable
62+
typedef ur_result_t(UR_APICALL *ur_pfnGetAdapterProcAddrTable_t)(
63+
ur_api_version_t,
64+
ur_adapter_dditable_t *);
65+
2466
///////////////////////////////////////////////////////////////////////////////
2567
/// @brief Function-pointer for urPlatformGet
2668
typedef ur_result_t(UR_APICALL *ur_pfnPlatformGet_t)(
@@ -1037,20 +1079,6 @@ typedef ur_result_t(UR_APICALL *ur_pfnAdapterGetInfo_t)(
10371079
void *,
10381080
size_t *);
10391081

1040-
///////////////////////////////////////////////////////////////////////////////
1041-
/// @brief Function-pointer for urSetLoggerCallback
1042-
typedef ur_result_t(UR_APICALL *ur_pfnSetLoggerCallback_t)(
1043-
ur_adapter_handle_t,
1044-
ur_logger_output_callback_t,
1045-
void *,
1046-
ur_logger_level_t);
1047-
1048-
///////////////////////////////////////////////////////////////////////////////
1049-
/// @brief Function-pointer for urSetLoggerCallbackLevel
1050-
typedef ur_result_t(UR_APICALL *ur_pfnSetLoggerCallbackLevel_t)(
1051-
ur_adapter_handle_t,
1052-
ur_logger_level_t);
1053-
10541082
///////////////////////////////////////////////////////////////////////////////
10551083
/// @brief Table of Global functions pointers
10561084
typedef struct ur_global_dditable_t {
@@ -1059,8 +1087,6 @@ typedef struct ur_global_dditable_t {
10591087
ur_pfnAdapterRetain_t pfnAdapterRetain;
10601088
ur_pfnAdapterGetLastError_t pfnAdapterGetLastError;
10611089
ur_pfnAdapterGetInfo_t pfnAdapterGetInfo;
1062-
ur_pfnSetLoggerCallback_t pfnSetLoggerCallback;
1063-
ur_pfnSetLoggerCallbackLevel_t pfnSetLoggerCallbackLevel;
10641090
} ur_global_dditable_t;
10651091

10661092
///////////////////////////////////////////////////////////////////////////////
@@ -2426,6 +2452,7 @@ typedef ur_result_t(UR_APICALL *ur_pfnGetDeviceProcAddrTable_t)(
24262452
///////////////////////////////////////////////////////////////////////////////
24272453
/// @brief Container for all DDI tables
24282454
typedef struct ur_dditable_t {
2455+
ur_adapter_dditable_t Adapter;
24292456
ur_platform_dditable_t Platform;
24302457
ur_context_dditable_t Context;
24312458
ur_event_dditable_t Event;

‎include/ur_print.h‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1114,6 +1114,22 @@ UR_APIEXPORT ur_result_t UR_APICALL urPrintLoaderConfigEnableLayerParams(const s
11141114
/// - `buff_size < out_size`
11151115
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);
11161116

1117+
///////////////////////////////////////////////////////////////////////////////
1118+
/// @brief Print ur_adapter_set_logger_callback_params_t struct
1119+
/// @returns
1120+
/// - ::UR_RESULT_SUCCESS
1121+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
1122+
/// - `buff_size < out_size`
1123+
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterSetLoggerCallbackParams(const struct ur_adapter_set_logger_callback_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
1124+
1125+
///////////////////////////////////////////////////////////////////////////////
1126+
/// @brief Print ur_adapter_set_logger_callback_level_params_t struct
1127+
/// @returns
1128+
/// - ::UR_RESULT_SUCCESS
1129+
/// - ::UR_RESULT_ERROR_INVALID_SIZE
1130+
/// - `buff_size < out_size`
1131+
UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterSetLoggerCallbackLevelParams(const struct ur_adapter_set_logger_callback_level_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
1132+
11171133
///////////////////////////////////////////////////////////////////////////////
11181134
/// @brief Print ur_platform_get_params_t struct
11191135
/// @returns
@@ -1810,22 +1826,6 @@ UR_APIEXPORT ur_result_t UR_APICALL urPrintAdapterGetLastErrorParams(const struc
18101826
/// - `buff_size < out_size`
18111827
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);
18121828

1813-
///////////////////////////////////////////////////////////////////////////////
1814-
/// @brief Print ur_set_logger_callback_params_t struct
1815-
/// @returns
1816-
/// - ::UR_RESULT_SUCCESS
1817-
/// - ::UR_RESULT_ERROR_INVALID_SIZE
1818-
/// - `buff_size < out_size`
1819-
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);
1820-
1821-
///////////////////////////////////////////////////////////////////////////////
1822-
/// @brief Print ur_set_logger_callback_level_params_t struct
1823-
/// @returns
1824-
/// - ::UR_RESULT_SUCCESS
1825-
/// - ::UR_RESULT_ERROR_INVALID_SIZE
1826-
/// - `buff_size < out_size`
1827-
UR_APIEXPORT ur_result_t UR_APICALL urPrintSetLoggerCallbackLevelParams(const struct ur_set_logger_callback_level_params_t *params, char *buffer, const size_t buff_size, size_t *out_size);
1828-
18291829
///////////////////////////////////////////////////////////////////////////////
18301830
/// @brief Print ur_enqueue_kernel_launch_params_t struct
18311831
/// @returns

‎include/ur_print.hpp‎

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -943,11 +943,11 @@ inline std::ostream &operator<<(std::ostream &os, enum ur_function_t value) {
943943
case UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP:
944944
os << "UR_FUNCTION_ENQUEUE_NATIVE_COMMAND_EXP";
945945
break;
946-
case UR_FUNCTION_SET_LOGGER_CALLBACK:
947-
os << "UR_FUNCTION_SET_LOGGER_CALLBACK";
946+
case UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK:
947+
os << "UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK";
948948
break;
949-
case UR_FUNCTION_SET_LOGGER_CALLBACK_LEVEL:
950-
os << "UR_FUNCTION_SET_LOGGER_CALLBACK_LEVEL";
949+
case UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK_LEVEL:
950+
os << "UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK_LEVEL";
951951
break;
952952
default:
953953
os << "unknown enumerator";
@@ -10315,6 +10315,56 @@ inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct
1031510315
return os;
1031610316
}
1031710317

10318+
///////////////////////////////////////////////////////////////////////////////
10319+
/// @brief Print operator for the ur_adapter_set_logger_callback_params_t type
10320+
/// @returns
10321+
/// std::ostream &
10322+
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_set_logger_callback_params_t *params) {
10323+
10324+
os << ".hAdapter = ";
10325+
10326+
ur::details::printPtr(os,
10327+
*(params->phAdapter));
10328+
10329+
os << ", ";
10330+
os << ".pfnLoggerCallback = ";
10331+
10332+
os << reinterpret_cast<void *>(
10333+
*(params->ppfnLoggerCallback));
10334+
10335+
os << ", ";
10336+
os << ".pUserData = ";
10337+
10338+
ur::details::printPtr(os,
10339+
*(params->ppUserData));
10340+
10341+
os << ", ";
10342+
os << ".level = ";
10343+
10344+
os << *(params->plevel);
10345+
10346+
return os;
10347+
}
10348+
10349+
///////////////////////////////////////////////////////////////////////////////
10350+
/// @brief Print operator for the ur_adapter_set_logger_callback_level_params_t type
10351+
/// @returns
10352+
/// std::ostream &
10353+
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_adapter_set_logger_callback_level_params_t *params) {
10354+
10355+
os << ".hAdapter = ";
10356+
10357+
ur::details::printPtr(os,
10358+
*(params->phAdapter));
10359+
10360+
os << ", ";
10361+
os << ".level = ";
10362+
10363+
os << *(params->plevel);
10364+
10365+
return os;
10366+
}
10367+
1031810368
///////////////////////////////////////////////////////////////////////////////
1031910369
/// @brief Print operator for the ur_platform_get_params_t type
1032010370
/// @returns
@@ -12793,56 +12843,6 @@ inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct
1279312843
return os;
1279412844
}
1279512845

12796-
///////////////////////////////////////////////////////////////////////////////
12797-
/// @brief Print operator for the ur_set_logger_callback_params_t type
12798-
/// @returns
12799-
/// std::ostream &
12800-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_set_logger_callback_params_t *params) {
12801-
12802-
os << ".hAdapter = ";
12803-
12804-
ur::details::printPtr(os,
12805-
*(params->phAdapter));
12806-
12807-
os << ", ";
12808-
os << ".pfnLoggerCallback = ";
12809-
12810-
os << reinterpret_cast<void *>(
12811-
*(params->ppfnLoggerCallback));
12812-
12813-
os << ", ";
12814-
os << ".pUserData = ";
12815-
12816-
ur::details::printPtr(os,
12817-
*(params->ppUserData));
12818-
12819-
os << ", ";
12820-
os << ".level = ";
12821-
12822-
os << *(params->plevel);
12823-
12824-
return os;
12825-
}
12826-
12827-
///////////////////////////////////////////////////////////////////////////////
12828-
/// @brief Print operator for the ur_set_logger_callback_level_params_t type
12829-
/// @returns
12830-
/// std::ostream &
12831-
inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_set_logger_callback_level_params_t *params) {
12832-
12833-
os << ".hAdapter = ";
12834-
12835-
ur::details::printPtr(os,
12836-
*(params->phAdapter));
12837-
12838-
os << ", ";
12839-
os << ".level = ";
12840-
12841-
os << *(params->plevel);
12842-
12843-
return os;
12844-
}
12845-
1284612846
///////////////////////////////////////////////////////////////////////////////
1284712847
/// @brief Print operator for the ur_enqueue_kernel_launch_params_t type
1284812848
/// @returns
@@ -17414,6 +17414,12 @@ inline ur_result_t UR_APICALL printFunctionParams(std::ostream &os, ur_function_
1741417414
case UR_FUNCTION_LOADER_CONFIG_SET_CODE_LOCATION_CALLBACK: {
1741517415
os << (const struct ur_loader_config_set_code_location_callback_params_t *)params;
1741617416
} break;
17417+
case UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK: {
17418+
os << (const struct ur_adapter_set_logger_callback_params_t *)params;
17419+
} break;
17420+
case UR_FUNCTION_ADAPTER_SET_LOGGER_CALLBACK_LEVEL: {
17421+
os << (const struct ur_adapter_set_logger_callback_level_params_t *)params;
17422+
} break;
1741717423
case UR_FUNCTION_PLATFORM_GET: {
1741817424
os << (const struct ur_platform_get_params_t *)params;
1741917425
} break;
@@ -17675,12 +17681,6 @@ inline ur_result_t UR_APICALL printFunctionParams(std::ostream &os, ur_function_
1767517681
case UR_FUNCTION_ADAPTER_GET_INFO: {
1767617682
os << (const struct ur_adapter_get_info_params_t *)params;
1767717683
} break;
17678-
case UR_FUNCTION_SET_LOGGER_CALLBACK: {
17679-
os << (const struct ur_set_logger_callback_params_t *)params;
17680-
} break;
17681-
case UR_FUNCTION_SET_LOGGER_CALLBACK_LEVEL: {
17682-
os << (const struct ur_set_logger_callback_level_params_t *)params;
17683-
} break;
1768417684
case UR_FUNCTION_ENQUEUE_KERNEL_LAUNCH: {
1768517685
os << (const struct ur_enqueue_kernel_launch_params_t *)params;
1768617686
} break;

‎scripts/core/INTRO.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ An example of an environment variable for setting up the null adapter library wi
234234

235235
Logging callback
236236
^^^^^^^^^^^^^^^^^^^^^
237-
An API is available to configure the logging callback function :ref:`urSetLoggerCallback`. Additionally, the logging level can be set using :ref:`urSetLoggerCallbackLevel`.
237+
An API is available to configure the logging callback function :ref:`urAdapterSetLoggerCallback`. Additionally, the logging level can be set using :ref:`urAdapterSetLoggerCallbackLevel`.
238238

239239
Adapter Discovery
240240
---------------------

0 commit comments

Comments
 (0)