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