Address source-check issues

Signed-off-by: Larsen, Steffen <[email protected]>

Author: steffenlarsen

sycl/doc/extensions/experimental/sycl_ext_oneapi_inter_process_communication.asciidoc

@@ -145,28 +145,39 @@ and any resulting objects are undefined.
 a!
 [source]
 ----
-ipc_memory(span<const char, sycl::dynamic_extent> ipc_memory_handle_data,
-           const sycl::context &ctx, const sycl::device &dev)
+static void *open(ipc_memory_handle_data_t ipc_memory_handle_data,
+                  const sycl::context &ctx, const sycl::device &dev)
 ----
 !====
 
-_Effects:_ Constructs an IPC memory object in `ctx` from the handle data
-`ipc_memory_handle_data` of returned by the `get_handle_data()` member function
-of another `ipc_memory` object.
+_Effects:_ Returns a pointer to the same device USM memory as the device USM
+memory associated with the `ipc_memory` object that the handle data originated
+from.
 The `ipc_memory` object that the handle data originated from is allowed to be
 from another process on the host system.
 If the `ipc_memory` object that the handle data originated from has been
 destroyed, the behaviors of this constructor and any resulting objects are
 undefined.
 If the device USM memory the original `ipc_memory` object was created with was
-not originally allocated on `dev`, the behaviors of this constructor and any
-resulting objects are undefined.
+not originally allocated on `dev`, the behaviors of this function is undefined.
 
 !====
 a!
 [source]
 ----
-span<const char, sycl::dynamic_extent> get_handle_data() const
+static void close(void *ptr, const sycl::context &ctx)
+----
+!====
+
+_Effects:_ Closes a device USM pointer previously returned by a call to
+`ipc_memory::open()`.
+Accessing `ptr` after a call to this function results in undefined behavior.
+
+!====
+a!
+[source]
+----
+ipc_memory_handle_data_t get_handle_data() const
 ----
 !====
 

unified-runtime/scripts/core/exp-inter-process-communication.yml

@@ -46,9 +46,9 @@ params:
 returns:
     - $X_RESULT_ERROR_INVALID_CONTEXT
     - $X_RESULT_ERROR_INVALID_NULL_HANDLE:
-      - "NULL == hContext"
+      - "`NULL == hContext`"
     - $X_RESULT_ERROR_INVALID_NULL_POINTER:
-      - "NULL == phIPCMem"
+      - "`NULL == phIPCMem`"
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
     - $X_RESULT_ERROR_OUT_OF_RESOURCES
 --- #--------------------------------------------------------------------------
@@ -67,8 +67,8 @@ params:
 returns:
     - $X_RESULT_ERROR_INVALID_CONTEXT
     - $X_RESULT_ERROR_INVALID_NULL_HANDLE:
-      - "NULL == hContext"
-      - "NULL == hIPCMem"
+      - "`NULL == hContext`"
+      - "`NULL == hIPCMem`"
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
     - $X_RESULT_ERROR_OUT_OF_RESOURCES
 --- #--------------------------------------------------------------------------
@@ -96,11 +96,11 @@ params:
 returns:
     - $X_RESULT_ERROR_INVALID_CONTEXT
     - $X_RESULT_ERROR_INVALID_NULL_HANDLE:
-      - "NULL == hContext"
-      - "NULL == hDevice"
+      - "`NULL == hContext`"
+      - "`NULL == hDevice`"
     - $X_RESULT_ERROR_INVALID_NULL_POINTER:
-      - "NULL == ipcMemHandleData"
-      - "NULL == ppMem"
+      - "`NULL == ipcMemHandleData`"
+      - "`NULL == ppMem`"
     - $X_RESULT_ERROR_INVALID_VALUE:
       - "ipcMemHandleDataSize is not the same as the size of IPC memory handle data"
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
@@ -121,9 +121,9 @@ params:
 returns:
     - $X_RESULT_ERROR_INVALID_CONTEXT
     - $X_RESULT_ERROR_INVALID_NULL_HANDLE:
-      - "NULL == hContext"
+      - "`NULL == hContext`"
     - $X_RESULT_ERROR_INVALID_NULL_POINTER:
-      - "NULL == pMem"
+      - "`NULL == pMem`"
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
     - $X_RESULT_ERROR_OUT_OF_RESOURCES
 --- #--------------------------------------------------------------------------
@@ -148,7 +148,7 @@ params:
 returns:
     - $X_RESULT_ERROR_INVALID_CONTEXT
     - $X_RESULT_ERROR_INVALID_NULL_HANDLE:
-      - "NULL == hContext"
-      - "NULL == hIPCMem"
+      - "`NULL == hContext`"
+      - "`NULL == hIPCMem`"
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
     - $X_RESULT_ERROR_OUT_OF_RESOURCES

unified-runtime/source/adapters/cuda/memory.cpp

@@ -621,6 +621,9 @@ urIPCPutMemHandleExp(ur_context_handle_t, ur_exp_ipc_mem_handle_t hIPCMem) {
 UR_APIEXPORT ur_result_t UR_APICALL urIPCOpenMemHandleExp(
     ur_context_handle_t hContext, ur_device_handle_t hDevice,
     void *pIPCMemHandleData, size_t ipcMemHandleDataSize, void **ppMem) {
+  if (nullptr == pIPCMemHandleData)
+    return UR_RESULT_ERROR_INVALID_NULL_POINTER;
+
   umf_memory_pool_handle_t umfPool = hDevice->MemoryPoolDevice;
 
   size_t umfHandleSize = 0;

unified-runtime/source/adapters/level_zero/memory.cpp

@@ -1983,6 +1983,9 @@ ur_result_t urIPCOpenMemHandleExp(ur_context_handle_t hContext,
                                   ur_device_handle_t hDevice,
                                   void *pIPCMemHandleData,
                                   size_t ipcMemHandleDataSize, void **ppMem) {
+  if (nullptr == pIPCMemHandleData)
+    return UR_RESULT_ERROR_INVALID_NULL_POINTER;
+
   auto *pool = hContext->DefaultPool.getPool(usm::pool_descriptor{
       &hContext->DefaultPool, hContext, hDevice, UR_USM_TYPE_DEVICE, false});
   if (!pool)

unified-runtime/source/adapters/level_zero/v2/memory.cpp

@@ -806,6 +806,9 @@ ur_result_t urIPCOpenMemHandleExp(ur_context_handle_t hContext,
                                   ur_device_handle_t hDevice,
                                   void *pIPCMemHandleData,
                                   size_t ipcMemHandleDataSize, void **ppMem) {
+  if (nullptr == pIPCMemHandleData)
+    return UR_RESULT_ERROR_INVALID_NULL_POINTER;
+
   auto *pool = hContext->getDefaultUSMPool()->getPool(
       usm::pool_descriptor{hContext->getDefaultUSMPool(), hContext, hDevice,
                            UR_USM_TYPE_DEVICE, false});