Merge pull request #1475 from omarahmed1111/Clarify-INVALID_BUFFER_SI…

…ZE-in-entries [SPEC] Add more clarification to invalid size return code
oneapi-src · Apr 1, 2024 · cd5ad7b · cd5ad7b
2 parents 0816206 + c43ddf8
commit cd5ad7b
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 8 deletions.
diff --git a/include/ur_api.h b/include/ur_api.h
@@ -2646,6 +2646,7 @@ typedef struct ur_buffer_alloc_location_properties_t {
 /// - ::UR_RESULT_ERROR_INVALID_CONTEXT
 /// - ::UR_RESULT_ERROR_INVALID_VALUE
 /// - ::UR_RESULT_ERROR_INVALID_BUFFER_SIZE
+/// + `size == 0`
 /// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
 /// + `pProperties == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`
 /// + `pProperties != NULL && pProperties->pHost == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`
@@ -2754,6 +2755,8 @@ typedef enum ur_buffer_create_type_t {
 /// - ::UR_RESULT_ERROR_OBJECT_ALLOCATION_FAILURE
 /// - ::UR_RESULT_ERROR_INVALID_VALUE
 /// - ::UR_RESULT_ERROR_INVALID_BUFFER_SIZE
+/// + `pRegion && pRegion->size == 0`
+/// + hBuffer allocation size < (pRegion->origin + pRegion->size)
 /// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
 /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
 /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES

diff --git a/scripts/core/memory.yml b/scripts/core/memory.yml
@@ -319,7 +319,8 @@ params:
 returns:
  - $X_RESULT_ERROR_INVALID_CONTEXT
  - $X_RESULT_ERROR_INVALID_VALUE
- - $X_RESULT_ERROR_INVALID_BUFFER_SIZE
+ - $X_RESULT_ERROR_INVALID_BUFFER_SIZE:
+ - "`size == 0`"
  - $X_RESULT_ERROR_INVALID_HOST_PTR:
  - "`pProperties == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`"
  - "`pProperties != NULL && pProperties->pHost == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`"
@@ -411,7 +412,9 @@ returns:
  - $X_RESULT_ERROR_INVALID_MEM_OBJECT
  - $X_RESULT_ERROR_OBJECT_ALLOCATION_FAILURE
  - $X_RESULT_ERROR_INVALID_VALUE
- - $X_RESULT_ERROR_INVALID_BUFFER_SIZE
+ - $X_RESULT_ERROR_INVALID_BUFFER_SIZE:
+ - "`pRegion && pRegion->size == 0`"
+ - "hBuffer allocation size < (pRegion->origin + pRegion->size)"
  - $X_RESULT_ERROR_INVALID_HOST_PTR
  - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
  - $X_RESULT_ERROR_OUT_OF_RESOURCES

diff --git a/source/loader/layers/validation/ur_valddi.cpp b/source/loader/layers/validation/ur_valddi.cpp
@@ -1129,6 +1129,10 @@ __urdlllocal ur_result_t UR_APICALL urMemBufferCreate(
  return UR_RESULT_ERROR_INVALID_ENUMERATION;
  }
 
+ if (size == 0) {
+ return UR_RESULT_ERROR_INVALID_BUFFER_SIZE;
+ }
+
  if (pProperties == NULL &&
  (flags & (UR_MEM_FLAG_USE_HOST_POINTER |
  UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0) {
@@ -1253,6 +1257,10 @@ __urdlllocal ur_result_t UR_APICALL urMemBufferPartition(
  if (UR_BUFFER_CREATE_TYPE_REGION < bufferCreateType) {
  return UR_RESULT_ERROR_INVALID_ENUMERATION;
  }
+
+ if (pRegion && pRegion->size == 0) {
+ return UR_RESULT_ERROR_INVALID_BUFFER_SIZE;
+ }
  }
 
  if (context.enableLifetimeValidation &&

diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp
@@ -1543,6 +1543,7 @@ ur_result_t UR_APICALL urMemImageCreate(
 /// - ::UR_RESULT_ERROR_INVALID_CONTEXT
 /// - ::UR_RESULT_ERROR_INVALID_VALUE
 /// - ::UR_RESULT_ERROR_INVALID_BUFFER_SIZE
+/// + `size == 0`
 /// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
 /// + `pProperties == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`
 /// + `pProperties != NULL && pProperties->pHost == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`
@@ -1657,6 +1658,8 @@ ur_result_t UR_APICALL urMemRelease(
 /// - ::UR_RESULT_ERROR_OBJECT_ALLOCATION_FAILURE
 /// - ::UR_RESULT_ERROR_INVALID_VALUE
 /// - ::UR_RESULT_ERROR_INVALID_BUFFER_SIZE
+/// + `pRegion && pRegion->size == 0`
+/// + hBuffer allocation size < (pRegion->origin + pRegion->size)
 /// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
 /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
 /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES

diff --git a/source/ur_api.cpp b/source/ur_api.cpp
@@ -1331,6 +1331,7 @@ ur_result_t UR_APICALL urMemImageCreate(
 /// - ::UR_RESULT_ERROR_INVALID_CONTEXT
 /// - ::UR_RESULT_ERROR_INVALID_VALUE
 /// - ::UR_RESULT_ERROR_INVALID_BUFFER_SIZE
+/// + `size == 0`
 /// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
 /// + `pProperties == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`
 /// + `pProperties != NULL && pProperties->pHost == NULL && (flags & (UR_MEM_FLAG_USE_HOST_POINTER | UR_MEM_FLAG_ALLOC_COPY_HOST_POINTER)) != 0`
@@ -1427,6 +1428,8 @@ ur_result_t UR_APICALL urMemRelease(
 /// - ::UR_RESULT_ERROR_OBJECT_ALLOCATION_FAILURE
 /// - ::UR_RESULT_ERROR_INVALID_VALUE
 /// - ::UR_RESULT_ERROR_INVALID_BUFFER_SIZE
+/// + `pRegion && pRegion->size == 0`
+/// + hBuffer allocation size < (pRegion->origin + pRegion->size)
 /// - ::UR_RESULT_ERROR_INVALID_HOST_PTR
 /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
 /// - ::UR_RESULT_ERROR_OUT_OF_RESOURCES

diff --git a/test/conformance/memory/memory_adapter_level_zero.match b/test/conformance/memory/memory_adapter_level_zero.match
@@ -1,8 +1,3 @@
-urMemBufferCreateWithFlagsTest.InvalidBufferSizeZero/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_UR_MEM_FLAG_READ_WRITE
-urMemBufferCreateWithFlagsTest.InvalidBufferSizeZero/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_UR_MEM_FLAG_WRITE_ONLY
-urMemBufferCreateWithFlagsTest.InvalidBufferSizeZero/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_UR_MEM_FLAG_READ_ONLY
-urMemBufferCreateWithFlagsTest.InvalidBufferSizeZero/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_UR_MEM_FLAG_ALLOC_HOST_POINTER
-urMemBufferPartitionTest.InvalidBufferSize/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_
 urMemBufferPartitionTest.InvalidValueCreateType/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_
 urMemBufferPartitionTest.InvalidValueBufferCreateInfoOutOfBounds/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}_
 urMemGetInfoImageTest.Success/Intel_R__oneAPI_Unified_Runtime_over_Level_Zero___{{.*}}___UR_MEM_INFO_SIZE

diff --git a/test/conformance/memory/memory_adapter_native_cpu.match b/test/conformance/memory/memory_adapter_native_cpu.match
@@ -1,4 +1,3 @@
-urMemBufferPartitionTest.InvalidBufferSize/SYCL_NATIVE_CPU___SYCL_Native_CPU_
 urMemBufferPartitionTest.InvalidValueCreateType/SYCL_NATIVE_CPU___SYCL_Native_CPU_
 urMemBufferPartitionTest.InvalidValueBufferCreateInfoOutOfBounds/SYCL_NATIVE_CPU___SYCL_Native_CPU_
 urMemGetInfoTest.Success/SYCL_NATIVE_CPU___SYCL_Native_CPU___UR_MEM_INFO_SIZE