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