Merge pull request #716 from przemektmalon/przemek/bindless-images-interop-fd

[Bindless][Exp] Add bindless images interop resource handles

Author: veselypeta

include/ur.py

@@ -232,6 +232,10 @@ class ur_structure_type_v(IntEnum):
     KERNEL_ARG_LOCAL_PROPERTIES = 33                ## ::ur_kernel_arg_local_properties_t
     EXP_COMMAND_BUFFER_DESC = 0x1000                ## ::ur_exp_command_buffer_desc_t
     EXP_SAMPLER_MIP_PROPERTIES = 0x2000             ## ::ur_exp_sampler_mip_properties_t
+    EXP_INTEROP_MEMORY_DESC = 0x2001                ## ::ur_exp_interop_memory_desc_t
+    EXP_INTEROP_SEMAPHORE_DESC = 0x2002             ## ::ur_exp_interop_semaphore_desc_t
+    EXP_FILE_DESCRIPTOR = 0x2003                    ## ::ur_exp_file_descriptor_t
+    EXP_WIN32_HANDLE = 0x2004                       ## ::ur_exp_win32_handle_t
 
 class ur_structure_type_t(c_int):
     def __str__(self):
@@ -2097,6 +2101,26 @@ def __str__(self):
         return hex(self.value)
 
 
+###############################################################################
+## @brief File descriptor
+class ur_exp_file_descriptor_t(Structure):
+    _fields_ = [
+        ("stype", ur_structure_type_t),                                 ## [in] type of this structure, must be
+                                                                        ## ::UR_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR
+        ("pNext", c_void_p),                                            ## [in][optional] pointer to extension-specific structure
+        ("fd", c_int)                                                   ## [in] A file descriptor used for Linux and & MacOS operating systems.
+    ]
+
+###############################################################################
+## @brief Windows specific file handle
+class ur_exp_win32_handle_t(Structure):
+    _fields_ = [
+        ("stype", ur_structure_type_t),                                 ## [in] type of this structure, must be
+                                                                        ## ::UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE
+        ("pNext", c_void_p),                                            ## [in][optional] pointer to extension-specific structure
+        ("handle", c_void_p)                                            ## [in] A win32 file handle.
+    ]
+
 ###############################################################################
 ## @brief Describes mipmap sampler properties
 ## 
@@ -2117,6 +2141,24 @@ class ur_exp_sampler_mip_properties_t(Structure):
         ("mipFilterMode", ur_sampler_filter_mode_t)                     ## [in] mipmap filter mode used for filtering between mipmap levels
     ]
 
+###############################################################################
+## @brief Describes an interop memory resource descriptor
+class ur_exp_interop_memory_desc_t(Structure):
+    _fields_ = [
+        ("stype", ur_structure_type_t),                                 ## [in] type of this structure, must be
+                                                                        ## ::UR_STRUCTURE_TYPE_EXP_INTEROP_MEMORY_DESC
+        ("pNext", c_void_p)                                             ## [in][optional] pointer to extension-specific structure
+    ]
+
+###############################################################################
+## @brief Describes an interop semaphore resource descriptor
+class ur_exp_interop_semaphore_desc_t(Structure):
+    _fields_ = [
+        ("stype", ur_structure_type_t),                                 ## [in] type of this structure, must be
+                                                                        ## ::UR_STRUCTURE_TYPE_EXP_INTEROP_SEMAPHORE_DESC
+        ("pNext", c_void_p)                                             ## [in][optional] pointer to extension-specific structure
+    ]
+
 ###############################################################################
 ## @brief The extension string which defines support for command-buffers which
 ##        is returned when querying device extensions.
@@ -3117,9 +3159,9 @@ class ur_queue_dditable_t(Structure):
 ###############################################################################
 ## @brief Function-pointer for urBindlessImagesImportOpaqueFDExp
 if __use_win_types:
