[UR] Refer to platform instead of adapter

veselypeta · veselypeta · commit 70db45f7ea40 · 2023-04-12T10:14:01.000+01:00
diff --git a/include/ur_api.h b/include/ur_api.h
@@ -523,14 +523,14 @@ urPlatformCreateWithNativeHandle(
 );
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief Get the adapter specific compiler backend option from a generic
+/// @brief Get the platform specific compiler backend option from a generic
 ///        frontend option.
 ///
 /// @details
-///     - The string returned via the ppAdapterOption is a NULL terminated C
+///     - The string returned via the ppPlatformOption is a NULL terminated C
 ///       style string.
-///     - The string returned via the ppAdapterOption is thread local.
-///     - The memory in the string returned via the ppAdapterOption is owned by
+///     - The string returned via the ppPlatformOption is thread local.
+///     - The memory in the string returned via the ppPlatformOption is owned by
 ///       the adapter.
 ///     - The application may call this function from simultaneous threads.
 ///     - The implementation of this function should be lock-free.
@@ -543,15 +543,15 @@ urPlatformCreateWithNativeHandle(
 ///         + `NULL == hPlatform`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == pFrontendOption`
-///         + `NULL == ppAdapterOption`
+///         + `NULL == ppPlatformOption`
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 ///         + If `pFrontendOption` is not a valid frontend option.
 UR_APIEXPORT ur_result_t UR_APICALL
 urPlatformGetBackendOption(
     ur_platform_handle_t hPlatform, ///< [in] handle of the platform instance.
     const char *pFrontendOption,    ///< [in] string containing the frontend option.
-    const char **ppAdapterOption    ///< [out] returns the correct adapter specific option based on the
-                                    ///< frontend option.
+    const char **ppPlatformOption   ///< [out] returns the correct platform specific compiler option based on
+                                    ///< the frontend option.
 );
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -5566,7 +5566,7 @@ typedef void(UR_APICALL *ur_pfnPlatformGetApiVersionCb_t)(
 typedef struct ur_platform_get_backend_option_params_t {
     ur_platform_handle_t *phPlatform;
     const char **ppFrontendOption;
-    const char ***pppAdapterOption;
+    const char ***pppPlatformOption;
 } ur_platform_get_backend_option_params_t;
 
 ///////////////////////////////////////////////////////////////////////////////
diff --git a/scripts/core/platform.yml b/scripts/core/platform.yml
@@ -168,14 +168,14 @@ params:
             [out] pointer to the handle of the platform object created.
 --- #--------------------------------------------------------------------------
 type: function
-desc: "Get the adapter specific compiler backend option from a generic frontend option."
+desc: "Get the platform specific compiler backend option from a generic frontend option."
 class: $xPlatform
 name: GetBackendOption
 decl: static
 details:
-    - "The string returned via the ppAdapterOption is a NULL terminated C style string."
-    - "The string returned via the ppAdapterOption is thread local."
-    - "The memory in the string returned via the ppAdapterOption is owned by the adapter."
+    - "The string returned via the ppPlatformOption is a NULL terminated C style string."
+    - "The string returned via the ppPlatformOption is thread local."
+    - "The memory in the string returned via the ppPlatformOption is owned by the adapter."
     - "The application may call this function from simultaneous threads."
     - "The implementation of this function should be lock-free."
 params:
@@ -186,8 +186,8 @@ params:
       name: pFrontendOption
       desc: "[in] string containing the frontend option."
     - type: const char**
-      name: ppAdapterOption
-      desc: "[out] returns the correct adapter specific option based on the frontend option."
+      name: ppPlatformOption
+      desc: "[out] returns the correct platform specific compiler option based on the frontend option."
 returns:
     - $X_RESULT_ERROR_INVALID_VALUE:
       - "If `pFrontendOption` is not a valid frontend option."
diff --git a/source/common/ur_params.hpp b/source/common/ur_params.hpp
@@ -6748,9 +6748,9 @@ operator<<(std::ostream &os,
     ur_params::serializePtr(os, *(params->ppFrontendOption));
 
     os << ", ";
-    os << ".ppAdapterOption = ";
+    os << ".ppPlatformOption = ";
 
-    ur_params::serializePtr(os, *(params->pppAdapterOption));
+    ur_params::serializePtr(os, *(params->pppPlatformOption));
 
     return os;
 }
diff --git a/source/drivers/null/ur_nullddi.cpp b/source/drivers/null/ur_nullddi.cpp
@@ -177,8 +177,8 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
     const char
         *pFrontendOption, ///< [in] string containing the frontend option.
     const char **
-        ppAdapterOption ///< [out] returns the correct adapter specific option based on the
-                        ///< frontend option.
+        ppPlatformOption ///< [out] returns the correct platform specific compiler option based on
+                         ///< the frontend option.
 ) {
     ur_result_t result = UR_RESULT_SUCCESS;
 
@@ -187,7 +187,7 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
         d_context.urDdiTable.Platform.pfnGetBackendOption;
     if (nullptr != pfnGetBackendOption) {
         result =
-            pfnGetBackendOption(hPlatform, pFrontendOption, ppAdapterOption);
+            pfnGetBackendOption(hPlatform, pFrontendOption, ppPlatformOption);
     } else {
         // generic implementation
     }
diff --git a/source/loader/layers/tracing/ur_trcddi.cpp b/source/loader/layers/tracing/ur_trcddi.cpp
@@ -215,8 +215,8 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
     const char
         *pFrontendOption, ///< [in] string containing the frontend option.
     const char **
-        ppAdapterOption ///< [out] returns the correct adapter specific option based on the
-                        ///< frontend option.
+        ppPlatformOption ///< [out] returns the correct platform specific compiler option based on
+                         ///< the frontend option.
 ) {
     auto pfnGetBackendOption = context.urDdiTable.Platform.pfnGetBackendOption;
 
@@ -225,13 +225,13 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
     }
 
     ur_platform_get_backend_option_params_t params = {
-        &hPlatform, &pFrontendOption, &ppAdapterOption};
+        &hPlatform, &pFrontendOption, &ppPlatformOption};
     uint64_t instance =
         context.notify_begin(UR_FUNCTION_PLATFORM_GET_BACKEND_OPTION,
                              "urPlatformGetBackendOption", &params);
 
     ur_result_t result =
