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