Merge pull request #980 from isaacault/iault/remove-layered-images

[Bindless][Exp] Layered Images Re-Work
oneapi-src · Dec 12, 2023 · 20b9a83 · 20b9a83
2 parents 69a56ea + d39b4d0
commit 20b9a83
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 129 deletions.
diff --git a/include/ur.py b/include/ur.py
@@ -256,8 +256,7 @@ class ur_structure_type_v(IntEnum):
  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
- EXP_LAYERED_IMAGE_PROPERTIES = 0x2005 ## ::ur_exp_layered_image_properties_t
- EXP_SAMPLER_ADDR_MODES = 0x2006 ## ::ur_exp_sampler_addr_modes_t
+ EXP_SAMPLER_ADDR_MODES = 0x2005 ## ::ur_exp_sampler_addr_modes_t
 
 class ur_structure_type_t(c_int):
  def __str__(self):
@@ -2294,21 +2293,6 @@ class ur_exp_interop_semaphore_desc_t(Structure):
  ("pNext", c_void_p) ## [in][optional] pointer to extension-specific structure
  ]
 
-###############################################################################
-## @brief Describes layered image properties
-## 
-## @details
-## - Specify these properties in ::urBindlessImagesUnsampledImageCreateExp
-## or ::urBindlessImagesSampledImageCreateExp via ::ur_image_desc_t as
-## part of a `pNext` chain.
-class ur_exp_layered_image_properties_t(Structure):
- _fields_ = [
- ("stype", ur_structure_type_t), ## [in] type of this structure, must be
- ## ::UR_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES
- ("pNext", c_void_p), ## [in,out][optional] pointer to extension-specific structure
- ("numLayers", c_ulong) ## [in] number of layers the image should have
- ]
-
 ###############################################################################
 ## @brief The extension string which defines support for command-buffers which
 ## is returned when querying device extensions.

