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