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