-        pfnGetBackendOption(hPlatform, pFrontendOption, ppAdapterOption);
+        pfnGetBackendOption(hPlatform, pFrontendOption, ppPlatformOption);
 
     context.notify_end(UR_FUNCTION_PLATFORM_GET_BACKEND_OPTION,
                        "urPlatformGetBackendOption", &params, &result,
diff --git a/source/loader/layers/validation/ur_valddi.cpp b/source/loader/layers/validation/ur_valddi.cpp
@@ -218,8 +218,8 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
     const char
         *pFrontendOption, ///< [in] string containing the frontend option.
     const char **
-        ppAdapterOption ///< [out] returns the correct adapter specific option based on the
-                        ///< frontend option.
+        ppPlatformOption ///< [out] returns the correct platform specific compiler option based on
+                         ///< the frontend option.
 ) {
     auto pfnGetBackendOption = context.urDdiTable.Platform.pfnGetBackendOption;
 
@@ -236,13 +236,13 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
             return UR_RESULT_ERROR_INVALID_NULL_POINTER;
         }
 
-        if (NULL == ppAdapterOption) {
+        if (NULL == ppPlatformOption) {
             return UR_RESULT_ERROR_INVALID_NULL_POINTER;
         }
     }
 
     ur_result_t result =
-        pfnGetBackendOption(hPlatform, pFrontendOption, ppAdapterOption);
+        pfnGetBackendOption(hPlatform, pFrontendOption, ppPlatformOption);
 
     return result;
 }
diff --git a/source/loader/ur_ldrddi.cpp b/source/loader/ur_ldrddi.cpp
@@ -280,8 +280,8 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
     const char
         *pFrontendOption, ///< [in] string containing the frontend option.
     const char **
