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