Add tests for urEnqueueUSMMemset2D (#297)

Author: Fábio

include/ur.py

@@ -169,7 +169,8 @@ class ur_result_v(IntEnum):
     ERROR_INVALID_NULL_HANDLE = 48                  ## [Validation] handle argument is not valid
     ERROR_HANDLE_OBJECT_IN_USE = 49                 ## [Validation] object pointed to by handle still in-use by device
     ERROR_INVALID_NULL_POINTER = 50                 ## [Validation] pointer argument may not be nullptr
-    ERROR_INVALID_SIZE = 51                         ## [Validation] size argument is invalid (e.g., must not be zero)
+    ERROR_INVALID_SIZE = 51                         ## [Validation] invalid size or dimensions (e.g., must not be zero, or is
+                                                    ## out of bounds)
     ERROR_UNSUPPORTED_SIZE = 52                     ## [Validation] size argument is not supported by the device (e.g., too
                                                     ## large)
     ERROR_UNSUPPORTED_ALIGNMENT = 53                ## [Validation] alignment argument is not supported by the device (e.g.,

include/ur_api.h

@@ -192,7 +192,8 @@ typedef enum ur_result_t {
     UR_RESULT_ERROR_INVALID_NULL_HANDLE = 48,             ///< [Validation] handle argument is not valid
     UR_RESULT_ERROR_HANDLE_OBJECT_IN_USE = 49,            ///< [Validation] object pointed to by handle still in-use by device
     UR_RESULT_ERROR_INVALID_NULL_POINTER = 50,            ///< [Validation] pointer argument may not be nullptr
-    UR_RESULT_ERROR_INVALID_SIZE = 51,                    ///< [Validation] size argument is invalid (e.g., must not be zero)
+    UR_RESULT_ERROR_INVALID_SIZE = 51,                    ///< [Validation] invalid size or dimensions (e.g., must not be zero, or is
+                                                          ///< out of bounds)
     UR_RESULT_ERROR_UNSUPPORTED_SIZE = 52,                ///< [Validation] size argument is not supported by the device (e.g., too
                                                           ///< large)
     UR_RESULT_ERROR_UNSUPPORTED_ALIGNMENT = 53,           ///< [Validation] alignment argument is not supported by the device (e.g.,
@@ -1426,6 +1427,12 @@ urEnqueueUSMFill2D(
 ///         + `NULL == hQueue`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == pMem`
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         + `pitch == 0`
+///         + `width == 0`
+///         + `height == 0`
+///         + `pitch < width`
+///         + `pitch * height` is higher than the memory allocation size
 ///     - ::UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
 ///         + `phEventWaitList == NULL && numEventsInWaitList > 0`
 ///         + `phEventWaitList != NULL && numEventsInWaitList == 0`

scripts/core/common.yml

@@ -225,7 +225,7 @@ etors:
     - name: ERROR_INVALID_NULL_POINTER
       desc: "[Validation] pointer argument may not be nullptr"
     - name: ERROR_INVALID_SIZE
-      desc: "[Validation] size argument is invalid (e.g., must not be zero)"
+      desc: "[Validation] invalid size or dimensions (e.g., must not be zero, or is out of bounds)"
     - name: ERROR_UNSUPPORTED_SIZE
       desc: "[Validation] size argument is not supported by the device (e.g., too large)"
     - name: ERROR_UNSUPPORTED_ALIGNMENT

scripts/core/enqueue.yml

@@ -1177,6 +1177,12 @@ params:
       desc: |
             [in,out][optional] return an event object that identifies this particular kernel execution instance.
 returns:
+  - $X_RESULT_ERROR_INVALID_SIZE:
+      - "`pitch == 0`"
+      - "`width == 0`"
+      - "`height == 0`"
+      - "`pitch < width`"
+      - "`pitch * height` is higher than the memory allocation size"
   - $X_RESULT_ERROR_INVALID_EVENT_WAIT_LIST:
     - "`phEventWaitList == NULL && numEventsInWaitList > 0`"
     - "`phEventWaitList != NULL && numEventsInWaitList == 0`"

source/loader/layers/validation/ur_valddi.cpp

@@ -1200,6 +1200,22 @@ urEnqueueUSMMemset2D(
             return UR_RESULT_ERROR_INVALID_NULL_POINTER;
         }
 
+        if (pitch == 0) {
+            return UR_RESULT_ERROR_INVALID_SIZE;
+        }
+
+        if (width == 0) {
+            return UR_RESULT_ERROR_INVALID_SIZE;
+        }
+
+        if (height == 0) {
+            return UR_RESULT_ERROR_INVALID_SIZE;
+        }
+
+        if (pitch < width) {
+            return UR_RESULT_ERROR_INVALID_SIZE;
+        }
+
         if (phEventWaitList == NULL && numEventsInWaitList > 0) {
             return UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST;
         }

source/loader/ur_libapi.cpp

@@ -1288,6 +1288,12 @@ urEnqueueUSMFill2D(
 ///         + `NULL == hQueue`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == pMem`
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         + `pitch == 0`
+///         + `width == 0`
+///         + `height == 0`
+///         + `pitch < width`
+///         + `pitch * height` is higher than the memory allocation size
 ///     - ::UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
 ///         + `phEventWaitList == NULL && numEventsInWaitList > 0`
 ///         + `phEventWaitList != NULL && numEventsInWaitList == 0`

source/ur_api.cpp

@@ -1177,6 +1177,12 @@ urEnqueueUSMFill2D(
 ///         + `NULL == hQueue`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == pMem`
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         + `pitch == 0`
+///         + `width == 0`
+///         + `height == 0`
+///         + `pitch < width`
+///         + `pitch * height` is higher than the memory allocation size
 ///     - ::UR_RESULT_ERROR_INVALID_EVENT_WAIT_LIST
 ///         + `phEventWaitList == NULL && numEventsInWaitList > 0`
 ///         + `phEventWaitList != NULL && numEventsInWaitList == 0`

test/conformance/enqueue/rect_helpers.h renamed to test/conformance/enqueue/helpers.h

@@ -53,6 +53,22 @@ inline void copyRect(std::vector<uint8_t> src, ur_rect_offset_t src_offset, ur_r
     }
 }
 
+struct TestParameters2D {
+    int pitch;
+    int width;
+    int height;
+};
+
+template <typename T>
+inline std::string print2DTestString(const testing::TestParamInfo<typename T::ParamType> &info) {
+    const auto device_handle = std::get<0>(info.param);
+    const auto platform_device_name = uur::GetPlatformAndDeviceName(device_handle);
+    std::stringstream test_name;
+    test_name << platform_device_name << "__pitch__" << std::get<1>(info.param).pitch << "__width__" << std::get<1>(info.param).width
+              << "__height__" << std::get<1>(info.param).height;
+    return test_name.str();
+}
+
 } // namespace uur
 
 #endif // UUR_ENQUEUE_RECT_HELPERS_H_INCLUDED

test/conformance/enqueue/urEnqueueMemBufferCopyRect.cpp

@@ -1,6 +1,6 @@
 // Copyright (C) 2023 Intel Corporation
 // SPDX-License-Identifier: MIT
-#include "rect_helpers.h"
+#include "helpers.h"
 #include <numeric>
 
 static std::vector<uur::test_parameters_t> generateParameterizations() {

test/conformance/enqueue/urEnqueueMemBufferReadRect.cpp

@@ -1,6 +1,6 @@
 // Copyright (C) 2023 Intel Corporation
 // SPDX-License-Identifier: MIT
-#include "rect_helpers.h"
+#include "helpers.h"
 #include <numeric>
 
 // Choose parameters so that we get good coverage and catch some edge cases.