src/amd/vulkan/radv_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 argparse
  28 import copy
  29 import re
  30 import xml.etree.cElementTree as et
  31
  32 from mako.template import Template
  33
  34 MAX_API_VERSION = '1.1.107'
  35
  36 class Extension:
  37     def __init__(self, name, ext_version, enable):
  38         self.name = name
  39         self.ext_version = int(ext_version)
  40         if enable is True:
  41             self.enable = 'true';
  42         elif enable is False:
  43             self.enable = 'false';
  44         else:
  45             self.enable = enable;
  46
  47 # On Android, we disable all surface and swapchain extensions. Android's Vulkan
  48 # loader implements VK_KHR_surface and VK_KHR_swapchain, and applications
  49 # cannot access the driver's implementation. Moreoever, if the driver exposes
  50 # the those extension strings, then tests dEQP-VK.api.info.instance.extensions
  51 # and dEQP-VK.api.info.device fail due to the duplicated strings.
  52 EXTENSIONS = [
  53     Extension('VK_ANDROID_external_memory_android_hardware_buffer', 3, 'RADV_SUPPORT_ANDROID_HARDWARE_BUFFER  && device->rad_info.has_syncobj_wait_for_submit'),
  54     Extension('VK_ANDROID_native_buffer',                 5, 'ANDROID && device->rad_info.has_syncobj_wait_for_submit'),
  55     Extension('VK_KHR_16bit_storage',                     1, '!device->use_aco'),
  56     Extension('VK_KHR_bind_memory2',                      1, True),
  57     Extension('VK_KHR_create_renderpass2',                1, True),
  58     Extension('VK_KHR_dedicated_allocation',              1, True),
  59     Extension('VK_KHR_depth_stencil_resolve',             1, True),
  60     Extension('VK_KHR_descriptor_update_template',        1, True),
  61     Extension('VK_KHR_device_group',                      1, True),
  62     Extension('VK_KHR_device_group_creation',             1, True),
  63     Extension('VK_KHR_draw_indirect_count',               1, True),
  64     Extension('VK_KHR_driver_properties',                 1, True),
  65     Extension('VK_KHR_external_fence',                    1, 'device->rad_info.has_syncobj_wait_for_submit'),
  66     Extension('VK_KHR_external_fence_capabilities',       1, True),
  67     Extension('VK_KHR_external_fence_fd',                 1, 'device->rad_info.has_syncobj_wait_for_submit'),
  68     Extension('VK_KHR_external_memory',                   1, True),
  69     Extension('VK_KHR_external_memory_capabilities',      1, True),
  70     Extension('VK_KHR_external_memory_fd',                1, True),
  71     Extension('VK_KHR_external_semaphore',                1, 'device->rad_info.has_syncobj'),
  72     Extension('VK_KHR_external_semaphore_capabilities',   1, True),
  73     Extension('VK_KHR_external_semaphore_fd',             1, 'device->rad_info.has_syncobj'),
  74     Extension('VK_KHR_get_display_properties2',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  75     Extension('VK_KHR_get_memory_requirements2',          1, True),
  76     Extension('VK_KHR_get_physical_device_properties2',   1, True),
  77     Extension('VK_KHR_get_surface_capabilities2',         1, 'RADV_HAS_SURFACE'),
  78     Extension('VK_KHR_image_format_list',                 1, True),
  79     Extension('VK_KHR_imageless_framebuffer',             1, True),
  80     Extension('VK_KHR_incremental_present',               1, 'RADV_HAS_SURFACE'),
  81     Extension('VK_KHR_maintenance1',                      1, True),
  82     Extension('VK_KHR_maintenance2',                      1, True),
  83     Extension('VK_KHR_maintenance3',                      1, True),
  84     Extension('VK_KHR_pipeline_executable_properties',    1, True),
  85     Extension('VK_KHR_push_descriptor',                   1, True),
  86     Extension('VK_KHR_relaxed_block_layout',              1, True),
  87     Extension('VK_KHR_sampler_mirror_clamp_to_edge',      1, True),
  88     Extension('VK_KHR_sampler_ycbcr_conversion',          1, True),
  89     Extension('VK_KHR_shader_atomic_int64',               1, 'LLVM_VERSION_MAJOR >= 9'),
  90     Extension('VK_KHR_shader_clock',                      1, True),
  91     Extension('VK_KHR_shader_draw_parameters',            1, True),
  92     Extension('VK_KHR_shader_float_controls',             1, '!device->use_aco'),
  93     Extension('VK_KHR_shader_float16_int8',               1, '!device->use_aco'),
  94     Extension('VK_KHR_spirv_1_4',                         1, True),
  95     Extension('VK_KHR_storage_buffer_storage_class',      1, True),
  96     Extension('VK_KHR_surface',                          25, 'RADV_HAS_SURFACE'),
  97     Extension('VK_KHR_surface_protected_capabilities',    1, 'RADV_HAS_SURFACE'),
  98     Extension('VK_KHR_swapchain',                        68, 'RADV_HAS_SURFACE'),
  99     Extension('VK_KHR_timeline_semaphore',                2, False),
 100     Extension('VK_KHR_uniform_buffer_standard_layout',    1, True),
 101     Extension('VK_KHR_variable_pointers',                 1, True),
 102     Extension('VK_KHR_wayland_surface',                   6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
 103     Extension('VK_KHR_xcb_surface',                       6, 'VK_USE_PLATFORM_XCB_KHR'),
 104     Extension('VK_KHR_xlib_surface',                      6, 'VK_USE_PLATFORM_XLIB_KHR'),
 105     Extension('VK_KHR_multiview',                         1, True),
 106     Extension('VK_KHR_display',                          23, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 107     Extension('VK_KHR_8bit_storage',                      1, 'device->rad_info.chip_class >= GFX8 && !device->use_aco'),
 108     Extension('VK_EXT_direct_mode_display',               1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 109     Extension('VK_EXT_acquire_xlib_display',              1, 'VK_USE_PLATFORM_XLIB_XRANDR_EXT'),
 110     Extension('VK_EXT_buffer_device_address',             1, True),
 111     Extension('VK_EXT_calibrated_timestamps',             1, True),
 112     Extension('VK_EXT_conditional_rendering',             1, True),
 113     Extension('VK_EXT_conservative_rasterization',        1, 'device->rad_info.chip_class >= GFX9'),
 114     Extension('VK_EXT_display_surface_counter',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 115     Extension('VK_EXT_display_control',                   1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
 116     Extension('VK_EXT_debug_report',                      9, True),
 117     Extension('VK_EXT_depth_clip_enable',                 1, True),
 118     Extension('VK_EXT_depth_range_unrestricted',          1, True),
 119     Extension('VK_EXT_descriptor_indexing',               2, True),
 120     Extension('VK_EXT_discard_rectangles',                1, True),
 121     Extension('VK_EXT_external_memory_dma_buf',           1, True),
 122     Extension('VK_EXT_external_memory_host',              1, 'device->rad_info.has_userptr'),
 123     Extension('VK_EXT_global_priority',                   1, 'device->rad_info.has_ctx_priority'),
 124     Extension('VK_EXT_host_query_reset',                  1, True),
 125     Extension('VK_EXT_index_type_uint8',                  1, 'device->rad_info.chip_class >= GFX8'),
 126     Extension('VK_EXT_inline_uniform_block',              1, True),
 127     Extension('VK_EXT_memory_budget',                     1, True),
 128     Extension('VK_EXT_memory_priority',                   1, True),
 129     Extension('VK_EXT_pci_bus_info',                      2, True),
 130     Extension('VK_EXT_pipeline_creation_feedback',        1, True),
 131     Extension('VK_EXT_post_depth_coverage',               1, 'device->rad_info.chip_class >= GFX10'),
 132     Extension('VK_EXT_queue_family_foreign',              1, True),
 133     Extension('VK_EXT_sample_locations',                  1, True),
 134     Extension('VK_EXT_sampler_filter_minmax',             1, 'device->rad_info.chip_class >= GFX7'),
 135     Extension('VK_EXT_scalar_block_layout',               1, 'device->rad_info.chip_class >= GFX7'),
 136     Extension('VK_EXT_shader_demote_to_helper_invocation',1, 'device->use_aco'),
 137     Extension('VK_EXT_shader_viewport_index_layer',       1, True),
 138     Extension('VK_EXT_shader_stencil_export',             1, True),
 139     Extension('VK_EXT_shader_subgroup_ballot',            1, True),
 140     Extension('VK_EXT_shader_subgroup_vote',              1, True),
 141     Extension('VK_EXT_texel_buffer_alignment',            1, True),
 142     Extension('VK_EXT_transform_feedback',                1, True),
 143     Extension('VK_EXT_vertex_attribute_divisor',          3, True),
 144     Extension('VK_EXT_ycbcr_image_arrays',                1, True),
 145     Extension('VK_AMD_buffer_marker',                     1, True),
 146     Extension('VK_AMD_draw_indirect_count',               1, True),
 147     Extension('VK_AMD_gcn_shader',                        1, True),
 148     Extension('VK_AMD_gpu_shader_half_float',             1, '!device->use_aco && device->rad_info.chip_class >= GFX9'),
 149     Extension('VK_AMD_gpu_shader_int16',                  1, '!device->use_aco && device->rad_info.chip_class >= GFX9'),
 150     Extension('VK_AMD_rasterization_order',               1, 'device->rad_info.has_out_of_order_rast'),
 151     Extension('VK_AMD_shader_ballot',                     1, 'device->use_shader_ballot'),
 152     Extension('VK_AMD_shader_core_properties',            1, True),
 153     Extension('VK_AMD_shader_core_properties2',           1, True),
 154     Extension('VK_AMD_shader_info',                       1, True),
 155     Extension('VK_AMD_shader_trinary_minmax',             1, True),
 156     Extension('VK_GOOGLE_decorate_string',                1, True),
 157     Extension('VK_GOOGLE_hlsl_functionality1',            1, True),
 158     Extension('VK_NV_compute_shader_derivatives',         1, 'device->rad_info.chip_class >= GFX8'),
 159 ]
 160
 161 class VkVersion:
 162     def __init__(self, string):
 163         split = string.split('.')
 164         self.major = int(split[0])
 165         self.minor = int(split[1])
 166         if len(split) > 2:
 167             assert len(split) == 3
 168             self.patch = int(split[2])
 169         else:
 170             self.patch = None
 171
 172         # Sanity check.  The range bits are required by the definition of the
 173         # VK_MAKE_VERSION macro
 174         assert self.major < 1024 and self.minor < 1024
 175         assert self.patch is None or self.patch < 4096
 176         assert(str(self) == string)
 177
 178     def __str__(self):
 179         ver_list = [str(self.major), str(self.minor)]
 180         if self.patch is not None:
 181             ver_list.append(str(self.patch))
 182         return '.'.join(ver_list)
 183
 184     def c_vk_version(self):
 185         patch = self.patch if self.patch is not None else 0
 186         ver_list = [str(self.major), str(self.minor), str(patch)]
 187         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
 188
 189     def __int_ver(self):
 190         # This is just an expansion of VK_VERSION
 191         patch = self.patch if self.patch is not None else 0
 192         return (self.major << 22) | (self.minor << 12) | patch
 193
 194     def __gt__(self, other):
 195         # If only one of them has a patch version, "ignore" it by making
 196         # other's patch version match self.
 197         if (self.patch is None) != (other.patch is None):
 198             other = copy.copy(other)
 199             other.patch = self.patch
 200
 201         return self.__int_ver() > other.__int_ver()
 202
 203
 204 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
 205
 206 def _init_exts_from_xml(xml):
 207     """ Walk the Vulkan XML and fill out extra extension information. """
 208
 209     xml = et.parse(xml)
 210
 211     ext_name_map = {}
 212     for ext in EXTENSIONS:
 213         ext_name_map[ext.name] = ext
 214
 215     for ext_elem in xml.findall('.extensions/extension'):
 216         ext_name = ext_elem.attrib['name']
 217         if ext_name not in ext_name_map:
 218             continue
 219
 220         ext = ext_name_map[ext_name]
 221         ext.type = ext_elem.attrib['type']
 222         ext.promotedto = ext_elem.attrib.get('promotedto', None)
 223         try:
 224             ext.requires = ext_elem.attrib['requires'].split(',')
 225         except KeyError:
 226             ext.requires = []
 227
 228     def extra_deps(ext):
 229         if ext.type == 'instance':
 230             check = 'instance->enabled_extensions.{}'.format(ext.name[3:])
 231             if ext.promotedto is not None:
 232                 # the xml contains values like VK_VERSION_1_1, but we need to
 233                 # translate them to VK_API_VERSION_1_1 for the apiVersion check
 234                 api_ver = ext.promotedto.replace('VK_VER', 'VK_API_VER')
 235                 check = '({} || instance->apiVersion >= {})'.format(check, api_ver)
 236             return set([check])
 237
 238         deps = set()
 239         for dep in ext.requires:
 240             deps |= extra_deps(ext_name_map[dep])
 241
 242         return deps
 243
 244     for ext in EXTENSIONS:
 245         if ext.type == 'device':
 246             for dep in extra_deps(ext):
 247                 ext.enable += ' && ' + dep
 248
 249 _TEMPLATE_H = Template(COPYRIGHT + """
 250 #ifndef RADV_EXTENSIONS_H
 251 #define RADV_EXTENSIONS_H
 252
 253 enum {
 254    RADV_INSTANCE_EXTENSION_COUNT = ${len(instance_extensions)},
 255    RADV_DEVICE_EXTENSION_COUNT = ${len(device_extensions)},
 256 };
 257
 258 struct radv_instance_extension_table {
 259    union {
 260       bool extensions[RADV_INSTANCE_EXTENSION_COUNT];
 261       struct {
 262 %for ext in instance_extensions:
 263         bool ${ext.name[3:]};
 264 %endfor
 265       };
 266    };
 267 };
 268
 269 struct radv_device_extension_table {
 270    union {
 271       bool extensions[RADV_DEVICE_EXTENSION_COUNT];
 272       struct {
 273 %for ext in device_extensions:
 274         bool ${ext.name[3:]};
 275 %endfor
 276       };
 277    };
 278 };
 279
 280 extern const VkExtensionProperties radv_instance_extensions[RADV_INSTANCE_EXTENSION_COUNT];
 281 extern const VkExtensionProperties radv_device_extensions[RADV_DEVICE_EXTENSION_COUNT];
 282 extern const struct radv_instance_extension_table radv_supported_instance_extensions;
 283
 284
 285 struct radv_physical_device;
 286
 287 void radv_fill_device_extension_table(const struct radv_physical_device *device,
 288                                       struct radv_device_extension_table* table);
 289 #endif
 290 """)
 291
 292 _TEMPLATE_C = Template(COPYRIGHT + """
 293 #include "radv_private.h"
 294
 295 #include "vk_util.h"
 296
 297 /* Convert the VK_USE_PLATFORM_* defines to booleans */
 298 %for platform in ['ANDROID_KHR', 'WAYLAND_KHR', 'XCB_KHR', 'XLIB_KHR', 'DISPLAY_KHR', 'XLIB_XRANDR_EXT']:
 299 #ifdef VK_USE_PLATFORM_${platform}
 300 #   undef VK_USE_PLATFORM_${platform}
 301 #   define VK_USE_PLATFORM_${platform} true
 302 #else
 303 #   define VK_USE_PLATFORM_${platform} false
 304 #endif
 305 %endfor
 306
 307 /* And ANDROID too */
 308 #ifdef ANDROID
 309 #   undef ANDROID
 310 #   define ANDROID true
 311 #else
 312 #   define ANDROID false
 313 #endif
 314
 315 #define RADV_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
 316                          VK_USE_PLATFORM_XCB_KHR || \\
 317                          VK_USE_PLATFORM_XLIB_KHR || \\
 318                          VK_USE_PLATFORM_DISPLAY_KHR)
 319
 320
 321 const VkExtensionProperties radv_instance_extensions[RADV_INSTANCE_EXTENSION_COUNT] = {
 322 %for ext in instance_extensions:
 323    {"${ext.name}", ${ext.ext_version}},
 324 %endfor
 325 };
 326
 327 const VkExtensionProperties radv_device_extensions[RADV_DEVICE_EXTENSION_COUNT] = {
 328 %for ext in device_extensions:
 329    {"${ext.name}", ${ext.ext_version}},
 330 %endfor
 331 };
 332
 333 const struct radv_instance_extension_table radv_supported_instance_extensions = {
 334 %for ext in instance_extensions:
 335    .${ext.name[3:]} = ${ext.enable},
 336 %endfor
 337 };
 338
 339 void radv_fill_device_extension_table(const struct radv_physical_device *device,
 340                                       struct radv_device_extension_table* table)
 341 {
 342    const struct radv_instance *instance = device->instance;
 343 %for ext in device_extensions:
 344    table->${ext.name[3:]} = ${ext.enable};
 345 %endfor
 346 }
 347
 348 VkResult radv_EnumerateInstanceVersion(
 349     uint32_t*                                   pApiVersion)
 350 {
 351     *pApiVersion = ${MAX_API_VERSION.c_vk_version()};
 352     return VK_SUCCESS;
 353 }
 354
 355 uint32_t
 356 radv_physical_device_api_version(struct radv_physical_device *dev)
 357 {
 358     uint32_t override = vk_get_version_override();
 359     uint32_t version = VK_MAKE_VERSION(1, 0, 68);
 360     if (dev->rad_info.has_syncobj_wait_for_submit)
 361         version = ${MAX_API_VERSION.c_vk_version()};
 362
 363     return override ? MIN2(override, version) : version;
 364 }
 365 """)
 366
 367 if __name__ == '__main__':
 368     parser = argparse.ArgumentParser()
 369     parser.add_argument('--out-c', help='Output C file.', required=True)
 370     parser.add_argument('--out-h', help='Output H file.', required=True)
 371     parser.add_argument('--xml',
 372                         help='Vulkan API XML file.',
 373                         required=True,
 374                         action='append',
 375                         dest='xml_files')
 376     args = parser.parse_args()
 377
 378     for filename in args.xml_files:
 379         _init_exts_from_xml(filename)
 380
 381     for ext in EXTENSIONS:
 382         assert ext.type == 'instance' or ext.type == 'device'
 383
 384     template_env = {
 385         'MAX_API_VERSION': MAX_API_VERSION,
 386         'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
 387         'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
 388     }
 389
 390     with open(args.out_c, 'w') as f:
 391         f.write(_TEMPLATE_C.render(**template_env))
 392     with open(args.out_h, 'w') as f:
 393         f.write(_TEMPLATE_H.render(**template_env))