diff --git a/include/ur_api.h b/include/ur_api.h
@@ -224,49 +224,48 @@ typedef enum ur_function_t {
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief Defines structure types
 typedef enum ur_structure_type_t {
- UR_STRUCTURE_TYPE_CONTEXT_PROPERTIES = 0, ///< ::ur_context_properties_t
- UR_STRUCTURE_TYPE_IMAGE_DESC = 1, ///< ::ur_image_desc_t
- UR_STRUCTURE_TYPE_BUFFER_PROPERTIES = 2, ///< ::ur_buffer_properties_t
- UR_STRUCTURE_TYPE_BUFFER_REGION = 3, ///< ::ur_buffer_region_t
- UR_STRUCTURE_TYPE_BUFFER_CHANNEL_PROPERTIES = 4, ///< ::ur_buffer_channel_properties_t
- UR_STRUCTURE_TYPE_BUFFER_ALLOC_LOCATION_PROPERTIES = 5, ///< ::ur_buffer_alloc_location_properties_t
- UR_STRUCTURE_TYPE_PROGRAM_PROPERTIES = 6, ///< ::ur_program_properties_t
- UR_STRUCTURE_TYPE_USM_DESC = 7, ///< ::ur_usm_desc_t
- UR_STRUCTURE_TYPE_USM_HOST_DESC = 8, ///< ::ur_usm_host_desc_t
- UR_STRUCTURE_TYPE_USM_DEVICE_DESC = 9, ///< ::ur_usm_device_desc_t
- UR_STRUCTURE_TYPE_USM_POOL_DESC = 10, ///< ::ur_usm_pool_desc_t
- UR_STRUCTURE_TYPE_USM_POOL_LIMITS_DESC = 11, ///< ::ur_usm_pool_limits_desc_t
- UR_STRUCTURE_TYPE_DEVICE_BINARY = 12, ///< ::ur_device_binary_t
- UR_STRUCTURE_TYPE_SAMPLER_DESC = 13, ///< ::ur_sampler_desc_t
- UR_STRUCTURE_TYPE_QUEUE_PROPERTIES = 14, ///< ::ur_queue_properties_t
- UR_STRUCTURE_TYPE_QUEUE_INDEX_PROPERTIES = 15, ///< ::ur_queue_index_properties_t
- UR_STRUCTURE_TYPE_CONTEXT_NATIVE_PROPERTIES = 16, ///< ::ur_context_native_properties_t
- UR_STRUCTURE_TYPE_KERNEL_NATIVE_PROPERTIES = 17, ///< ::ur_kernel_native_properties_t
- UR_STRUCTURE_TYPE_QUEUE_NATIVE_PROPERTIES = 18, ///< ::ur_queue_native_properties_t
- UR_STRUCTURE_TYPE_MEM_NATIVE_PROPERTIES = 19, ///< ::ur_mem_native_properties_t
- UR_STRUCTURE_TYPE_EVENT_NATIVE_PROPERTIES = 20, ///< ::ur_event_native_properties_t
- UR_STRUCTURE_TYPE_PLATFORM_NATIVE_PROPERTIES = 21, ///< ::ur_platform_native_properties_t
- UR_STRUCTURE_TYPE_DEVICE_NATIVE_PROPERTIES = 22, ///< ::ur_device_native_properties_t
- UR_STRUCTURE_TYPE_PROGRAM_NATIVE_PROPERTIES = 23, ///< ::ur_program_native_properties_t
- UR_STRUCTURE_TYPE_SAMPLER_NATIVE_PROPERTIES = 24, ///< ::ur_sampler_native_properties_t
- UR_STRUCTURE_TYPE_QUEUE_NATIVE_DESC = 25, ///< ::ur_queue_native_desc_t
- UR_STRUCTURE_TYPE_DEVICE_PARTITION_PROPERTIES = 26, ///< ::ur_device_partition_properties_t
- UR_STRUCTURE_TYPE_KERNEL_ARG_MEM_OBJ_PROPERTIES = 27, ///< ::ur_kernel_arg_mem_obj_properties_t
- UR_STRUCTURE_TYPE_PHYSICAL_MEM_PROPERTIES = 28, ///< ::ur_physical_mem_properties_t
- UR_STRUCTURE_TYPE_KERNEL_ARG_POINTER_PROPERTIES = 29, ///< ::ur_kernel_arg_pointer_properties_t
- UR_STRUCTURE_TYPE_KERNEL_ARG_SAMPLER_PROPERTIES = 30, ///< ::ur_kernel_arg_sampler_properties_t
- UR_STRUCTURE_TYPE_KERNEL_EXEC_INFO_PROPERTIES = 31, ///< ::ur_kernel_exec_info_properties_t
- UR_STRUCTURE_TYPE_KERNEL_ARG_VALUE_PROPERTIES = 32, ///< ::ur_kernel_arg_value_properties_t
- UR_STRUCTURE_TYPE_KERNEL_ARG_LOCAL_PROPERTIES = 33, ///< ::ur_kernel_arg_local_properties_t
- UR_STRUCTURE_TYPE_USM_ALLOC_LOCATION_DESC = 35, ///< ::ur_usm_alloc_location_desc_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_MEM_DESC = 0x2001, ///< ::ur_exp_interop_mem_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
- UR_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES = 0x2005, ///< ::ur_exp_layered_image_properties_t
- UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES = 0x2006, ///< ::ur_exp_sampler_addr_modes_t
+ UR_STRUCTURE_TYPE_CONTEXT_PROPERTIES = 0, ///< ::ur_context_properties_t
+ UR_STRUCTURE_TYPE_IMAGE_DESC = 1, ///< ::ur_image_desc_t
+ UR_STRUCTURE_TYPE_BUFFER_PROPERTIES = 2, ///< ::ur_buffer_properties_t
+ UR_STRUCTURE_TYPE_BUFFER_REGION = 3, ///< ::ur_buffer_region_t
+ UR_STRUCTURE_TYPE_BUFFER_CHANNEL_PROPERTIES = 4, ///< ::ur_buffer_channel_properties_t
+ UR_STRUCTURE_TYPE_BUFFER_ALLOC_LOCATION_PROPERTIES = 5, ///< ::ur_buffer_alloc_location_properties_t
+ UR_STRUCTURE_TYPE_PROGRAM_PROPERTIES = 6, ///< ::ur_program_properties_t
+ UR_STRUCTURE_TYPE_USM_DESC = 7, ///< ::ur_usm_desc_t
+ UR_STRUCTURE_TYPE_USM_HOST_DESC = 8, ///< ::ur_usm_host_desc_t
+ UR_STRUCTURE_TYPE_USM_DEVICE_DESC = 9, ///< ::ur_usm_device_desc_t
+ UR_STRUCTURE_TYPE_USM_POOL_DESC = 10, ///< ::ur_usm_pool_desc_t
+ UR_STRUCTURE_TYPE_USM_POOL_LIMITS_DESC = 11, ///< ::ur_usm_pool_limits_desc_t
+ UR_STRUCTURE_TYPE_DEVICE_BINARY = 12, ///< ::ur_device_binary_t
+ UR_STRUCTURE_TYPE_SAMPLER_DESC = 13, ///< ::ur_sampler_desc_t
+ UR_STRUCTURE_TYPE_QUEUE_PROPERTIES = 14, ///< ::ur_queue_properties_t
+ UR_STRUCTURE_TYPE_QUEUE_INDEX_PROPERTIES = 15, ///< ::ur_queue_index_properties_t
+ UR_STRUCTURE_TYPE_CONTEXT_NATIVE_PROPERTIES = 16, ///< ::ur_context_native_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_NATIVE_PROPERTIES = 17, ///< ::ur_kernel_native_properties_t
+ UR_STRUCTURE_TYPE_QUEUE_NATIVE_PROPERTIES = 18, ///< ::ur_queue_native_properties_t
+ UR_STRUCTURE_TYPE_MEM_NATIVE_PROPERTIES = 19, ///< ::ur_mem_native_properties_t
+ UR_STRUCTURE_TYPE_EVENT_NATIVE_PROPERTIES = 20, ///< ::ur_event_native_properties_t
+ UR_STRUCTURE_TYPE_PLATFORM_NATIVE_PROPERTIES = 21, ///< ::ur_platform_native_properties_t
+ UR_STRUCTURE_TYPE_DEVICE_NATIVE_PROPERTIES = 22, ///< ::ur_device_native_properties_t
+ UR_STRUCTURE_TYPE_PROGRAM_NATIVE_PROPERTIES = 23, ///< ::ur_program_native_properties_t
+ UR_STRUCTURE_TYPE_SAMPLER_NATIVE_PROPERTIES = 24, ///< ::ur_sampler_native_properties_t
+ UR_STRUCTURE_TYPE_QUEUE_NATIVE_DESC = 25, ///< ::ur_queue_native_desc_t
+ UR_STRUCTURE_TYPE_DEVICE_PARTITION_PROPERTIES = 26, ///< ::ur_device_partition_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_ARG_MEM_OBJ_PROPERTIES = 27, ///< ::ur_kernel_arg_mem_obj_properties_t
+ UR_STRUCTURE_TYPE_PHYSICAL_MEM_PROPERTIES = 28, ///< ::ur_physical_mem_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_ARG_POINTER_PROPERTIES = 29, ///< ::ur_kernel_arg_pointer_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_ARG_SAMPLER_PROPERTIES = 30, ///< ::ur_kernel_arg_sampler_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_EXEC_INFO_PROPERTIES = 31, ///< ::ur_kernel_exec_info_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_ARG_VALUE_PROPERTIES = 32, ///< ::ur_kernel_arg_value_properties_t
+ UR_STRUCTURE_TYPE_KERNEL_ARG_LOCAL_PROPERTIES = 33, ///< ::ur_kernel_arg_local_properties_t
+ UR_STRUCTURE_TYPE_USM_ALLOC_LOCATION_DESC = 35, ///< ::ur_usm_alloc_location_desc_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_MEM_DESC = 0x2001, ///< ::ur_exp_interop_mem_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
+ UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES = 0x2005, ///< ::ur_exp_sampler_addr_modes_t
  /// @cond
  UR_STRUCTURE_TYPE_FORCE_UINT32 = 0x7fffffff
  /// @endcond
@@ -7152,21 +7151,6 @@ typedef struct ur_exp_interop_semaphore_desc_t {
 
 } ur_exp_interop_semaphore_desc_t;
 
-///////////////////////////////////////////////////////////////////////////////
-/// @brief Describes layered image properties
-///
-/// @details
-/// - Specify these properties in ::urBindlessImagesUnsampledImageCreateExp
-/// or ::urBindlessImagesSampledImageCreateExp via ::ur_image_desc_t as
-/// part of a `pNext` chain.
-typedef struct ur_exp_layered_image_properties_t {
- ur_structure_type_t stype; ///< [in] type of this structure, must be
- ///< ::UR_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES
- void *pNext; ///< [in,out][optional] pointer to extension-specific structure
- uint32_t numLayers; ///< [in] number of layers the image should have
-
-} ur_exp_layered_image_properties_t;
-
 ///////////////////////////////////////////////////////////////////////////////
 /// @brief USM allocate pitched memory
 ///

diff --git a/include/ur_print.hpp b/include/ur_print.hpp
@@ -318,7 +318,6 @@ inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct
 inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_sampler_addr_modes_t params);
 inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_interop_mem_desc_t params);
 inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_interop_semaphore_desc_t params);
-inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_layered_image_properties_t params);
 inline std::ostream &operator<<(std::ostream &os, [[maybe_unused]] const struct ur_exp_command_buffer_desc_t params);
 inline std::ostream &operator<<(std::ostream &os, ur_exp_peer_info_t value);
 
@@ -1015,9 +1014,6 @@ inline std::ostream &operator<<(std::ostream &os, ur_structure_type_t value) {
  case UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE:
  os << "UR_STRUCTURE_TYPE_EXP_WIN32_HANDLE";
  break;
- case UR_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES:
- os << "UR_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES";
- break;
  case UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES:
  os << "UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES";
  break;
@@ -1243,11 +1239,6 @@ inline ur_result_t printStruct(std::ostream &os, const void *ptr) {
  printPtr(os, pstruct);
  } break;
 
- case UR_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES: {
- const ur_exp_layered_image_properties_t *pstruct = (const ur_exp_layered_image_properties_t *)ptr;
- printPtr(os, pstruct);
- } break;
-
  case UR_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES: {
  const ur_exp_sampler_addr_modes_t *pstruct = (const ur_exp_sampler_addr_modes_t *)ptr;
  printPtr(os, pstruct);
@@ -9130,31 +9121,6 @@ inline std::ostream &operator<<(std::ostream &os, const struct ur_exp_interop_se
  return os;
 }
 ///////////////////////////////////////////////////////////////////////////////
-/// @brief Print operator for the ur_exp_layered_image_properties_t type
-/// @returns
-/// std::ostream &
-inline std::ostream &operator<<(std::ostream &os, const struct ur_exp_layered_image_properties_t params) {
- os << "(struct ur_exp_layered_image_properties_t){";
-
- os << ".stype = ";
-
- os << (params.stype);
-
- os << ", ";
- os << ".pNext = ";
-
- ur::details::printStruct(os,
- (params.pNext));
-
- os << ", ";
- os << ".numLayers = ";
-
- os << (params.numLayers);
-
- os << "}";
- return os;
-}
-///////////////////////////////////////////////////////////////////////////////
 /// @brief Print operator for the ur_exp_command_buffer_desc_t type
 /// @returns
 /// std::ostream &

diff --git a/scripts/core/EXP-BINDLESS-IMAGES.rst b/scripts/core/EXP-BINDLESS-IMAGES.rst
@@ -68,7 +68,6 @@ Enums
  ${X}_STRUCTURE_TYPE_EXP_INTEROP_SEMAPHORE_DESC
  ${X}_STRUCTURE_TYPE_EXP_FILE_DESCRIPTOR
  ${X}_STRUCTURE_TYPE_EXP_WIN32_HANDLE
- ${X}_STRUCTURE_TYPE_EXP_LAYERED_IMAGE_PROPERTIES 
  ${X}_STRUCTURE_TYPE_EXP_SAMPLER_ADDR_MODES
 
 * ${x}_device_info_t
@@ -129,7 +128,6 @@ Types
 * ${x}_exp_interop_semaphore_desc_t
 * ${x}_exp_file_descriptor_t
 * ${x}_exp_win32_handle_t
-* ${x}_exp_layered_image_properties_t
 * ${x}_exp_sampler_addr_modes_t
 
 Functions
@@ -184,6 +182,8 @@ Changelog
 +----------+-------------------------------------------------------------+
 | 8.0 | Added structure for sampler addressing modes per dimension. |
 +------------------------------------------------------------------------+
+| 9.0 | Remove layered image properties struct. |
++------------------------------------------------------------------------+
 
 Contributors
 --------------------------------------------------------------------------------

diff --git a/scripts/core/exp-bindless-images.yml b/scripts/core/exp-bindless-images.yml
@@ -107,12 +107,9 @@ etors:
  - name: EXP_WIN32_HANDLE
  desc: $x_exp_win32_handle_t
  value: "0x2004"
- - name: EXP_LAYERED_IMAGE_PROPERTIES
- desc: $x_exp_layered_image_properties_t
- value: "0x2005"
  - name: EXP_SAMPLER_ADDR_MODES
  desc: $x_exp_sampler_addr_modes_t
- value: "0x2006"
+ value: "0x2005"
 --- #--------------------------------------------------------------------------
 type: enum
 extend: true
@@ -205,20 +202,6 @@ name: $x_exp_interop_semaphore_desc_t
 base: $x_base_desc_t
 members: []
 --- #--------------------------------------------------------------------------
-type: struct
-desc: "Describes layered image properties"
-details:
- - Specify these properties in $xBindlessImagesUnsampledImageCreateExp or 
- $xBindlessImagesSampledImageCreateExp via $x_image_desc_t as part of a 
- `pNext` chain.
-class: $xBindlessImages
-name: $x_exp_layered_image_properties_t
-base: $x_base_properties_t
-members:
- - type: uint32_t
- name: numLayers
- desc: "[in] number of layers the image should have"
---- #--------------------------------------------------------------------------
 type: function
 desc: "USM allocate pitched memory"
 class: $xUSM