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