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.54'
  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 EXTENSIONS = [
  48     Extension('VK_KHR_dedicated_allocation',              1, True),
  49     Extension('VK_KHR_descriptor_update_template',        1, True),
  50     Extension('VK_KHR_external_memory',                   1, True),
  51     Extension('VK_KHR_external_memory_capabilities',      1, True),
  52     Extension('VK_KHR_external_memory_fd',                1, True),
  53     Extension('VK_KHR_get_memory_requirements2',          1, True),
  54     Extension('VK_KHR_get_physical_device_properties2',   1, True),
  55     Extension('VK_KHR_get_surface_capabilities2',         1, True),
  56     Extension('VK_KHR_incremental_present',               1, True),
  57     Extension('VK_KHR_maintenance1',                      1, True),
  58     Extension('VK_KHR_push_descriptor',                   1, True),
  59     Extension('VK_KHR_sampler_mirror_clamp_to_edge',      1, True),
  60     Extension('VK_KHR_shader_draw_parameters',            1, True),
  61     Extension('VK_KHR_storage_buffer_storage_class',      1, True),
  62     Extension('VK_KHR_surface',                          25, True),
  63     Extension('VK_KHR_swapchain',                        68, True),
  64     Extension('VK_KHR_variable_pointers',                 1, True),
  65     Extension('VK_KHR_wayland_surface',                   6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
  66     Extension('VK_KHR_xcb_surface',                       6, 'VK_USE_PLATFORM_XCB_KHR'),
  67     Extension('VK_KHR_xlib_surface',                      6, 'VK_USE_PLATFORM_XLIB_KHR'),
  68     Extension('VK_KHX_multiview',                         1, True),
  69 ]
  70
  71 class VkVersion:
  72     def __init__(self, string):
  73         split = string.split('.')
  74         self.major = int(split[0])
  75         self.minor = int(split[1])
  76         if len(split) > 2:
  77             assert len(split) == 3
  78             self.patch = int(split[2])
  79         else:
  80             self.patch = None
  81
  82         # Sanity check.  The range bits are required by the definition of the
  83         # VK_MAKE_VERSION macro
  84         assert self.major < 1024 and self.minor < 1024
  85         assert self.patch is None or self.patch < 4096
  86         assert(str(self) == string)
  87
  88     def __str__(self):
  89         ver_list = [str(self.major), str(self.minor)]
  90         if self.patch is not None:
  91             ver_list.append(str(self.patch))
  92         return '.'.join(ver_list)
  93
  94     def c_vk_version(self):
  95         ver_list = [str(self.major), str(self.minor), str(self.patch)]
  96         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
  97
  98     def __int_ver(self):
  99         # This is just an expansion of VK_VERSION
 100         patch = self.patch if self.patch is not None else 0
 101         return (self.major << 22) | (self.minor << 12) | patch
 102
 103     def __cmp__(self, other):
 104         # If only one of them has a patch version, "ignore" it by making
 105         # other's patch version match self.
 106         if (self.patch is None) != (other.patch is None):
 107             other = copy.copy(other)
 108             other.patch = self.patch
 109
 110         return self.__int_ver().__cmp__(other.__int_ver())
 111
 112 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
 113
 114 def _init_exts_from_xml(xml):
 115     """ Walk the Vulkan XML and fill out extra extension information. """
 116
 117     xml = et.parse(xml)
 118
 119     ext_name_map = {}
 120     for ext in EXTENSIONS:
 121         ext_name_map[ext.name] = ext
 122
 123     for ext_elem in xml.findall('.extensions/extension'):
 124         ext_name = ext_elem.attrib['name']
 125         if ext_name not in ext_name_map:
 126             continue
 127         ext = ext_name_map[ext_name]
 128
 129         ext.type = ext_elem.attrib['type']
 130
 131     for ext in EXTENSIONS:
 132         assert ext.type == 'instance' or ext.type == 'device'
 133
 134 _TEMPLATE = Template(COPYRIGHT + """
 135 #include "anv_private.h"
 136
 137 #include "vk_util.h"
 138
 139 /* Convert the VK_USE_PLATFORM_* defines to booleans */
 140 %for platform in ['ANDROID', 'WAYLAND', 'XCB', 'XLIB']:
 141 #ifdef VK_USE_PLATFORM_${platform}_KHR
 142 #   undef VK_USE_PLATFORM_${platform}_KHR
 143 #   define VK_USE_PLATFORM_${platform}_KHR true
 144 #else
 145 #   define VK_USE_PLATFORM_${platform}_KHR false
 146 #endif
 147 %endfor
 148
 149 bool
 150 anv_instance_extension_supported(const char *name)
 151 {
 152 %for ext in instance_extensions:
 153     if (strcmp(name, "${ext.name}") == 0)
 154         return ${ext.enable};
 155 %endfor
 156     return false;
 157 }
 158
 159 VkResult anv_EnumerateInstanceExtensionProperties(
 160     const char*                                 pLayerName,
 161     uint32_t*                                   pPropertyCount,
 162     VkExtensionProperties*                      pProperties)
 163 {
 164     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 165
 166 %for ext in instance_extensions:
 167     if (${ext.enable}) {
 168         vk_outarray_append(&out, prop) {
 169             *prop = (VkExtensionProperties) {
 170                 .extensionName = "${ext.name}",
 171                 .specVersion = ${ext.ext_version},
 172             };
 173         }
 174     }
 175 %endfor
 176
 177     return vk_outarray_status(&out);
 178 }
 179
 180 uint32_t
 181 anv_physical_device_api_version(struct anv_physical_device *dev)
 182 {
 183     return ${MAX_API_VERSION.c_vk_version()};
 184 }
 185
 186 bool
 187 anv_physical_device_extension_supported(struct anv_physical_device *device,
 188                                         const char *name)
 189 {
 190 %for ext in device_extensions:
 191     if (strcmp(name, "${ext.name}") == 0)
 192         return ${ext.enable};
 193 %endfor
 194     return false;
 195 }
 196
 197 VkResult anv_EnumerateDeviceExtensionProperties(
 198     VkPhysicalDevice                            physicalDevice,
 199     const char*                                 pLayerName,
 200     uint32_t*                                   pPropertyCount,
 201     VkExtensionProperties*                      pProperties)
 202 {
 203     ANV_FROM_HANDLE(anv_physical_device, device, physicalDevice);
 204     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 205     (void)device;
 206
 207 %for ext in device_extensions:
 208     if (${ext.enable}) {
 209         vk_outarray_append(&out, prop) {
 210             *prop = (VkExtensionProperties) {
 211                 .extensionName = "${ext.name}",
 212                 .specVersion = ${ext.ext_version},
 213             };
 214         }
 215     }
 216 %endfor
 217
 218     return vk_outarray_status(&out);
 219 }
 220 """)
 221
 222 if __name__ == '__main__':
 223     parser = argparse.ArgumentParser()
 224     parser.add_argument('--out', help='Output C file.', required=True)
 225     parser.add_argument('--xml', help='Vulkan API XML file.', required=True)
 226     args = parser.parse_args()
 227
 228     _init_exts_from_xml(args.xml)
 229
 230     template_env = {
 231         'MAX_API_VERSION': MAX_API_VERSION,
 232         'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
 233         'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
 234     }
 235
 236     with open(args.out, 'w') as f:
 237         f.write(_TEMPLATE.render(**template_env))