-    _urBindlessImagesImportOpaqueFDExp_t = WINFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, c_size_t, c_ulong, POINTER(ur_exp_interop_mem_handle_t) )
+    _urBindlessImagesImportOpaqueFDExp_t = WINFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, c_size_t, POINTER(ur_exp_interop_memory_desc_t), POINTER(ur_exp_interop_mem_handle_t) )
 else:
-    _urBindlessImagesImportOpaqueFDExp_t = CFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, c_size_t, c_ulong, POINTER(ur_exp_interop_mem_handle_t) )
+    _urBindlessImagesImportOpaqueFDExp_t = CFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, c_size_t, POINTER(ur_exp_interop_memory_desc_t), POINTER(ur_exp_interop_mem_handle_t) )
 
 ###############################################################################
 ## @brief Function-pointer for urBindlessImagesMapExternalArrayExp
@@ -3138,9 +3180,9 @@ class ur_queue_dditable_t(Structure):
 ###############################################################################
 ## @brief Function-pointer for urBindlessImagesImportExternalSemaphoreOpaqueFDExp
 if __use_win_types:
-    _urBindlessImagesImportExternalSemaphoreOpaqueFDExp_t = WINFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, c_ulong, POINTER(ur_exp_interop_semaphore_handle_t) )
+    _urBindlessImagesImportExternalSemaphoreOpaqueFDExp_t = WINFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, POINTER(ur_exp_interop_semaphore_desc_t), POINTER(ur_exp_interop_semaphore_handle_t) )
 else:
-    _urBindlessImagesImportExternalSemaphoreOpaqueFDExp_t = CFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, c_ulong, POINTER(ur_exp_interop_semaphore_handle_t) )
+    _urBindlessImagesImportExternalSemaphoreOpaqueFDExp_t = CFUNCTYPE( ur_result_t, ur_context_handle_t, ur_device_handle_t, POINTER(ur_exp_interop_semaphore_desc_t), POINTER(ur_exp_interop_semaphore_handle_t) )
 
 ###############################################################################
 ## @brief Function-pointer for urBindlessImagesDestroyExternalSemaphoreExp

include/ur_api.h

