[UR] Add invalid size check to virtual memory

oneapi-src · Jun 29, 2023 · 6cde82d · 6cde82d
1 parent 6cd3aac
commit 6cde82d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/include/ur_api.h b/include/ur_api.h
@@ -3291,6 +3291,8 @@ typedef struct ur_physical_mem_properties_t {
 ///         + `NULL == hDevice`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == phPhysicalMem`
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         + If size is not a multiple of ::UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM.
 UR_APIEXPORT ur_result_t UR_APICALL
 urPhysicalMemCreate(
     ur_context_handle_t hContext,                    ///< [in] handle of the context object.

diff --git a/scripts/core/virtual_memory.yml b/scripts/core/virtual_memory.yml
@@ -281,7 +281,9 @@ params:
     - type: $x_physical_mem_handle_t*
       name: phPhysicalMem
       desc: "[out] pointer to handle of physical memory object created."
-
+returns:
+    - $X_RESULT_ERROR_INVALID_SIZE:
+        - "If size is not a multiple of $X_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM."
 --- #--------------------------------------------------------------------------
 type: function
 desc: "Retain a physical memory handle, increment its reference count."

diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp
@@ -2403,6 +2403,8 @@ ur_result_t UR_APICALL urVirtualMemGetInfo(
 ///         + `NULL == hDevice`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == phPhysicalMem`
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         + If size is not a multiple of ::UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM.
 ur_result_t UR_APICALL urPhysicalMemCreate(
     ur_context_handle_t hContext, ///< [in] handle of the context object.
     ur_device_handle_t hDevice,   ///< [in] handle of the device object.

diff --git a/source/ur_api.cpp b/source/ur_api.cpp
@@ -2020,6 +2020,8 @@ ur_result_t UR_APICALL urVirtualMemGetInfo(
 ///         + `NULL == hDevice`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
 ///         + `NULL == phPhysicalMem`
+///     - ::UR_RESULT_ERROR_INVALID_SIZE
+///         + If size is not a multiple of ::UR_VIRTUAL_MEM_GRANULARITY_INFO_MINIMUM.
 ur_result_t UR_APICALL urPhysicalMemCreate(
     ur_context_handle_t hContext, ///< [in] handle of the context object.
     ur_device_handle_t hDevice,   ///< [in] handle of the device object.