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