-        ppAdapterOption ///< [out] returns the correct adapter specific option based on the
-                        ///< frontend option.
+        ppPlatformOption ///< [out] returns the correct platform specific compiler option based on
+                         ///< the frontend option.
 ) {
     ur_result_t result = UR_RESULT_SUCCESS;
 
@@ -297,7 +297,7 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(
     hPlatform = reinterpret_cast<ur_platform_object_t *>(hPlatform)->handle;
 
     // forward to device-platform
-    result = pfnGetBackendOption(hPlatform, pFrontendOption, ppAdapterOption);
+    result = pfnGetBackendOption(hPlatform, pFrontendOption, ppPlatformOption);
 
     return result;
 }
diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp
@@ -252,14 +252,14 @@ ur_result_t UR_APICALL urPlatformCreateWithNativeHandle(
 }
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief Get the adapter specific compiler backend option from a generic
+/// @brief Get the platform specific compiler backend option from a generic
 ///        frontend option.
 ///
 /// @details
-///     - The string returned via the ppAdapterOption is a NULL terminated C
+///     - The string returned via the ppPlatformOption is a NULL terminated C
 ///       style string.
-///     - The string returned via the ppAdapterOption is thread local.
-///     - The memory in the string returned via the ppAdapterOption is owned by
+///     - The string returned via the ppPlatformOption is thread local.
+///     - The memory in the string returned via the ppPlatformOption is owned by
 ///       the adapter.
 ///     - The application may call this function from simultaneous threads.
 ///     - The implementation of this function should be lock-free.
@@ -272,24 +272,24 @@ ur_result_t UR_APICALL urPlatformCreateWithNativeHandle(
 ///         + `NULL == hPlatform`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == pFrontendOption`
-///         + `NULL == ppAdapterOption`
+///         + `NULL == ppPlatformOption`
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 ///         + If `pFrontendOption` is not a valid frontend option.
 ur_result_t UR_APICALL urPlatformGetBackendOption(
     ur_platform_handle_t hPlatform, ///< [in] handle of the platform instance.
     const char
         *pFrontendOption, ///< [in] string containing the frontend option.
     const char **
-        ppAdapterOption ///< [out] returns the correct adapter specific option based on the
-                        ///< frontend option.
+        ppPlatformOption ///< [out] returns the correct platform specific compiler option based on
+                         ///< the frontend option.
 ) {
     auto pfnGetBackendOption =
         ur_lib::context->urDdiTable.Platform.pfnGetBackendOption;
     if (nullptr == pfnGetBackendOption) {
         return UR_RESULT_ERROR_UNINITIALIZED;
     }
 
-    return pfnGetBackendOption(hPlatform, pFrontendOption, ppAdapterOption);
+    return pfnGetBackendOption(hPlatform, pFrontendOption, ppPlatformOption);
 }
 
 ///////////////////////////////////////////////////////////////////////////////
diff --git a/source/ur_api.cpp b/source/ur_api.cpp
@@ -208,14 +208,14 @@ ur_result_t UR_APICALL urPlatformCreateWithNativeHandle(
 }
 
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief Get the adapter specific compiler backend option from a generic
+/// @brief Get the platform specific compiler backend option from a generic
 ///        frontend option.
 ///
 /// @details
-///     - The string returned via the ppAdapterOption is a NULL terminated C
+///     - The string returned via the ppPlatformOption is a NULL terminated C
 ///       style string.
-///     - The string returned via the ppAdapterOption is thread local.
-///     - The memory in the string returned via the ppAdapterOption is owned by
+///     - The string returned via the ppPlatformOption is thread local.
+///     - The memory in the string returned via the ppPlatformOption is owned by
 ///       the adapter.
 ///     - The application may call this function from simultaneous threads.
 ///     - The implementation of this function should be lock-free.
@@ -228,16 +228,16 @@ ur_result_t UR_APICALL urPlatformCreateWithNativeHandle(
 ///         + `NULL == hPlatform`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == pFrontendOption`
-///         + `NULL == ppAdapterOption`
+///         + `NULL == ppPlatformOption`
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 ///         + If `pFrontendOption` is not a valid frontend option.
 ur_result_t UR_APICALL urPlatformGetBackendOption(
     ur_platform_handle_t hPlatform, ///< [in] handle of the platform instance.
     const char
         *pFrontendOption, ///< [in] string containing the frontend option.
     const char **
-        ppAdapterOption ///< [out] returns the correct adapter specific option based on the
-                        ///< frontend option.
+        ppPlatformOption ///< [out] returns the correct platform specific compiler option based on
+                         ///< the frontend option.
 ) {
     ur_result_t result = UR_RESULT_SUCCESS;
     return result;
diff --git a/test/conformance/platform/urPlatformGetBackendOption.cpp b/test/conformance/platform/urPlatformGetBackendOption.cpp
@@ -13,36 +13,36 @@ INSTANTIATE_TEST_SUITE_P(, urPlatfromGetBackendOptionTestWithParam,
                          });
 
 TEST_P(urPlatfromGetBackendOptionTestWithParam, Success) {
-    const char *adapterOption = nullptr;
+    const char *platformOption = nullptr;
     ASSERT_SUCCESS(urPlatformGetBackendOption(platform, GetParam().c_str(),
-                                              &adapterOption));
-    ASSERT_NE(adapterOption, nullptr);
+                                              &platformOption));
+    ASSERT_NE(platformOption, nullptr);
 }
 
 using urPlatfromGetBackendOptionTest = uur::platform::urPlatformTest;
 
 TEST_F(urPlatfromGetBackendOptionTest, InvalidNullHandle) {
-    const char *adapterOption = nullptr;
+    const char *platformOption = nullptr;
     ASSERT_EQ_RESULT(
         UR_RESULT_ERROR_INVALID_NULL_HANDLE,
-        urPlatformGetBackendOption(nullptr, "-O0", &adapterOption));
+        urPlatformGetBackendOption(nullptr, "-O0", &platformOption));
 }
 
 TEST_F(urPlatfromGetBackendOptionTest, InvalidNullPointerFrontendOption) {
-    const char *adapterOption = nullptr;
+    const char *platformOption = nullptr;
     ASSERT_EQ_RESULT(
         UR_RESULT_ERROR_INVALID_NULL_POINTER,
-        urPlatformGetBackendOption(platform, nullptr, &adapterOption));
+        urPlatformGetBackendOption(platform, nullptr, &platformOption));
 }
 
