src/intel/vulkan/anv_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'),
  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,
  58               'device->has_syncobj_wait'),
  59     Extension('VK_KHR_external_fence_capabilities',       1, True),
  60     Extension('VK_KHR_external_fence_fd',                 1,
  61               'device->has_syncobj_wait'),
  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, True),
  66     Extension('VK_KHR_external_semaphore_capabilities',   1, True),
  67     Extension('VK_KHR_external_semaphore_fd',             1, True),
  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, 'ANV_HAS_SURFACE'),
  71     Extension('VK_KHR_image_format_list',                 1, True),
  72     Extension('VK_KHR_incremental_present',               1, True),
  73     Extension('VK_KHR_maintenance1',                      1, True),
  74     Extension('VK_KHR_maintenance2',                      1, True),
  75     Extension('VK_KHR_push_descriptor',                   1, True),
  76     Extension('VK_KHR_relaxed_block_layout',              1, True),
  77     Extension('VK_KHR_sampler_mirror_clamp_to_edge',      1, True),
  78     Extension('VK_KHR_sampler_ycbcr_conversion',          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, 'ANV_HAS_SURFACE'),
  82     Extension('VK_KHR_swapchain',                        68, 'ANV_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_KHX_multiview',                         1, True),
  88     Extension('VK_EXT_debug_report',                      8, True),
  89     Extension('VK_EXT_external_memory_dma_buf',           1, True),
  90 ]
  91
  92 class VkVersion:
  93     def __init__(self, string):
  94         split = string.split('.')
  95         self.major = int(split[0])
  96         self.minor = int(split[1])
  97         if len(split) > 2:
  98             assert len(split) == 3
  99             self.patch = int(split[2])
 100         else:
 101             self.patch = None
 102
 103         # Sanity check.  The range bits are required by the definition of the
 104         # VK_MAKE_VERSION macro
 105         assert self.major < 1024 and self.minor < 1024
 106         assert self.patch is None or self.patch < 4096
 107         assert(str(self) == string)
 108
 109     def __str__(self):
 110         ver_list = [str(self.major), str(self.minor)]
 111         if self.patch is not None:
 112             ver_list.append(str(self.patch))
 113         return '.'.join(ver_list)
 114
 115     def c_vk_version(self):
 116         ver_list = [str(self.major), str(self.minor), str(self.patch)]
 117         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
 118
 119     def __int_ver(self):
 120         # This is just an expansion of VK_VERSION
 121         patch = self.patch if self.patch is not None else 0
 122         return (self.major << 22) | (self.minor << 12) | patch
 123
 124     def __cmp__(self, other):
 125         # If only one of them has a patch version, "ignore" it by making
 126         # other's patch version match self.
 127         if (self.patch is None) != (other.patch is None):
 128             other = copy.copy(other)
 129             other.patch = self.patch
 130
 131         return self.__int_ver().__cmp__(other.__int_ver())
 132
 133 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
 134
 135 def _init_exts_from_xml(xml):
 136     """ Walk the Vulkan XML and fill out extra extension information. """
 137
 138     xml = et.parse(xml)
 139
 140     ext_name_map = {}
 141     for ext in EXTENSIONS:
 142         ext_name_map[ext.name] = ext
 143
 144     for ext_elem in xml.findall('.extensions/extension'):
 145         ext_name = ext_elem.attrib['name']
 146         if ext_name not in ext_name_map:
 147             continue
 148
 149         # Workaround for VK_ANDROID_native_buffer. Its <extension> element in
 150         # vk.xml lists it as supported="disabled" and provides only a stub
 151         # definition.  Its <extension> element in Mesa's custom
 152         # vk_android_native_buffer.xml, though, lists it as
 153         # supported='android-vendor' and fully defines the extension. We want
 154         # to skip the <extension> element in vk.xml.
 155         if ext_elem.attrib['supported'] == 'disabled':
 156             assert ext_name == 'VK_ANDROID_native_buffer'
 157             continue
 158
 159         ext = ext_name_map[ext_name]
 160         ext.type = ext_elem.attrib['type']
 161
 162 _TEMPLATE = Template(COPYRIGHT + """
 163 #include "anv_private.h"
 164
 165 #include "vk_util.h"
 166
 167 /* Convert the VK_USE_PLATFORM_* defines to booleans */
 168 %for platform in ['ANDROID', 'WAYLAND', 'XCB', 'XLIB']:
 169 #ifdef VK_USE_PLATFORM_${platform}_KHR
 170 #   undef VK_USE_PLATFORM_${platform}_KHR
 171 #   define VK_USE_PLATFORM_${platform}_KHR true
 172 #else
 173 #   define VK_USE_PLATFORM_${platform}_KHR false
 174 #endif
 175 %endfor
 176
 177 /* And ANDROID too */
 178 #ifdef ANDROID
 179 #   undef ANDROID
 180 #   define ANDROID true
 181 #else
 182 #   define ANDROID false
 183 #endif
 184
 185 #define ANV_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
 186                          VK_USE_PLATFORM_XCB_KHR || \\
 187                          VK_USE_PLATFORM_XLIB_KHR)
 188
 189 bool
 190 anv_instance_extension_supported(const char *name)
 191 {
 192 %for ext in instance_extensions:
 193     if (strcmp(name, "${ext.name}") == 0)
 194         return ${ext.enable};
 195 %endfor
 196     return false;
 197 }
 198
 199 VkResult anv_EnumerateInstanceExtensionProperties(
 200     const char*                                 pLayerName,
 201     uint32_t*                                   pPropertyCount,
 202     VkExtensionProperties*                      pProperties)
 203 {
 204     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 205
 206 %for ext in instance_extensions:
 207     if (${ext.enable}) {
 208         vk_outarray_append(&out, prop) {
 209             *prop = (VkExtensionProperties) {
 210                 .extensionName = "${ext.name}",
 211                 .specVersion = ${ext.ext_version},
 212             };
 213         }
 214     }
 215 %endfor
 216
 217     return vk_outarray_status(&out);
 218 }
 219
 220 uint32_t
 221 anv_physical_device_api_version(struct anv_physical_device *dev)
 222 {
 223     return ${MAX_API_VERSION.c_vk_version()};
 224 }
 225
 226 bool
 227 anv_physical_device_extension_supported(struct anv_physical_device *device,
 228                                         const char *name)
 229 {
 230 %for ext in device_extensions:
 231     if (strcmp(name, "${ext.name}") == 0)
 232         return ${ext.enable};
 233 %endfor
 234     return false;
 235 }
 236
 237 VkResult anv_EnumerateDeviceExtensionProperties(
 238     VkPhysicalDevice                            physicalDevice,
 239     const char*                                 pLayerName,
 240     uint32_t*                                   pPropertyCount,
 241     VkExtensionProperties*                      pProperties)
 242 {
 243     ANV_FROM_HANDLE(anv_physical_device, device, physicalDevice);
 244     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 245     (void)device;
 246
 247 %for ext in device_extensions:
 248     if (${ext.enable}) {
 249         vk_outarray_append(&out, prop) {
 250             *prop = (VkExtensionProperties) {
 251                 .extensionName = "${ext.name}",
 252                 .specVersion = ${ext.ext_version},
 253             };
 254         }
 255     }
 256 %endfor
 257
 258     return vk_outarray_status(&out);
 259 }
 260 """)
 261
 262 if __name__ == '__main__':
 263     parser = argparse.ArgumentParser()
 264     parser.add_argument('--out', help='Output C file.', required=True)
 265     parser.add_argument('--xml',
 266                         help='Vulkan API XML file.',
 267                         required=True,
 268                         action='append',
 269                         dest='xml_files')
 270     args = parser.parse_args()
 271
 272     for filename in args.xml_files:
 273         _init_exts_from_xml(filename)
 274
 275     for ext in EXTENSIONS:
 276         assert ext.type == 'instance' or ext.type == 'device'
 277
 278     template_env = {
 279         'MAX_API_VERSION': MAX_API_VERSION,
 280         'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
 281         'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
 282     }
 283
 284     with open(args.out, 'w') as f:
 285         f.write(_TEMPLATE.render(**template_env))