src/freedreno/vulkan/tu_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.1.82'
  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_KHR_bind_memory2',                      1, True),
  54     Extension('VK_KHR_create_renderpass2',                1, True),
  55     Extension('VK_KHR_dedicated_allocation',              1, True),
  56     Extension('VK_KHR_get_display_properties2',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  57     Extension('VK_KHR_get_memory_requirements2',          1, True),
  58     Extension('VK_KHR_get_physical_device_properties2',   1, True),
  59     Extension('VK_KHR_get_surface_capabilities2',         1, 'TU_HAS_SURFACE'),
  60     Extension('VK_KHR_maintenance1',                      1, True),
  61     Extension('VK_KHR_maintenance2',                      1, True),
  62     Extension('VK_KHR_maintenance3',                      1, True),
  63     Extension('VK_KHR_surface',                          25, 'TU_HAS_SURFACE'),
  64     Extension('VK_KHR_swapchain',                        68, 'TU_HAS_SURFACE'),
  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_KHR_display',                          23, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  69     Extension('VK_EXT_direct_mode_display',               1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  70     Extension('VK_EXT_acquire_xlib_display',              1, 'VK_USE_PLATFORM_XLIB_XRANDR_EXT'),
  71     Extension('VK_EXT_display_surface_counter',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  72     Extension('VK_EXT_display_control',                   1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
  73     Extension('VK_EXT_debug_report',                      9, True),
  74     Extension('VK_KHR_external_memory_capabilities',      1, True),
  75     Extension('VK_KHR_external_memory',                   1, True),
  76 ]
  77
  78 class VkVersion:
  79     def __init__(self, string):
  80         split = string.split('.')
  81         self.major = int(split[0])
  82         self.minor = int(split[1])
  83         if len(split) > 2:
  84             assert len(split) == 3
  85             self.patch = int(split[2])
  86         else:
  87             self.patch = None
  88
  89         # Sanity check.  The range bits are required by the definition of the
  90         # VK_MAKE_VERSION macro
  91         assert self.major < 1024 and self.minor < 1024
  92         assert self.patch is None or self.patch < 4096
  93         assert(str(self) == string)
  94
  95     def __str__(self):
  96         ver_list = [str(self.major), str(self.minor)]
  97         if self.patch is not None:
  98             ver_list.append(str(self.patch))
  99         return '.'.join(ver_list)
 100
 101     def c_vk_version(self):
 102         patch = self.patch if self.patch is not None else 0
 103         ver_list = [str(self.major), str(self.minor), str(patch)]
 104         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
 105
 106     def __int_ver(self):
 107         # This is just an expansion of VK_VERSION
 108         patch = self.patch if self.patch is not None else 0
 109         return (self.major << 22) | (self.minor << 12) | patch
 110
 111     def __gt__(self, other):
 112         # If only one of them has a patch version, "ignore" it by making
 113         # other's patch version match self.
 114         if (self.patch is None) != (other.patch is None):
 115             other = copy.copy(other)
 116             other.patch = self.patch
 117
 118         return self.__int_ver() > other.__int_ver()
 119
 120 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
 121
 122 def _init_exts_from_xml(xml):
 123     """ Walk the Vulkan XML and fill out extra extension information. """
 124
 125     xml = et.parse(xml)
 126
 127     ext_name_map = {}
 128     for ext in EXTENSIONS:
 129         ext_name_map[ext.name] = ext
 130
 131     for ext_elem in xml.findall('.extensions/extension'):
 132         ext_name = ext_elem.attrib['name']
 133         if ext_name not in ext_name_map:
 134             continue
 135
 136         ext = ext_name_map[ext_name]
 137         ext.type = ext_elem.attrib['type']
 138
 139 _TEMPLATE_H = Template(COPYRIGHT + """
 140 #ifndef TU_EXTENSIONS_H
 141 #define TU_EXTENSIONS_H
 142
 143 enum {
 144    TU_INSTANCE_EXTENSION_COUNT = ${len(instance_extensions)},
 145    TU_DEVICE_EXTENSION_COUNT = ${len(device_extensions)},
 146 };
 147
 148 struct tu_instance_extension_table {
 149    union {
 150       bool extensions[TU_INSTANCE_EXTENSION_COUNT];
 151       struct {
 152 %for ext in instance_extensions:
 153         bool ${ext.name[3:]};
 154 %endfor
 155       };
 156    };
 157 };
 158
 159 struct tu_device_extension_table {
 160    union {
 161       bool extensions[TU_DEVICE_EXTENSION_COUNT];
 162       struct {
 163 %for ext in device_extensions:
 164         bool ${ext.name[3:]};
 165 %endfor
 166       };
 167    };
 168 };
 169
 170 extern const VkExtensionProperties tu_instance_extensions[TU_INSTANCE_EXTENSION_COUNT];
 171 extern const VkExtensionProperties tu_device_extensions[TU_DEVICE_EXTENSION_COUNT];
 172 extern const struct tu_instance_extension_table tu_supported_instance_extensions;
 173
 174
 175 struct tu_physical_device;
 176
 177 void tu_fill_device_extension_table(const struct tu_physical_device *device,
 178                                       struct tu_device_extension_table* table);
 179 #endif
 180 """)
 181
 182 _TEMPLATE_C = Template(COPYRIGHT + """
 183 #include "tu_private.h"
 184
 185 #include "vk_util.h"
 186
 187 /* Convert the VK_USE_PLATFORM_* defines to booleans */
 188 %for platform in ['ANDROID_KHR', 'WAYLAND_KHR', 'XCB_KHR', 'XLIB_KHR', 'DISPLAY_KHR', 'XLIB_XRANDR_EXT']:
 189 #ifdef VK_USE_PLATFORM_${platform}
 190 #   undef VK_USE_PLATFORM_${platform}
 191 #   define VK_USE_PLATFORM_${platform} true
 192 #else
 193 #   define VK_USE_PLATFORM_${platform} false
 194 #endif
 195 %endfor
 196
 197 /* And ANDROID too */
 198 #ifdef ANDROID
 199 #   undef ANDROID
 200 #   define ANDROID true
 201 #else
 202 #   define ANDROID false
 203 #endif
 204
 205 #define TU_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
 206                          VK_USE_PLATFORM_XCB_KHR || \\
 207                          VK_USE_PLATFORM_XLIB_KHR || \\
 208                          VK_USE_PLATFORM_DISPLAY_KHR)
 209
 210
 211 const VkExtensionProperties tu_instance_extensions[TU_INSTANCE_EXTENSION_COUNT] = {
 212 %for ext in instance_extensions:
 213    {"${ext.name}", ${ext.ext_version}},
 214 %endfor
 215 };
 216
 217 const VkExtensionProperties tu_device_extensions[TU_DEVICE_EXTENSION_COUNT] = {
 218 %for ext in device_extensions:
 219    {"${ext.name}", ${ext.ext_version}},
 220 %endfor
 221 };
 222
 223 const struct tu_instance_extension_table tu_supported_instance_extensions = {
 224 %for ext in instance_extensions:
 225    .${ext.name[3:]} = ${ext.enable},
 226 %endfor
 227 };
 228
 229 void tu_fill_device_extension_table(const struct tu_physical_device *device,
 230                                       struct tu_device_extension_table* table)
 231 {
 232 %for ext in device_extensions:
 233    table->${ext.name[3:]} = ${ext.enable};
 234 %endfor
 235 }
 236
 237 VkResult tu_EnumerateInstanceVersion(
 238     uint32_t*                                   pApiVersion)
 239 {
 240     *pApiVersion = ${MAX_API_VERSION.c_vk_version()};
 241     return VK_SUCCESS;
 242 }
 243
 244 uint32_t
 245 tu_physical_device_api_version(struct tu_physical_device *dev)
 246 {
 247     return VK_MAKE_VERSION(1, 1, 82);
 248 }
 249 """)
 250
 251 if __name__ == '__main__':
 252     parser = argparse.ArgumentParser()
 253     parser.add_argument('--out-c', help='Output C file.', required=True)
 254     parser.add_argument('--out-h', help='Output H file.', required=True)
 255     parser.add_argument('--xml',
 256                         help='Vulkan API XML file.',
 257                         required=True,
 258                         action='append',
 259                         dest='xml_files')
 260     args = parser.parse_args()
 261
 262     for filename in args.xml_files:
 263         _init_exts_from_xml(filename)
 264
 265     for ext in EXTENSIONS:
 266         assert ext.type == 'instance' or ext.type == 'device'
 267
 268     template_env = {
 269         'MAX_API_VERSION': MAX_API_VERSION,
 270         'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
 271         'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
 272     }
 273
 274     with open(args.out_c, 'w') as f:
 275         f.write(_TEMPLATE_C.render(**template_env))
 276     with open(args.out_h, 'w') as f:
 277         f.write(_TEMPLATE_H.render(**template_env))