-TEST_F(urPlatfromGetBackendOptionTest, InvalidNullPointerAdapterOption) {
+TEST_F(urPlatfromGetBackendOptionTest, InvalidNullPointerPlatformOption) {
     ASSERT_EQ_RESULT(UR_RESULT_ERROR_INVALID_NULL_POINTER,
                      urPlatformGetBackendOption(platform, "-O0", nullptr));
 }
 
 TEST_F(urPlatfromGetBackendOptionTest, InvalidValueFrontendOption) {
-    const char *adapterOption = nullptr;
+    const char *platformOption = nullptr;
     ASSERT_EQ_RESULT(
         UR_RESULT_ERROR_INVALID_VALUE,
-        urPlatformGetBackendOption(platform, "-sycl-sucks", &adapterOption));
+        urPlatformGetBackendOption(platform, "-sycl-sucks", &platformOption));
 }

Original file line number	Diff line number	Diff line change
`@@ -6748,9 +6748,9 @@ operator<<(std::ostream &os,`
`6748`	`6748`	`ur_params::serializePtr(os, *(params->ppFrontendOption));`
`6749`	`6749`
`6750`	`6750`	`os << ", ";`
`6751`		`- os << ".ppAdapterOption = ";`
	`6751`	`+ os << ".ppPlatformOption = ";`
`6752`	`6752`
`6753`		`- ur_params::serializePtr(os, *(params->pppAdapterOption));`
	`6753`	`+ ur_params::serializePtr(os, *(params->pppPlatformOption));`
`6754`	`6754`
`6755`	`6755`	`return os;`
`6756`	`6756`	`}`
Original file line number	Diff line number	Diff line change
`@@ -218,8 +218,8 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(`
`218`	`218`	`const char`
`219`	`219`	`*pFrontendOption, ///< [in] string containing the frontend option.`
`220`	`220`	`const char **`
`221`		`- ppAdapterOption ///< [out] returns the correct adapter specific option based on the`
`222`		`- ///< frontend option.`
	`221`	`+ ppPlatformOption ///< [out] returns the correct platform specific compiler option based on`
	`222`	`+ ///< the frontend option.`
`223`	`223`	`) {`
`224`	`224`	`auto pfnGetBackendOption = context.urDdiTable.Platform.pfnGetBackendOption;`
`225`	`225`
`@@ -236,13 +236,13 @@ __urdlllocal ur_result_t UR_APICALL urPlatformGetBackendOption(`
`236`	`236`	`return UR_RESULT_ERROR_INVALID_NULL_POINTER;`
`237`	`237`	`}`
`238`	`238`
`239`		`- if (NULL == ppAdapterOption) {`
	`239`	`+ if (NULL == ppPlatformOption) {`
`240`	`240`	`return UR_RESULT_ERROR_INVALID_NULL_POINTER;`
`241`	`241`	`}`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`ur_result_t result =`
`245`		`- pfnGetBackendOption(hPlatform, pFrontendOption, ppAdapterOption);`
	`245`	`+ pfnGetBackendOption(hPlatform, pFrontendOption, ppPlatformOption);`
`246`	`246`
`247`	`247`	`return result;`
`248`	`248`	`}`