src/intel/vulkan/anv_extensions.py

   1 COPYRIGHT = """\
   2 /*
   3  * Copyright 2017 Intel Corporation
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the
  14  * next paragraph) shall be included in all copies or substantial portions
  15  * of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  20  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  21  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25 """
  26
  27 import copy
  28 import re
  29
  30 def _bool_to_c_expr(b):
  31     if b is True:
  32         return 'true'
  33     if b is False:
  34         return 'false'
  35     return b
  36
  37 class Extension:
  38     def __init__(self, name, ext_version, enable):
  39         self.name = name
  40         self.ext_version = int(ext_version)
  41         self.enable = _bool_to_c_expr(enable)
  42
  43 class ApiVersion:
  44     def __init__(self, version, enable):
  45         self.version = version
  46         self.enable = _bool_to_c_expr(enable)
  47
  48 API_PATCH_VERSION = 131
  49
  50 # Supported API versions.  Each one is the maximum patch version for the given
  51 # version.  Version come in increasing order and each version is available if
  52 # it's provided "enable" condition is true and all previous versions are
  53 # available.
  54 API_VERSIONS = [
  55     ApiVersion('1.0',   True),
  56     ApiVersion('1.1',   True),
  57     ApiVersion('1.2',   '!ANDROID'),
  58 ]
  59
  60 MAX_API_VERSION = None # Computed later
  61
  62 # On Android, we disable all surface and swapchain extensions. Android's Vulkan
  63 # loader implements VK_KHR_surface and VK_KHR_swapchain, and applications
  64 # cannot access the driver's implementation. Moreoever, if the driver exposes
  65 # the those extension strings, then tests dEQP-VK.api.info.instance.extensions
  66 # and dEQP-VK.api.info.device fail due to the duplicated strings.
  67 EXTENSIONS = [
  68     Extension('VK_KHR_8bit_storage',                      1, 'device->info.gen >= 8'),
  69     Extension('VK_KHR_16bit_storage',                     1, 'device->info.gen >= 8'),
  70     Extension('VK_KHR_bind_memory2',                      1, True),
  71     Extension('VK_KHR_buffer_device_address',             1, 'device->has_a64_buffer_access'),
  72     Extension('VK_KHR_create_renderpass2',                1, True),
  73     Extension('VK_KHR_dedicated_allocation',              1, True),
  74     Extension('VK_KHR_depth_stencil_resolve',             1, True),
  75     Extension('VK_KHR_descriptor_update_template',        1, True),
  76     Extension('VK_KHR_device_group',                      1, True),
  77     Extension('VK_KHR_device_group_creation',             1, True),
  78     Extension('VK_KHR_display',                          23, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  79     Extension('VK_KHR_draw_indirect_count',               1, True),
  80     Extension('VK_KHR_driver_properties',                 1, True),
  81     Extension('VK_KHR_external_fence',                    1,
  82               'device->has_syncobj_wait'),
  83     Extension('VK_KHR_external_fence_capabilities',       1, True),
  84     Extension('VK_KHR_external_fence_fd',                 1,
  85               'device->has_syncobj_wait'),
  86     Extension('VK_KHR_external_memory',                   1, True),
  87     Extension('VK_KHR_external_memory_capabilities',      1, True),
  88     Extension('VK_KHR_external_memory_fd',                1, True),
  89     Extension('VK_KHR_external_semaphore',                1, True),
  90     Extension('VK_KHR_external_semaphore_capabilities',   1, True),
  91     Extension('VK_KHR_external_semaphore_fd',             1, True),
  92     Extension('VK_KHR_get_display_properties2',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  93     Extension('VK_KHR_get_memory_requirements2',          1, True),
  94     Extension('VK_KHR_get_physical_device_properties2',   1, True),
  95     Extension('VK_KHR_get_surface_capabilities2',         1, 'ANV_HAS_SURFACE'),
  96     Extension('VK_KHR_image_format_list',                 1, True),
  97     Extension('VK_KHR_imageless_framebuffer',             1, True),
  98     Extension('VK_KHR_incremental_present',               1, 'ANV_HAS_SURFACE'),
  99     Extension('VK_KHR_maintenance1',                      1, True),
 100     Extension('VK_KHR_maintenance2',                      1, True),
 101     Extension('VK_KHR_maintenance3',                      1, True),
 102     Extension('VK_KHR_multiview',                         1, True),
 103     Extension('VK_KHR_pipeline_executable_properties',    1, True),
 104     Extension('VK_KHR_push_descriptor',                   1, True),
 105     Extension('VK_KHR_relaxed_block_layout',              1, True),
 106     Extension('VK_KHR_sampler_mirror_clamp_to_edge',      1, True),
 107     Extension('VK_KHR_sampler_ycbcr_conversion',          1, True),
 108     Extension('VK_KHR_separate_depth_stencil_layouts',    1, True),
 109     Extension('VK_KHR_shader_atomic_int64',               1,
 110               'device->info.gen >= 9 && device->use_softpin'),
 111     Extension('VK_KHR_shader_clock',                      1, True),
 112     Extension('VK_KHR_shader_draw_parameters',            1, True),
 113     Extension('VK_KHR_shader_float16_int8',               1, 'device->info.gen >= 8'),
 114     Extension('VK_KHR_shader_float_controls',             1, 'device->info.gen >= 8'),
 115     Extension('VK_KHR_shader_non_semantic_info',          1, True),
 116     Extension('VK_KHR_shader_subgroup_extended_types',    1, 'device->info.gen >= 8'),
 117     Extension('VK_KHR_spirv_1_4',                         1, True),
 118     Extension('VK_KHR_storage_buffer_storage_class',      1, True),
 119     Extension('VK_KHR_surface',                          25, 'ANV_HAS_SURFACE'),
 120     Extension('VK_KHR_surface_protected_capabilities',    1, 'ANV_HAS_SURFACE'),
 121     Extension('VK_KHR_swapchain',                        70, 'ANV_HAS_SURFACE'),
 122     Extension('VK_KHR_swapchain_mutable_format',          1, 'ANV_HAS_SURFACE'),
 123     Extension('VK_KHR_timeline_semaphore',                1, True),
 124     Extension('VK_KHR_uniform_buffer_standard_layout',    1, True),
 125     Extension('VK_KHR_variable_pointers',                 1, True),
 126     Extension('VK_KHR_vulkan_memory_model',               3, True),
 127     Extension('VK_KHR_wayland_surface',                   6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
 128     Extension('VK_KHR_xcb_surface',                       6, 'VK_USE_PLATFORM_XCB_KHR'),
 129     Extension('VK_KHR_xlib_surface',                      6, 'VK_USE_PLATFORM_XLIB_KHR'),
 130     Extension('VK_EXT_acquire_xlib_display',              1, 'VK_USE_PLATFORM_XLIB_XRANDR_EXT'),
 131     Extension('VK_EXT_buffer_device_address',             1, 'device->has_a64_buffer_access'),
 132     Extension('VK_EXT_calibrated_timestamps',             1, True),
 133     Extension('VK_EXT_conditional_rendering',             1, 'device->info.gen >= 8 || device->info.is_haswell'),
 134     Extension('VK_EXT_debug_report',                      8, True),
 135     Extension('VK_EXT_depth_clip_enable',                 1, True),
 136     Extension('VK_EXT_descriptor_indexing',               2,
 137               'device->has_a64_buffer_access && device->has_bindless_images'),
 138     Extension('VK_EXT_direct_mode_display',               1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 139     Extension('VK_EXT_display_control',                   1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 140     Extension('VK_EXT_display_surface_counter',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 141     Extension('VK_EXT_external_memory_dma_buf',           1, True),
 142     Extension('VK_EXT_external_memory_host',              1, True),
 143     Extension('VK_EXT_fragment_shader_interlock',         1, 'device->info.gen >= 9'),
 144     Extension('VK_EXT_global_priority',                   1,
 145               'device->has_context_priority'),
 146     Extension('VK_EXT_host_query_reset',                  1, True),
 147     Extension('VK_EXT_image_drm_format_modifier',         1, False),
 148     Extension('VK_EXT_index_type_uint8',                  1, True),
 149     Extension('VK_EXT_inline_uniform_block',              1, True),
 150     Extension('VK_EXT_line_rasterization',                1, True),
 151     Extension('VK_EXT_memory_budget',                     1, 'device->has_mem_available'),
 152     Extension('VK_EXT_pci_bus_info',                      2, True),
 153     Extension('VK_EXT_pipeline_creation_feedback',        1, True),
 154     Extension('VK_EXT_post_depth_coverage',               1, 'device->info.gen >= 9'),
 155     Extension('VK_EXT_queue_family_foreign',              1, 'ANDROID'),
 156     Extension('VK_EXT_robustness2',                       1, True),
 157     Extension('VK_EXT_sampler_filter_minmax',             1, 'device->info.gen >= 9'),
 158     Extension('VK_EXT_scalar_block_layout',               1, True),
 159     Extension('VK_EXT_separate_stencil_usage',            1, True),
 160     Extension('VK_EXT_shader_demote_to_helper_invocation', 1, True),
 161     Extension('VK_EXT_shader_stencil_export',             1, 'device->info.gen >= 9'),
 162     Extension('VK_EXT_shader_subgroup_ballot',            1, True),
 163     Extension('VK_EXT_shader_subgroup_vote',              1, True),
 164     Extension('VK_EXT_shader_viewport_index_layer',       1, True),
 165     Extension('VK_EXT_subgroup_size_control',             2, True),
 166     Extension('VK_EXT_texel_buffer_alignment',            1, True),
 167     Extension('VK_EXT_transform_feedback',                1, 'device->info.gen >= 8'),
 168     Extension('VK_EXT_vertex_attribute_divisor',          3, True),
 169     Extension('VK_EXT_ycbcr_image_arrays',                1, True),
 170     Extension('VK_ANDROID_external_memory_android_hardware_buffer', 3, 'ANDROID'),
 171     Extension('VK_ANDROID_native_buffer',                 7, 'ANDROID'),
 172     Extension('VK_GOOGLE_decorate_string',                1, True),
 173     Extension('VK_GOOGLE_hlsl_functionality1',            1, True),
 174     Extension('VK_INTEL_performance_query',               1, 'device->perf && device->perf->i915_perf_version >= 3'),
 175     Extension('VK_INTEL_shader_integer_functions2',       1, 'device->info.gen >= 8'),
 176     Extension('VK_NV_compute_shader_derivatives',         1, True),
 177 ]
 178
 179 # Sort the extension list the way we expect: KHR, then EXT, then vendors
 180 # alphabetically. For digits, read them as a whole number sort that.
 181 # eg.: VK_KHR_8bit_storage < VK_KHR_16bit_storage < VK_EXT_acquire_xlib_display
 182 def extension_order(ext):
 183     order = []
 184     for substring in re.split('(KHR|EXT|[0-9]+)', ext.name):
 185         if substring == 'KHR':
 186             order.append(1)
 187         if substring == 'EXT':
 188             order.append(2)
 189         elif substring.isdigit():
 190             order.append(int(substring))
 191         else:
 192             order.append(substring)
 193     return order
 194 for i in range(len(EXTENSIONS) - 1):
 195     if extension_order(EXTENSIONS[i + 1]) < extension_order(EXTENSIONS[i]):
 196         print(EXTENSIONS[i + 1].name + ' should come before ' + EXTENSIONS[i].name)
 197         exit(1)
 198
 199 class VkVersion:
 200     def __init__(self, string):
 201         split = string.split('.')
 202         self.major = int(split[0])
 203         self.minor = int(split[1])
 204         if len(split) > 2:
 205             assert len(split) == 3
 206             self.patch = int(split[2])
 207         else:
 208             self.patch = None
 209
 210         # Sanity check.  The range bits are required by the definition of the
 211         # VK_MAKE_VERSION macro
 212         assert self.major < 1024 and self.minor < 1024
 213         assert self.patch is None or self.patch < 4096
 214         assert str(self) == string
 215
 216     def __str__(self):
 217         ver_list = [str(self.major), str(self.minor)]
 218         if self.patch is not None:
 219             ver_list.append(str(self.patch))
 220         return '.'.join(ver_list)
 221
 222     def c_vk_version(self):
 223         patch = self.patch if self.patch is not None else 0
 224         ver_list = [str(self.major), str(self.minor), str(patch)]
 225         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
 226
 227     def __int_ver(self):
 228         # This is just an expansion of VK_VERSION
 229         patch = self.patch if self.patch is not None else 0
 230         return (self.major << 22) | (self.minor << 12) | patch
 231
 232     def __gt__(self, other):
 233         # If only one of them has a patch version, "ignore" it by making
 234         # other's patch version match self.
 235         if (self.patch is None) != (other.patch is None):
 236             other = copy.copy(other)
 237             other.patch = self.patch
 238
 239         return self.__int_ver() > other.__int_ver()
 240
 241
 242
 243 MAX_API_VERSION = VkVersion('0.0.0')
 244 for version in API_VERSIONS:
 245     version.version = VkVersion(version.version)
 246     version.version.patch = API_PATCH_VERSION
 247     assert version.version > MAX_API_VERSION
 248     MAX_API_VERSION = version.version
 249
 250 # Mapping between extension name and the android version in which the extension
 251 # was whitelisted in Android CTS.
 252 allowed_android_version = {
 253     # Allowed Instance KHR Extensions
 254     "VK_KHR_surface": 26,
 255     "VK_KHR_display": 26,
 256     "VK_KHR_android_surface": 26,
 257     "VK_KHR_mir_surface": 26,
 258     "VK_KHR_wayland_surface": 26,
 259     "VK_KHR_win32_surface": 26,
 260     "VK_KHR_xcb_surface": 26,
 261     "VK_KHR_xlib_surface": 26,
 262     "VK_KHR_get_physical_device_properties2": 26,
 263     "VK_KHR_get_surface_capabilities2": 26,
 264     "VK_KHR_external_memory_capabilities": 28,
 265     "VK_KHR_external_semaphore_capabilities": 28,
 266     "VK_KHR_external_fence_capabilities": 28,
 267     "VK_KHR_device_group_creation": 28,
 268     "VK_KHR_get_display_properties2": 29,
 269     "VK_KHR_surface_protected_capabilities": 29,
 270
 271     # Allowed Device KHR Extensions
 272     "VK_KHR_swapchain": 26,
 273     "VK_KHR_display_swapchain": 26,
 274     "VK_KHR_sampler_mirror_clamp_to_edge": 26,
 275     "VK_KHR_shader_draw_parameters": 26,
 276     "VK_KHR_shader_float_controls": 29,
 277     "VK_KHR_shader_float16_int8": 29,
 278     "VK_KHR_maintenance1": 26,
 279     "VK_KHR_push_descriptor": 26,
 280     "VK_KHR_descriptor_update_template": 26,
 281     "VK_KHR_incremental_present": 26,
 282     "VK_KHR_shared_presentable_image": 26,
 283     "VK_KHR_storage_buffer_storage_class": 28,
 284     "VK_KHR_8bit_storage": 29,
 285     "VK_KHR_16bit_storage": 28,
 286     "VK_KHR_get_memory_requirements2": 28,
 287     "VK_KHR_external_memory": 28,
 288     "VK_KHR_external_memory_fd": 28,
 289     "VK_KHR_external_memory_win32": 28,
 290     "VK_KHR_external_semaphore": 28,
 291     "VK_KHR_external_semaphore_fd": 28,
 292     "VK_KHR_external_semaphore_win32": 28,
 293     "VK_KHR_external_fence": 28,
 294     "VK_KHR_external_fence_fd": 28,
 295     "VK_KHR_external_fence_win32": 28,
 296     "VK_KHR_win32_keyed_mutex": 28,
 297     "VK_KHR_dedicated_allocation": 28,
 298     "VK_KHR_variable_pointers": 28,
 299     "VK_KHR_relaxed_block_layout": 28,
 300     "VK_KHR_bind_memory2": 28,
 301     "VK_KHR_maintenance2": 28,
 302     "VK_KHR_image_format_list": 28,
 303     "VK_KHR_sampler_ycbcr_conversion": 28,
 304     "VK_KHR_device_group": 28,
 305     "VK_KHR_multiview": 28,
 306     "VK_KHR_maintenance3": 28,
 307     "VK_KHR_draw_indirect_count": 28,
 308     "VK_KHR_create_renderpass2": 28,
 309     "VK_KHR_depth_stencil_resolve": 29,
 310     "VK_KHR_driver_properties": 28,
 311     "VK_KHR_swapchain_mutable_format": 29,
 312     "VK_KHR_shader_atomic_int64": 29,
 313     "VK_KHR_vulkan_memory_model": 29,
 314
 315     "VK_GOOGLE_display_timing": 26,
 316     "VK_ANDROID_native_buffer": 26,
 317     "VK_ANDROID_external_memory_android_hardware_buffer": 28,
 318 }
 319
 320 # Extensions with these prefixes are checked in Android CTS, and thus must be
 321 # whitelisted per the preceding dict.
 322 android_extension_whitelist_prefixes = (
 323     "VK_KHX",
 324     "VK_KHR",
 325     "VK_GOOGLE",
 326     "VK_ANDROID"
 327 )
 328
 329 def get_extension_condition(ext_name, condition):
 330     """ If |ext_name| is an extension that Android CTS cares about, prepend
 331         a condition to ensure that the extension is only enabled for Android
 332         versions in which the extension is whitelisted in CTS. """
 333     if not ext_name.startswith(android_extension_whitelist_prefixes):
 334         return condition
 335     allowed_version = allowed_android_version.get(ext_name, 9999)
 336     return "(!ANDROID || ANDROID_API_LEVEL >= %d) && (%s)" % (allowed_version,
 337                                                               condition)