src/amd/vulkan/radv_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 # 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_dedicated_allocation',              1, True),
  55     Extension('VK_KHR_descriptor_update_template',        1, True),
  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, 'device->rad_info.has_syncobj'),
  60     Extension('VK_KHR_external_semaphore_capabilities',   1, True),
  61     Extension('VK_KHR_external_semaphore_fd',             1, 'device->rad_info.has_syncobj'),
  62     Extension('VK_KHR_get_memory_requirements2',          1, True),
  63     Extension('VK_KHR_get_physical_device_properties2',   1, True),
  64     Extension('VK_KHR_image_format_list',                 1, True),
  65     Extension('VK_KHR_incremental_present',               1, True),
  66     Extension('VK_KHR_maintenance1',                      1, True),
  67     Extension('VK_KHR_maintenance2',                      1, True),
  68     Extension('VK_KHR_push_descriptor',                   1, True),
  69     Extension('VK_KHR_relaxed_block_layout',              1, True),
  70     Extension('VK_KHR_sampler_mirror_clamp_to_edge',      1, True),
  71     Extension('VK_KHR_shader_draw_parameters',            1, True),
  72     Extension('VK_KHR_storage_buffer_storage_class',      1, True),
  73     Extension('VK_KHR_surface',                          25, 'RADV_HAS_SURFACE'),
  74     Extension('VK_KHR_swapchain',                        68, 'RADV_HAS_SURFACE'),
  75     Extension('VK_KHR_variable_pointers',                 1, True),
  76     Extension('VK_KHR_wayland_surface',                   6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
  77     Extension('VK_KHR_xcb_surface',                       6, 'VK_USE_PLATFORM_XCB_KHR'),
  78     Extension('VK_KHR_xlib_surface',                      6, 'VK_USE_PLATFORM_XLIB_KHR'),
  79     Extension('VK_KHX_multiview',                         1, True),
  80     Extension('VK_EXT_debug_report',                      8, True),
  81     Extension('VK_AMD_draw_indirect_count',               1, True),
  82     Extension('VK_AMD_rasterization_order',               1, 'device->rad_info.chip_class >= VI && device->rad_info.max_se >= 2'),
  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         ver_list = [str(self.major), str(self.minor), str(self.patch)]
 110         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
 111
 112     def __int_ver(self):
 113         # This is just an expansion of VK_VERSION
 114         patch = self.patch if self.patch is not None else 0
 115         return (self.major << 22) | (self.minor << 12) | patch
 116
 117     def __cmp__(self, other):
 118         # If only one of them has a patch version, "ignore" it by making
 119         # other's patch version match self.
 120         if (self.patch is None) != (other.patch is None):
 121             other = copy.copy(other)
 122             other.patch = self.patch
 123
 124         return self.__int_ver().__cmp__(other.__int_ver())
 125
 126 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
 127
 128 def _init_exts_from_xml(xml):
 129     """ Walk the Vulkan XML and fill out extra extension information. """
 130
 131     xml = et.parse(xml)
 132
 133     ext_name_map = {}
 134     for ext in EXTENSIONS:
 135         ext_name_map[ext.name] = ext
 136
 137     for ext_elem in xml.findall('.extensions/extension'):
 138         ext_name = ext_elem.attrib['name']
 139         if ext_name not in ext_name_map:
 140             continue
 141
 142         # Workaround for VK_ANDROID_native_buffer. Its <extension> element in
 143         # vk.xml lists it as supported="disabled" and provides only a stub
 144         # definition.  Its <extension> element in Mesa's custom
 145         # vk_android_native_buffer.xml, though, lists it as
 146         # supported='android-vendor' and fully defines the extension. We want
 147         # to skip the <extension> element in vk.xml.
 148         if ext_elem.attrib['supported'] == 'disabled':
 149             assert ext_name == 'VK_ANDROID_native_buffer'
 150             continue
 151
 152         ext = ext_name_map[ext_name]
 153         ext.type = ext_elem.attrib['type']
 154
 155 _TEMPLATE = Template(COPYRIGHT + """
 156 #include "radv_private.h"
 157
 158 #include "vk_util.h"
 159
 160 /* Convert the VK_USE_PLATFORM_* defines to booleans */
 161 %for platform in ['ANDROID', 'WAYLAND', 'XCB', 'XLIB']:
 162 #ifdef VK_USE_PLATFORM_${platform}_KHR
 163 #   undef VK_USE_PLATFORM_${platform}_KHR
 164 #   define VK_USE_PLATFORM_${platform}_KHR true
 165 #else
 166 #   define VK_USE_PLATFORM_${platform}_KHR false
 167 #endif
 168 %endfor
 169
 170 /* And ANDROID too */
 171 #ifdef ANDROID
 172 #   undef ANDROID
 173 #   define ANDROID true
 174 #else
 175 #   define ANDROID false
 176 #endif
 177
 178 #define RADV_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
 179                          VK_USE_PLATFORM_XCB_KHR || \\
 180                          VK_USE_PLATFORM_XLIB_KHR)
 181
 182 bool
 183 radv_instance_extension_supported(const char *name)
 184 {
 185 %for ext in instance_extensions:
 186     if (strcmp(name, "${ext.name}") == 0)
 187         return ${ext.enable};
 188 %endfor
 189     return false;
 190 }
 191
 192 VkResult radv_EnumerateInstanceExtensionProperties(
 193     const char*                                 pLayerName,
 194     uint32_t*                                   pPropertyCount,
 195     VkExtensionProperties*                      pProperties)
 196 {
 197     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 198
 199 %for ext in instance_extensions:
 200     if (${ext.enable}) {
 201         vk_outarray_append(&out, prop) {
 202             *prop = (VkExtensionProperties) {
 203                 .extensionName = "${ext.name}",
 204                 .specVersion = ${ext.ext_version},
 205             };
 206         }
 207     }
 208 %endfor
 209
 210     return vk_outarray_status(&out);
 211 }
 212
 213 uint32_t
 214 radv_physical_device_api_version(struct radv_physical_device *dev)
 215 {
 216     return ${MAX_API_VERSION.c_vk_version()};
 217 }
 218
 219 bool
 220 radv_physical_device_extension_supported(struct radv_physical_device *device,
 221                                         const char *name)
 222 {
 223 %for ext in device_extensions:
 224     if (strcmp(name, "${ext.name}") == 0)
 225         return ${ext.enable};
 226 %endfor
 227     return false;
 228 }
 229
 230 VkResult radv_EnumerateDeviceExtensionProperties(
 231     VkPhysicalDevice                            physicalDevice,
 232     const char*                                 pLayerName,
 233     uint32_t*                                   pPropertyCount,
 234     VkExtensionProperties*                      pProperties)
 235 {
 236     RADV_FROM_HANDLE(radv_physical_device, device, physicalDevice);
 237     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 238     (void)device;
 239
 240 %for ext in device_extensions:
 241     if (${ext.enable}) {
 242         vk_outarray_append(&out, prop) {
 243             *prop = (VkExtensionProperties) {
 244                 .extensionName = "${ext.name}",
 245                 .specVersion = ${ext.ext_version},
 246             };
 247         }
 248     }
 249 %endfor
 250
 251     return vk_outarray_status(&out);
 252 }
 253 """)
 254
 255 if __name__ == '__main__':
 256     parser = argparse.ArgumentParser()
 257     parser.add_argument('--out', help='Output C file.', required=True)
 258     parser.add_argument('--xml',
 259                         help='Vulkan API XML file.',
 260                         required=True,
 261                         action='append',
 262                         dest='xml_files')
 263     args = parser.parse_args()
 264
 265     for filename in args.xml_files:
 266         _init_exts_from_xml(filename)
 267
 268     for ext in EXTENSIONS:
 269         assert ext.type == 'instance' or ext.type == 'device'
 270
 271     template_env = {
 272         'MAX_API_VERSION': MAX_API_VERSION,
 273         'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
 274         'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
 275     }
 276
 277     with open(args.out, 'w') as f:
 278         f.write(_TEMPLATE.render(**template_env))