Merge pull request #860 from veselypeta/petr/fix-device-get-errorcodes

[UR] Add validation check to urDeviceGet

Author: pbalcer

include/ur_api.h

@@ -1306,6 +1306,8 @@ typedef enum ur_device_type_t {
 ///         + `::UR_DEVICE_TYPE_VPU < DeviceType`
 ///     - ::UR_RESULT_ERROR_INVALID_SIZE
 ///         + `NumEntries == 0 && phDevices != NULL`
+///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
+///         + `NumEntries > 0 && phDevices == NULL`
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 UR_APIEXPORT ur_result_t UR_APICALL
 urDeviceGet(

scripts/core/device.yml

@@ -146,6 +146,8 @@ params:
 returns:
     - $X_RESULT_ERROR_INVALID_SIZE:
         - "`NumEntries == 0 && phDevices != NULL`"
+    - $X_RESULT_ERROR_INVALID_NULL_POINTER:
+        - "`NumEntries > 0 && phDevices == NULL`"
     - $X_RESULT_ERROR_INVALID_VALUE
 --- #--------------------------------------------------------------------------
 type: enum

source/loader/layers/validation/ur_valddi.cpp

@@ -419,6 +419,10 @@ __urdlllocal ur_result_t UR_APICALL urDeviceGet(
             return UR_RESULT_ERROR_INVALID_NULL_HANDLE;
         }
 
+        if (NumEntries > 0 && phDevices == NULL) {
+            return UR_RESULT_ERROR_INVALID_NULL_POINTER;
+        }
+
         if (UR_DEVICE_TYPE_VPU < DeviceType) {
             return UR_RESULT_ERROR_INVALID_ENUMERATION;
         }

source/loader/ur_libapi.cpp

@@ -714,6 +714,8 @@ ur_result_t UR_APICALL urPlatformGetBackendOption(
 ///         + `::UR_DEVICE_TYPE_VPU < DeviceType`
 ///     - ::UR_RESULT_ERROR_INVALID_SIZE
 ///         + `NumEntries == 0 && phDevices != NULL`
+///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
+///         + `NumEntries > 0 && phDevices == NULL`
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 ur_result_t UR_APICALL urDeviceGet(
     ur_platform_handle_t hPlatform, ///< [in] handle of the platform instance

source/ur_api.cpp

@@ -618,6 +618,8 @@ ur_result_t UR_APICALL urPlatformGetBackendOption(
 ///         + `::UR_DEVICE_TYPE_VPU < DeviceType`
 ///     - ::UR_RESULT_ERROR_INVALID_SIZE
 ///         + `NumEntries == 0 && phDevices != NULL`
+///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
+///         + `NumEntries > 0 && phDevices == NULL`
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 ur_result_t UR_APICALL urDeviceGet(
     ur_platform_handle_t hPlatform, ///< [in] handle of the platform instance

test/conformance/device/urDeviceGet.cpp

@@ -49,7 +49,7 @@ TEST_F(urDeviceGetTest, InvalidEnumerationDevicesType) {
         urDeviceGet(platform, UR_DEVICE_TYPE_FORCE_UINT32, 0, nullptr, &count));
 }
 
-TEST_F(urDeviceGetTest, InvalidValueNumEntries) {
+TEST_F(urDeviceGetTest, InvalidSizeNumEntries) {
     uint32_t count = 0;
     ASSERT_SUCCESS(
         urDeviceGet(platform, UR_DEVICE_TYPE_ALL, 0, nullptr, &count));
@@ -59,3 +59,13 @@ TEST_F(urDeviceGetTest, InvalidValueNumEntries) {
         UR_RESULT_ERROR_INVALID_SIZE,
         urDeviceGet(platform, UR_DEVICE_TYPE_ALL, 0, devices.data(), nullptr));
 }
+
+TEST_F(urDeviceGetTest, InvalidNullPointerDevices) {
+    uint32_t count = 0;
+    ASSERT_SUCCESS(
+        urDeviceGet(platform, UR_DEVICE_TYPE_ALL, 0, nullptr, &count));
+    ASSERT_NE(count, 0);
+    ASSERT_EQ_RESULT(
+        UR_RESULT_ERROR_INVALID_NULL_POINTER,
+        urDeviceGet(platform, UR_DEVICE_TYPE_ALL, count, nullptr, nullptr));
+}