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