@@ -241,6 +241,10 @@ typedef enum ur_structure_type_t {
     UR_STRUCTURE_TYPE_KERNEL_ARG_LOCAL_PROPERTIES = 33,     ///< ::ur_kernel_arg_local_properties_t
     UR_STRUCTURE_TYPE_EXP_COMMAND_BUFFER_DESC = 0x1000,     ///< ::ur_exp_command_buffer_desc_t
     UR_STRUCTURE_TYPE_EXP_SAMPLER_MIP_PROPERTIES = 0x2000,  ///< ::ur_exp_sampler_mip_properties_t
+    UR_STRUCTURE_TYPE_EXP_INTEROP_MEMORY_DESC = 0x2001,     ///< ::ur_exp_interop_memory_desc_t
+    UR_STRUCTURE_TYPE_EXP_INTEROP_SEMAPHORE_DESC = 0x2002,  ///< ::ur_exp_interop_semaphore_desc_t
+    UR_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR = 0x2003,         ///< ::ur_exp_file_descriptor_t
+    UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE = 0x2004,            ///< ::ur_exp_win32_handle_t
     /// @cond
     UR_STRUCTURE_TYPE_FORCE_UINT32 = 0x7fffffff
     /// @endcond
@@ -6616,6 +6620,26 @@ typedef enum ur_exp_image_copy_flag_t {
 /// @brief Bit Mask for validating ur_exp_image_copy_flags_t
 #define UR_EXP_IMAGE_COPY_FLAGS_MASK 0xfffffff8
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief File descriptor
+typedef struct ur_exp_file_descriptor_t {
+    ur_structure_type_t stype; ///< [in] type of this structure, must be
+                               ///< ::UR_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR
+    const void *pNext;         ///< [in][optional] pointer to extension-specific structure
+    int fd;                    ///< [in] A file descriptor used for Linux and & MacOS operating systems.
+
+} ur_exp_file_descriptor_t;
+
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Windows specific file handle
+typedef struct ur_exp_win32_handle_t {
+    ur_structure_type_t stype; ///< [in] type of this structure, must be
+                               ///< ::UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE
+    const void *pNext;         ///< [in][optional] pointer to extension-specific structure
+    void *handle;              ///< [in] A win32 file handle.
+
+} ur_exp_win32_handle_t;
+
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Describes mipmap sampler properties
 ///
@@ -6636,6 +6660,24 @@ typedef struct ur_exp_sampler_mip_properties_t {
 
 } ur_exp_sampler_mip_properties_t;
 
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Describes an interop memory resource descriptor
+typedef struct ur_exp_interop_memory_desc_t {
+    ur_structure_type_t stype; ///< [in] type of this structure, must be
+                               ///< ::UR_STRUCTURE_TYPE_EXP_INTEROP_MEMORY_DESC
+    const void *pNext;         ///< [in][optional] pointer to extension-specific structure
+
+} ur_exp_interop_memory_desc_t;
+
+///////////////////////////////////////////////////////////////////////////////
+/// @brief Describes an interop semaphore resource descriptor
+typedef struct ur_exp_interop_semaphore_desc_t {
+    ur_structure_type_t stype; ///< [in] type of this structure, must be
+                               ///< ::UR_STRUCTURE_TYPE_EXP_INTEROP_SEMAPHORE_DESC
+    const void *pNext;         ///< [in][optional] pointer to extension-specific structure
+
+} ur_exp_interop_semaphore_desc_t;
+
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief USM allocate pitched memory
 ///
@@ -7034,17 +7076,18 @@ urBindlessImagesMipmapFreeExp(
 ///         + `NULL == hContext`
 ///         + `NULL == hDevice`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
+///         + `NULL == interopMemDesc`
 ///         + `NULL == phInteropMem`
 ///     - ::UR_RESULT_ERROR_INVALID_CONTEXT
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 ///     - ::UR_RESULT_ERROR_INVALID_MEM_OBJECT
 UR_APIEXPORT ur_result_t UR_APICALL
 urBindlessImagesImportOpaqueFDExp(
-    ur_context_handle_t hContext,             ///< [in] handle of the context object
-    ur_device_handle_t hDevice,               ///< [in] handle of the device object
-    size_t size,                              ///< [in] size of the external memory
-    uint32_t fileDescriptor,                  ///< [in] the file descriptor
-    ur_exp_interop_mem_handle_t *phInteropMem ///< [out] interop memory handle to the external memory
+    ur_context_handle_t hContext,                 ///< [in] handle of the context object
+    ur_device_handle_t hDevice,                   ///< [in] handle of the device object
+    size_t size,                                  ///< [in] size of the external memory
+    ur_exp_interop_memory_desc_t *interopMemDesc, ///< [in] the interop memory descriptor
+    ur_exp_interop_mem_handle_t *phInteropMem     ///< [out] interop memory handle to the external memory
 );
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -7121,15 +7164,16 @@ urBindlessImagesReleaseInteropExp(
 ///         + `NULL == hContext`
 ///         + `NULL == hDevice`
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_POINTER
-///         + `NULL == phInteropSemaphoreHandle`
+///         + `NULL == interopSemaphoreDesc`
+///         + `NULL == phInteropSemaphore`
 ///     - ::UR_RESULT_ERROR_INVALID_CONTEXT
 ///     - ::UR_RESULT_ERROR_INVALID_VALUE
 UR_APIEXPORT ur_result_t UR_APICALL
 urBindlessImagesImportExternalSemaphoreOpaqueFDExp(
-    ur_context_handle_t hContext,                               ///< [in] handle of the context object
-    ur_device_handle_t hDevice,                                 ///< [in] handle of the device object
-    uint32_t fileDescriptor,                                    ///< [in] the file descriptor
-    ur_exp_interop_semaphore_handle_t *phInteropSemaphoreHandle ///< [out] interop semaphore handle to the external semaphore
+    ur_context_handle_t hContext,                          ///< [in] handle of the context object
+    ur_device_handle_t hDevice,                            ///< [in] handle of the device object
+    ur_exp_interop_semaphore_desc_t *interopSemaphoreDesc, ///< [in] the interop semaphore descriptor
+    ur_exp_interop_semaphore_handle_t *phInteropSemaphore  ///< [out] interop semaphore handle to the external semaphore
 );
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -9199,7 +9243,7 @@ typedef struct ur_bindless_images_import_opaque_fd_exp_params_t {
     ur_context_handle_t *phContext;
     ur_device_handle_t *phDevice;
     size_t *psize;
-    uint32_t *pfileDescriptor;
+    ur_exp_interop_memory_desc_t **pinteropMemDesc;
     ur_exp_interop_mem_handle_t **pphInteropMem;
 } ur_bindless_images_import_opaque_fd_exp_params_t;
 
@@ -9233,8 +9277,8 @@ typedef struct ur_bindless_images_release_interop_exp_params_t {
 typedef struct ur_bindless_images_import_external_semaphore_opaque_fd_exp_params_t {
     ur_context_handle_t *phContext;
     ur_device_handle_t *phDevice;
-    uint32_t *pfileDescriptor;
-    ur_exp_interop_semaphore_handle_t **pphInteropSemaphoreHandle;
+    ur_exp_interop_semaphore_desc_t **pinteropSemaphoreDesc;
+    ur_exp_interop_semaphore_handle_t **pphInteropSemaphore;
 } ur_bindless_images_import_external_semaphore_opaque_fd_exp_params_t;
 
 ///////////////////////////////////////////////////////////////////////////////

include/ur_ddi.h

@@ -1375,7 +1375,7 @@ typedef ur_result_t(UR_APICALL *ur_pfnBindlessImagesImportOpaqueFDExp_t)(
     ur_context_handle_t,
     ur_device_handle_t,
     size_t,
-    uint32_t,
+    ur_exp_interop_memory_desc_t *,
     ur_exp_interop_mem_handle_t *);
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -1400,7 +1400,7 @@ typedef ur_result_t(UR_APICALL *ur_pfnBindlessImagesReleaseInteropExp_t)(
 typedef ur_result_t(UR_APICALL *ur_pfnBindlessImagesImportExternalSemaphoreOpaqueFDExp_t)(
     ur_context_handle_t,
     ur_device_handle_t,
-    uint32_t,
+    ur_exp_interop_semaphore_desc_t *,
     ur_exp_interop_semaphore_handle_t *);
 
 ///////////////////////////////////////////////////////////////////////////////

scripts/core/EXP-BINDLESS-IMAGES.rst

@@ -64,6 +64,10 @@ Enums
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * ${x}_structure_type_t
     ${X}_STRUCTURE_TYPE_EXP_SAMPLER_MIP_PROPERTIES
+    ${X}_STRUCTURE_TYPE_EXP_INTEROP_MEMORY_DESC
+    ${X}_STRUCTURE_TYPE_EXP_INTEROP_SEMAPHORE_DESC
+    ${X}_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR
+    ${X}_STRUCTURE_TYPE_EXP_WIN32_HANDLE
 
 * ${x}_device_info_t
     * ${X}_DEVICE_INFO_BINDLESS_IMAGES_SUPPORT_EXP
@@ -119,6 +123,10 @@ Types
 * ${x}_exp_image_mem_handle_t
 * ${x}_exp_interop_mem_handle_t
 * ${x}_exp_interop_semaphore_handle_t
+* ${x}_exp_interop_memory_desc_t
+* ${x}_exp_interop_semaphore_desc_t
+* ${x}_exp_file_descriptor_t
+* ${x}_exp_win32_handle_t
 
 Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -159,8 +167,11 @@ Changelog
 |          || Removed 3D USM capabilities.                            |
 |          || Added mip filter mode.                                  |
 +----------+----------------------------------------------------------+
-| 3.0      | Added device query for bindless images on shared USM    |
-+----------+---------------------------------------------------------+
+| 3.0      | Added device query for bindless images on shared USM     |
++----------+-------------------------------------------------------------+
+| 4.0      || Added platform specific interop resource handles.          |
+|          || Added and updated to use new interop resource descriptors. |
++----------+-------------------------------------------------------------+
 
 Contributors
 --------------------------------------------------------------------------------

scripts/core/exp-bindless-images.yml

@@ -86,6 +86,18 @@ etors:
     - name: EXP_SAMPLER_MIP_PROPERTIES
       desc: $x_exp_sampler_mip_properties_t
       value: "0x2000"
+    - name: EXP_INTEROP_MEMORY_DESC
+      desc: $x_exp_interop_memory_desc_t
+      value: "0x2001"
+    - name: EXP_INTEROP_SEMAPHORE_DESC
+      desc: $x_exp_interop_semaphore_desc_t
+      value: "0x2002"
+    - name: EXP_FILE_DESCRIPTOR
+      desc: $x_exp_file_descriptor_t
+      value: "0x2003"
+    - name: EXP_WIN32_HANDLE
+      desc: $x_exp_win32_handle_t
+      value: "0x2004"
 --- #--------------------------------------------------------------------------
 type: enum
 extend: true
@@ -112,6 +124,24 @@ etors:
     desc: "Device to device"
 --- #--------------------------------------------------------------------------
 type: struct
+desc: "File descriptor"
+name: $x_exp_file_descriptor_t
+base: $x_base_desc_t
+members:
+    - type: int
+      name: fd
+      desc: "[in] A file descriptor used for Linux and & MacOS operating systems."
+--- #--------------------------------------------------------------------------
+type: struct
+desc: "Windows specific file handle"
+name: $x_exp_win32_handle_t
+base: $x_base_desc_t
+members:
+    - type: void*
+      name: handle
+      desc: "[in] A win32 file handle."
+--- #--------------------------------------------------------------------------
+type: struct
 desc: "Describes mipmap sampler properties"
 details:
     - Specify these properties in $xSamplerCreate via $x_sampler_desc_t as part
@@ -133,6 +163,20 @@ members:
       name: mipFilterMode
       desc: "[in] mipmap filter mode used for filtering between mipmap levels"
 --- #--------------------------------------------------------------------------
+type: struct
+desc: "Describes an interop memory resource descriptor"
+class: $xBindlessImages
+name: $x_exp_interop_memory_desc_t
+base: $x_base_desc_t
+members: []
+--- #--------------------------------------------------------------------------
+type: struct
+desc: "Describes an interop semaphore resource descriptor"
+class: $xBindlessImages
+name: $x_exp_interop_semaphore_desc_t
+base: $x_base_desc_t
+members: []
+--- #--------------------------------------------------------------------------
 type: function
 desc: "USM allocate pitched memory"
 class: $xUSM
@@ -518,9 +562,9 @@ params:
     - type: size_t
       name: size
       desc: "[in] size of the external memory"
-    - type: uint32_t
-      name: fileDescriptor
-      desc: "[in] the file descriptor"
+    - type: $x_exp_interop_memory_desc_t*
+      name: interopMemDesc
+      desc: "[in] the interop memory descriptor"
     - type: $x_exp_interop_mem_handle_t*
       name: phInteropMem
       desc: "[out] interop memory handle to the external memory"
@@ -597,11 +641,11 @@ params:
     - type: $x_device_handle_t
       name: hDevice
       desc: "[in] handle of the device object"
-    - type: uint32_t
-      name: fileDescriptor
-      desc: "[in] the file descriptor"
+    - type: $x_exp_interop_semaphore_desc_t*
+      name: interopSemaphoreDesc
+      desc: "[in] the interop semaphore descriptor"
     - type: $x_exp_interop_semaphore_handle_t*
-      name: phInteropSemaphoreHandle
+      name: phInteropSemaphore
       desc: "[out] interop semaphore handle to the external semaphore"
 returns:
     - $X_RESULT_ERROR_INVALID_CONTEXT