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_EXT_global_priority',                   1, 'device->rad_info.has_ctx_priority'),
  82     Extension('VK_AMD_draw_indirect_count',               1, True),
  83     Extension('VK_AMD_rasterization_order',               1, 'device->rad_info.chip_class >= VI && device->rad_info.max_se >= 2'),
  84     Extension('VK_AMD_shader_info',                       1, True),
  85 ]
  86
  87 class VkVersion:
  88     def __init__(self, string):
  89         split = string.split('.')
  90         self.major = int(split[0])
  91         self.minor = int(split[1])
  92         if len(split) > 2:
  93             assert len(split) == 3
  94             self.patch = int(split[2])
  95         else:
  96             self.patch = None
  97
  98         # Sanity check.  The range bits are required by the definition of the
  99         # VK_MAKE_VERSION macro
 100         assert self.major < 1024 and self.minor < 1024
 101         assert self.patch is None or self.patch < 4096
 102         assert(str(self) == string)
 103
 104     def __str__(self):
 105         ver_list = [str(self.major), str(self.minor)]
 106         if self.patch is not None:
 107             ver_list.append(str(self.patch))
 108         return '.'.join(ver_list)
 109
 110     def c_vk_version(self):
 111         ver_list = [str(self.major), str(self.minor), str(self.patch)]
 112         return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
 113
 114     def __int_ver(self):
 115         # This is just an expansion of VK_VERSION
 116         patch = self.patch if self.patch is not None else 0
 117         return (self.major << 22) | (self.minor << 12) | patch
 118
 119     def __cmp__(self, other):
 120         # If only one of them has a patch version, "ignore" it by making
 121         # other's patch version match self.
 122         if (self.patch is None) != (other.patch is None):
 123             other = copy.copy(other)
 124             other.patch = self.patch
 125
 126         return self.__int_ver().__cmp__(other.__int_ver())
 127
 128 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
 129
 130 def _init_exts_from_xml(xml):
 131     """ Walk the Vulkan XML and fill out extra extension information. """
 132
 133     xml = et.parse(xml)
 134
 135     ext_name_map = {}
 136     for ext in EXTENSIONS:
 137         ext_name_map[ext.name] = ext
 138
 139     for ext_elem in xml.findall('.extensions/extension'):
 140         ext_name = ext_elem.attrib['name']
 141         if ext_name not in ext_name_map:
 142             continue
 143
 144         # Workaround for VK_ANDROID_native_buffer. Its <extension> element in
 145         # vk.xml lists it as supported="disabled" and provides only a stub
 146         # definition.  Its <extension> element in Mesa's custom
 147         # vk_android_native_buffer.xml, though, lists it as
 148         # supported='android-vendor' and fully defines the extension. We want
 149         # to skip the <extension> element in vk.xml.
 150         if ext_elem.attrib['supported'] == 'disabled':
 151             assert ext_name == 'VK_ANDROID_native_buffer'
 152             continue
 153
 154         ext = ext_name_map[ext_name]
 155         ext.type = ext_elem.attrib['type']
 156
 157 _TEMPLATE = Template(COPYRIGHT + """
 158 #include "radv_private.h"
 159
 160 #include "vk_util.h"
 161
 162 /* Convert the VK_USE_PLATFORM_* defines to booleans */
 163 %for platform in ['ANDROID', 'WAYLAND', 'XCB', 'XLIB']:
 164 #ifdef VK_USE_PLATFORM_${platform}_KHR
 165 #   undef VK_USE_PLATFORM_${platform}_KHR
 166 #   define VK_USE_PLATFORM_${platform}_KHR true
 167 #else
 168 #   define VK_USE_PLATFORM_${platform}_KHR false
 169 #endif
 170 %endfor
 171
 172 /* And ANDROID too */
 173 #ifdef ANDROID
 174 #   undef ANDROID
 175 #   define ANDROID true
 176 #else
 177 #   define ANDROID false
 178 #endif
 179
 180 #define RADV_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
 181                          VK_USE_PLATFORM_XCB_KHR || \\
 182                          VK_USE_PLATFORM_XLIB_KHR)
 183
 184 bool
 185 radv_instance_extension_supported(const char *name)
 186 {
 187 %for ext in instance_extensions:
 188     if (strcmp(name, "${ext.name}") == 0)
 189         return ${ext.enable};
 190 %endfor
 191     return false;
 192 }
 193
 194 VkResult radv_EnumerateInstanceExtensionProperties(
 195     const char*                                 pLayerName,
 196     uint32_t*                                   pPropertyCount,
 197     VkExtensionProperties*                      pProperties)
 198 {
 199     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 200
 201 %for ext in instance_extensions:
 202     if (${ext.enable}) {
 203         vk_outarray_append(&out, prop) {
 204             *prop = (VkExtensionProperties) {
 205                 .extensionName = "${ext.name}",
 206                 .specVersion = ${ext.ext_version},
 207             };
 208         }
 209     }
 210 %endfor
 211
 212     return vk_outarray_status(&out);
 213 }
 214
 215 uint32_t
 216 radv_physical_device_api_version(struct radv_physical_device *dev)
 217 {
 218     return ${MAX_API_VERSION.c_vk_version()};
 219 }
 220
 221 bool
 222 radv_physical_device_extension_supported(struct radv_physical_device *device,
 223                                         const char *name)
 224 {
 225 %for ext in device_extensions:
 226     if (strcmp(name, "${ext.name}") == 0)
 227         return ${ext.enable};
 228 %endfor
 229     return false;
 230 }
 231
 232 VkResult radv_EnumerateDeviceExtensionProperties(
 233     VkPhysicalDevice                            physicalDevice,
 234     const char*                                 pLayerName,
 235     uint32_t*                                   pPropertyCount,
 236     VkExtensionProperties*                      pProperties)
 237 {
 238     RADV_FROM_HANDLE(radv_physical_device, device, physicalDevice);
 239     VK_OUTARRAY_MAKE(out, pProperties, pPropertyCount);
 240     (void)device;
 241
 242 %for ext in device_extensions:
 243     if (${ext.enable}) {
 244         vk_outarray_append(&out, prop) {
 245             *prop = (VkExtensionProperties) {
 246                 .extensionName = "${ext.name}",
 247                 .specVersion = ${ext.ext_version},
 248             };
 249         }
 250     }
 251 %endfor
 252
 253     return vk_outarray_status(&out);
 254 }
 255 """)
 256
 257 if __name__ == '__main__':
 258     parser = argparse.ArgumentParser()
 259     parser.add_argument('--out', help='Output C file.', required=True)
 260     parser.add_argument('--xml',
 261                         help='Vulkan API XML file.',
 262                         required=True,
 263                         action='append',
 264                         dest='xml_files')
 265     args = parser.parse_args()
 266
 267     for filename in args.xml_files:
 268         _init_exts_from_xml(filename)
 269
 270     for ext in EXTENSIONS:
 271         assert ext.type == 'instance' or ext.type == 'device'
 272
 273     template_env = {
 274         'MAX_API_VERSION': MAX_API_VERSION,
 275         'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
 276         'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
 277     }
 278
 279     with open(args.out, 'w') as f:
 280         f.write(_TEMPLATE.render(**template_env))