diff --git a/unified-runtime/include/ur_api.h b/unified-runtime/include/ur_api.h index 01b9e556e94a3..4ceda0bc46b5d 100644 --- a/unified-runtime/include/ur_api.h +++ b/unified-runtime/include/ur_api.h @@ -12615,14 +12615,11 @@ UR_APIEXPORT ur_result_t UR_APICALL urIPCCloseMemHandleExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` /// - ::UR_RESULT_ERROR_INVALID_ENUMERATION /// + `::UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < /// handleTypeToExport` -/// - ::UR_RESULT_ERROR_INVALID_CONTEXT -/// - ::UR_RESULT_ERROR_INVALID_DEVICE /// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `ppMem == nullptr` +/// + `NULL == ppMem` /// - ::UR_RESULT_ERROR_UNSUPPORTED_ALIGNMENT /// + `alignment != 0 && ((alignment & (alignment-1)) != 0)` /// - ::UR_RESULT_ERROR_INVALID_VALUE @@ -12631,6 +12628,8 @@ UR_APIEXPORT ur_result_t UR_APICALL urIPCCloseMemHandleExp( /// + `size == 0` /// - ::UR_RESULT_ERROR_UNSUPPORTED_SIZE /// + `size` is greater than ::UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE. +/// - ::UR_RESULT_ERROR_INVALID_CONTEXT +/// - ::UR_RESULT_ERROR_INVALID_DEVICE /// - /// ::UR_RESULT_ERROR_UNSUPPORTED_FEATURE:DEVICE_INFO_MEMORY_EXPORT_LINEAR_MEMORY_EXPORT_SUPPORT_EXP /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -12661,11 +12660,10 @@ UR_APIEXPORT ur_result_t UR_APICALL urMemoryExportAllocExportableMemoryExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` +/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER +/// + `NULL == pMem` /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_DEVICE -/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `pMem == nullptr` /// - ::UR_RESULT_ERROR_INVALID_VALUE /// - ::UR_RESULT_ERROR_DEVICE_LOST /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -12693,14 +12691,13 @@ UR_APIEXPORT ur_result_t UR_APICALL urMemoryExportFreeExportableMemoryExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` /// - ::UR_RESULT_ERROR_INVALID_ENUMERATION /// + `::UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < /// handleTypeToExport` +/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER +/// + `NULL == pMemHandleRet || NULL == pMem` /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_DEVICE -/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `pMemHandleRet == nullptr || pMem == nullptr` /// - ::UR_RESULT_ERROR_DEVICE_LOST /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY /// - ::UR_RESULT_ERROR_OUT_OF_DEVICE_MEMORY diff --git a/unified-runtime/scripts/core/exp-memory-export.yml b/unified-runtime/scripts/core/exp-memory-export.yml index 4c388e9ae63c3..f50a9c54b22e8 100644 --- a/unified-runtime/scripts/core/exp-memory-export.yml +++ b/unified-runtime/scripts/core/exp-memory-export.yml @@ -56,12 +56,9 @@ params: name: ppMem desc: "[out][alloc] Pointer to allocated exportable memory." returns: - - $X_RESULT_ERROR_INVALID_CONTEXT - - $X_RESULT_ERROR_INVALID_DEVICE - - $X_RESULT_ERROR_INVALID_NULL_HANDLE: - - "`(hDevice == nullptr) || (hContext == nullptr)`" + - $X_RESULT_ERROR_INVALID_NULL_HANDLE - $X_RESULT_ERROR_INVALID_NULL_POINTER: - - "`ppMem == nullptr`" + - "`NULL == ppMem`" - $X_RESULT_ERROR_UNSUPPORTED_ALIGNMENT: - "`alignment != 0 && ((alignment & (alignment-1)) != 0)`" - $X_RESULT_ERROR_INVALID_VALUE: @@ -70,6 +67,8 @@ returns: - "`size == 0`" - $X_RESULT_ERROR_UNSUPPORTED_SIZE: - "`size` is greater than $X_DEVICE_INFO_MAX_MEM_ALLOC_SIZE." + - $X_RESULT_ERROR_INVALID_CONTEXT + - $X_RESULT_ERROR_INVALID_DEVICE - $X_RESULT_ERROR_UNSUPPORTED_FEATURE:DEVICE_INFO_MEMORY_EXPORT_LINEAR_MEMORY_EXPORT_SUPPORT_EXP - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY - $X_RESULT_ERROR_OUT_OF_DEVICE_MEMORY @@ -91,12 +90,11 @@ params: desc: |- [in][release] Pointer to exportable memory to be deallocated. returns: + - $X_RESULT_ERROR_INVALID_NULL_HANDLE + - $X_RESULT_ERROR_INVALID_NULL_POINTER: + - "`NULL == pMem`" - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_DEVICE - - $X_RESULT_ERROR_INVALID_NULL_HANDLE: - - "`(hDevice == nullptr) || (hContext == nullptr)`" - - $X_RESULT_ERROR_INVALID_NULL_POINTER: - - "`pMem == nullptr`" - $X_RESULT_ERROR_INVALID_VALUE - $X_RESULT_ERROR_DEVICE_LOST - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -133,12 +131,11 @@ params: name: pMemHandleRet desc: "[out] Returned exportable handle to memory allocated in `pMem`" returns: + - $X_RESULT_ERROR_INVALID_NULL_HANDLE + - $X_RESULT_ERROR_INVALID_NULL_POINTER: + - "`NULL == pMemHandleRet || NULL == pMem`" - $X_RESULT_ERROR_INVALID_CONTEXT - $X_RESULT_ERROR_INVALID_DEVICE - - $X_RESULT_ERROR_INVALID_NULL_HANDLE: - - "`(hDevice == nullptr) || (hContext == nullptr)`" - - $X_RESULT_ERROR_INVALID_NULL_POINTER: - - "`pMemHandleRet == nullptr || pMem == nullptr`" - $X_RESULT_ERROR_INVALID_ENUMERATION - $X_RESULT_ERROR_DEVICE_LOST - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY diff --git a/unified-runtime/source/loader/layers/validation/ur_valddi.cpp b/unified-runtime/source/loader/layers/validation/ur_valddi.cpp index 0313a1e211424..464acb714b2a5 100644 --- a/unified-runtime/source/loader/layers/validation/ur_valddi.cpp +++ b/unified-runtime/source/loader/layers/validation/ur_valddi.cpp @@ -10583,7 +10583,7 @@ __urdlllocal ur_result_t UR_APICALL urMemoryExportAllocExportableMemoryExp( } if (getContext()->enableParameterValidation) { - if (ppMem == nullptr) + if (NULL == ppMem) return UR_RESULT_ERROR_INVALID_NULL_POINTER; if (NULL == hContext) @@ -10592,9 +10592,6 @@ __urdlllocal ur_result_t UR_APICALL urMemoryExportAllocExportableMemoryExp( if (NULL == hDevice) return UR_RESULT_ERROR_INVALID_NULL_HANDLE; - if ((hDevice == nullptr) || (hContext == nullptr)) - return UR_RESULT_ERROR_INVALID_NULL_HANDLE; - if (UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < handleTypeToExport) return UR_RESULT_ERROR_INVALID_ENUMERATION; @@ -10638,7 +10635,7 @@ __urdlllocal ur_result_t UR_APICALL urMemoryExportFreeExportableMemoryExp( } if (getContext()->enableParameterValidation) { - if (pMem == nullptr) + if (NULL == pMem) return UR_RESULT_ERROR_INVALID_NULL_POINTER; if (NULL == hContext) @@ -10646,9 +10643,6 @@ __urdlllocal ur_result_t UR_APICALL urMemoryExportFreeExportableMemoryExp( if (NULL == hDevice) return UR_RESULT_ERROR_INVALID_NULL_HANDLE; - - if ((hDevice == nullptr) || (hContext == nullptr)) - return UR_RESULT_ERROR_INVALID_NULL_HANDLE; } if (getContext()->enableLifetimeValidation && @@ -10688,7 +10682,7 @@ __urdlllocal ur_result_t UR_APICALL urMemoryExportExportMemoryHandleExp( } if (getContext()->enableParameterValidation) { - if (pMemHandleRet == nullptr || pMem == nullptr) + if (NULL == pMemHandleRet || NULL == pMem) return UR_RESULT_ERROR_INVALID_NULL_POINTER; if (NULL == hContext) @@ -10697,9 +10691,6 @@ __urdlllocal ur_result_t UR_APICALL urMemoryExportExportMemoryHandleExp( if (NULL == hDevice) return UR_RESULT_ERROR_INVALID_NULL_HANDLE; - if ((hDevice == nullptr) || (hContext == nullptr)) - return UR_RESULT_ERROR_INVALID_NULL_HANDLE; - if (UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < handleTypeToExport) return UR_RESULT_ERROR_INVALID_ENUMERATION; } diff --git a/unified-runtime/source/loader/ur_libapi.cpp b/unified-runtime/source/loader/ur_libapi.cpp index fcd594027181d..1c5b83b224928 100644 --- a/unified-runtime/source/loader/ur_libapi.cpp +++ b/unified-runtime/source/loader/ur_libapi.cpp @@ -10237,14 +10237,11 @@ ur_result_t UR_APICALL urIPCCloseMemHandleExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` /// - ::UR_RESULT_ERROR_INVALID_ENUMERATION /// + `::UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < /// handleTypeToExport` -/// - ::UR_RESULT_ERROR_INVALID_CONTEXT -/// - ::UR_RESULT_ERROR_INVALID_DEVICE /// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `ppMem == nullptr` +/// + `NULL == ppMem` /// - ::UR_RESULT_ERROR_UNSUPPORTED_ALIGNMENT /// + `alignment != 0 && ((alignment & (alignment-1)) != 0)` /// - ::UR_RESULT_ERROR_INVALID_VALUE @@ -10253,6 +10250,8 @@ ur_result_t UR_APICALL urIPCCloseMemHandleExp( /// + `size == 0` /// - ::UR_RESULT_ERROR_UNSUPPORTED_SIZE /// + `size` is greater than ::UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE. +/// - ::UR_RESULT_ERROR_INVALID_CONTEXT +/// - ::UR_RESULT_ERROR_INVALID_DEVICE /// - /// ::UR_RESULT_ERROR_UNSUPPORTED_FEATURE:DEVICE_INFO_MEMORY_EXPORT_LINEAR_MEMORY_EXPORT_SUPPORT_EXP /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -10294,11 +10293,10 @@ ur_result_t UR_APICALL urMemoryExportAllocExportableMemoryExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` +/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER +/// + `NULL == pMem` /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_DEVICE -/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `pMem == nullptr` /// - ::UR_RESULT_ERROR_INVALID_VALUE /// - ::UR_RESULT_ERROR_DEVICE_LOST /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -10336,14 +10334,13 @@ ur_result_t UR_APICALL urMemoryExportFreeExportableMemoryExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` /// - ::UR_RESULT_ERROR_INVALID_ENUMERATION /// + `::UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < /// handleTypeToExport` +/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER +/// + `NULL == pMemHandleRet || NULL == pMem` /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_DEVICE -/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `pMemHandleRet == nullptr || pMem == nullptr` /// - ::UR_RESULT_ERROR_DEVICE_LOST /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY /// - ::UR_RESULT_ERROR_OUT_OF_DEVICE_MEMORY diff --git a/unified-runtime/source/ur_api.cpp b/unified-runtime/source/ur_api.cpp index 928cf63840f7f..44b985fb95353 100644 --- a/unified-runtime/source/ur_api.cpp +++ b/unified-runtime/source/ur_api.cpp @@ -8907,14 +8907,11 @@ ur_result_t UR_APICALL urIPCCloseMemHandleExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` /// - ::UR_RESULT_ERROR_INVALID_ENUMERATION /// + `::UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < /// handleTypeToExport` -/// - ::UR_RESULT_ERROR_INVALID_CONTEXT -/// - ::UR_RESULT_ERROR_INVALID_DEVICE /// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `ppMem == nullptr` +/// + `NULL == ppMem` /// - ::UR_RESULT_ERROR_UNSUPPORTED_ALIGNMENT /// + `alignment != 0 && ((alignment & (alignment-1)) != 0)` /// - ::UR_RESULT_ERROR_INVALID_VALUE @@ -8923,6 +8920,8 @@ ur_result_t UR_APICALL urIPCCloseMemHandleExp( /// + `size == 0` /// - ::UR_RESULT_ERROR_UNSUPPORTED_SIZE /// + `size` is greater than ::UR_DEVICE_INFO_MAX_MEM_ALLOC_SIZE. +/// - ::UR_RESULT_ERROR_INVALID_CONTEXT +/// - ::UR_RESULT_ERROR_INVALID_DEVICE /// - /// ::UR_RESULT_ERROR_UNSUPPORTED_FEATURE:DEVICE_INFO_MEMORY_EXPORT_LINEAR_MEMORY_EXPORT_SUPPORT_EXP /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -8956,11 +8955,10 @@ ur_result_t UR_APICALL urMemoryExportAllocExportableMemoryExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` +/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER +/// + `NULL == pMem` /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_DEVICE -/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `pMem == nullptr` /// - ::UR_RESULT_ERROR_INVALID_VALUE /// - ::UR_RESULT_ERROR_DEVICE_LOST /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY @@ -8991,14 +8989,13 @@ ur_result_t UR_APICALL urMemoryExportFreeExportableMemoryExp( /// - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE /// + `NULL == hContext` /// + `NULL == hDevice` -/// + `(hDevice == nullptr) || (hContext == nullptr)` /// - ::UR_RESULT_ERROR_INVALID_ENUMERATION /// + `::UR_EXP_EXTERNAL_MEM_TYPE_WIN32_NT_DX11_RESOURCE < /// handleTypeToExport` +/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER +/// + `NULL == pMemHandleRet || NULL == pMem` /// - ::UR_RESULT_ERROR_INVALID_CONTEXT /// - ::UR_RESULT_ERROR_INVALID_DEVICE -/// - ::UR_RESULT_ERROR_INVALID_NULL_POINTER -/// + `pMemHandleRet == nullptr || pMem == nullptr` /// - ::UR_RESULT_ERROR_DEVICE_LOST /// - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY /// - ::UR_RESULT_ERROR_OUT_OF_DEVICE_MEMORY