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