b2878333d669ed2925e4b941298b3e0ec30f4b26
[mesa.git] / 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.2.128'
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_ANDROID_external_memory_android_hardware_buffer', 3, 'RADV_SUPPORT_ANDROID_HARDWARE_BUFFER && device->rad_info.has_syncobj_wait_for_submit'),
54 Extension('VK_ANDROID_native_buffer', 5, 'ANDROID && device->rad_info.has_syncobj_wait_for_submit'),
55 Extension('VK_KHR_16bit_storage', 1, '!device->use_aco'),
56 Extension('VK_KHR_bind_memory2', 1, True),
57 Extension('VK_KHR_buffer_device_address', 1, True),
58 Extension('VK_KHR_create_renderpass2', 1, True),
59 Extension('VK_KHR_dedicated_allocation', 1, True),
60 Extension('VK_KHR_depth_stencil_resolve', 1, True),
61 Extension('VK_KHR_descriptor_update_template', 1, True),
62 Extension('VK_KHR_device_group', 1, True),
63 Extension('VK_KHR_device_group_creation', 1, True),
64 Extension('VK_KHR_draw_indirect_count', 1, True),
65 Extension('VK_KHR_driver_properties', 1, True),
66 Extension('VK_KHR_external_fence', 1, 'device->rad_info.has_syncobj_wait_for_submit'),
67 Extension('VK_KHR_external_fence_capabilities', 1, True),
68 Extension('VK_KHR_external_fence_fd', 1, 'device->rad_info.has_syncobj_wait_for_submit'),
69 Extension('VK_KHR_external_memory', 1, True),
70 Extension('VK_KHR_external_memory_capabilities', 1, True),
71 Extension('VK_KHR_external_memory_fd', 1, True),
72 Extension('VK_KHR_external_semaphore', 1, 'device->rad_info.has_syncobj'),
73 Extension('VK_KHR_external_semaphore_capabilities', 1, True),
74 Extension('VK_KHR_external_semaphore_fd', 1, 'device->rad_info.has_syncobj'),
75 Extension('VK_KHR_get_display_properties2', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
76 Extension('VK_KHR_get_memory_requirements2', 1, True),
77 Extension('VK_KHR_get_physical_device_properties2', 1, True),
78 Extension('VK_KHR_get_surface_capabilities2', 1, 'RADV_HAS_SURFACE'),
79 Extension('VK_KHR_image_format_list', 1, True),
80 Extension('VK_KHR_imageless_framebuffer', 1, True),
81 Extension('VK_KHR_incremental_present', 1, 'RADV_HAS_SURFACE'),
82 Extension('VK_KHR_maintenance1', 1, True),
83 Extension('VK_KHR_maintenance2', 1, True),
84 Extension('VK_KHR_maintenance3', 1, True),
85 Extension('VK_KHR_pipeline_executable_properties', 1, True),
86 Extension('VK_KHR_push_descriptor', 1, True),
87 Extension('VK_KHR_relaxed_block_layout', 1, True),
88 Extension('VK_KHR_sampler_mirror_clamp_to_edge', 1, True),
89 Extension('VK_KHR_sampler_ycbcr_conversion', 1, True),
90 Extension('VK_KHR_separate_depth_stencil_layouts', 1, True),
91 Extension('VK_KHR_shader_atomic_int64', 1, 'LLVM_VERSION_MAJOR >= 9'),
92 Extension('VK_KHR_shader_clock', 1, True),
93 Extension('VK_KHR_shader_draw_parameters', 1, True),
94 Extension('VK_KHR_shader_float_controls', 1, True),
95 Extension('VK_KHR_shader_float16_int8', 1, '!device->use_aco'),
96 Extension('VK_KHR_shader_non_semantic_info', 1, True),
97 Extension('VK_KHR_shader_subgroup_extended_types', 1, True),
98 Extension('VK_KHR_spirv_1_4', 1, True),
99 Extension('VK_KHR_storage_buffer_storage_class', 1, True),
100 Extension('VK_KHR_surface', 25, 'RADV_HAS_SURFACE'),
101 Extension('VK_KHR_surface_protected_capabilities', 1, 'RADV_HAS_SURFACE'),
102 Extension('VK_KHR_swapchain', 68, 'RADV_HAS_SURFACE'),
103 Extension('VK_KHR_swapchain_mutable_format', 1, 'RADV_HAS_SURFACE'),
104 Extension('VK_KHR_timeline_semaphore', 2, 'device->rad_info.has_syncobj_wait_for_submit'),
105 Extension('VK_KHR_uniform_buffer_standard_layout', 1, True),
106 Extension('VK_KHR_variable_pointers', 1, True),
107 Extension('VK_KHR_wayland_surface', 6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
108 Extension('VK_KHR_xcb_surface', 6, 'VK_USE_PLATFORM_XCB_KHR'),
109 Extension('VK_KHR_xlib_surface', 6, 'VK_USE_PLATFORM_XLIB_KHR'),
110 Extension('VK_KHR_multiview', 1, True),
111 Extension('VK_KHR_display', 23, 'VK_USE_PLATFORM_DISPLAY_KHR'),
112 Extension('VK_KHR_8bit_storage', 1, '!device->use_aco'),
113 Extension('VK_EXT_direct_mode_display', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
114 Extension('VK_EXT_acquire_xlib_display', 1, 'VK_USE_PLATFORM_XLIB_XRANDR_EXT'),
115 Extension('VK_EXT_buffer_device_address', 1, True),
116 Extension('VK_EXT_calibrated_timestamps', 1, True),
117 Extension('VK_EXT_conditional_rendering', 1, True),
118 Extension('VK_EXT_conservative_rasterization', 1, 'device->rad_info.chip_class >= GFX9'),
119 Extension('VK_EXT_display_surface_counter', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
120 Extension('VK_EXT_display_control', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
121 Extension('VK_EXT_debug_report', 9, True),
122 Extension('VK_EXT_depth_clip_enable', 1, True),
123 Extension('VK_EXT_depth_range_unrestricted', 1, True),
124 Extension('VK_EXT_descriptor_indexing', 2, True),
125 Extension('VK_EXT_discard_rectangles', 1, True),
126 Extension('VK_EXT_external_memory_dma_buf', 1, True),
127 Extension('VK_EXT_external_memory_host', 1, 'device->rad_info.has_userptr'),
128 Extension('VK_EXT_global_priority', 1, 'device->rad_info.has_ctx_priority'),
129 Extension('VK_EXT_host_query_reset', 1, True),
130 Extension('VK_EXT_index_type_uint8', 1, 'device->rad_info.chip_class >= GFX8'),
131 Extension('VK_EXT_inline_uniform_block', 1, True),
132 # Disable line rasterization on GFX9 until the CTS failures have been resolved.
133 Extension('VK_EXT_line_rasterization', 1, 'device->rad_info.chip_class != GFX9'),
134 Extension('VK_EXT_memory_budget', 1, True),
135 Extension('VK_EXT_memory_priority', 1, True),
136 Extension('VK_EXT_pci_bus_info', 2, True),
137 Extension('VK_EXT_pipeline_creation_feedback', 1, True),
138 Extension('VK_EXT_post_depth_coverage', 1, 'device->rad_info.chip_class >= GFX10'),
139 Extension('VK_EXT_queue_family_foreign', 1, True),
140 # Disable sample locations on GFX10 until the CTS failures have been resolved.
141 Extension('VK_EXT_sample_locations', 1, 'device->rad_info.chip_class < GFX10'),
142 Extension('VK_EXT_sampler_filter_minmax', 1, True),
143 Extension('VK_EXT_scalar_block_layout', 1, 'device->rad_info.chip_class >= GFX7'),
144 Extension('VK_EXT_shader_demote_to_helper_invocation',1, 'device->use_aco'),
145 Extension('VK_EXT_shader_viewport_index_layer', 1, True),
146 Extension('VK_EXT_shader_stencil_export', 1, True),
147 Extension('VK_EXT_shader_subgroup_ballot', 1, True),
148 Extension('VK_EXT_shader_subgroup_vote', 1, True),
149 Extension('VK_EXT_subgroup_size_control', 2, '!device->use_aco'),
150 Extension('VK_EXT_texel_buffer_alignment', 1, True),
151 Extension('VK_EXT_transform_feedback', 1, True),
152 Extension('VK_EXT_vertex_attribute_divisor', 3, True),
153 Extension('VK_EXT_ycbcr_image_arrays', 1, True),
154 Extension('VK_AMD_buffer_marker', 1, True),
155 Extension('VK_AMD_device_coherent_memory', 1, True),
156 Extension('VK_AMD_draw_indirect_count', 1, True),
157 Extension('VK_AMD_gcn_shader', 1, True),
158 Extension('VK_AMD_gpu_shader_half_float', 1, '!device->use_aco && device->rad_info.chip_class >= GFX9'),
159 Extension('VK_AMD_gpu_shader_int16', 1, '!device->use_aco && device->rad_info.chip_class >= GFX9'),
160 # Disable mixed attachment samples on GFX6-GFX7 until the CTS failures have been resolved.
161 Extension('VK_AMD_mixed_attachment_samples', 1, 'device->rad_info.chip_class >= GFX8'),
162 Extension('VK_AMD_rasterization_order', 1, 'device->rad_info.has_out_of_order_rast'),
163 Extension('VK_AMD_shader_ballot', 1, 'device->use_shader_ballot'),
164 Extension('VK_AMD_shader_core_properties', 1, True),
165 Extension('VK_AMD_shader_core_properties2', 1, True),
166 Extension('VK_AMD_shader_explicit_vertex_parameter', 1, True),
167 Extension('VK_AMD_shader_image_load_store_lod', 1, True),
168 Extension('VK_AMD_shader_fragment_mask', 1, True),
169 Extension('VK_AMD_shader_info', 1, True),
170 Extension('VK_AMD_shader_trinary_minmax', 1, True),
171 Extension('VK_GOOGLE_decorate_string', 1, True),
172 Extension('VK_GOOGLE_hlsl_functionality1', 1, True),
173 Extension('VK_NV_compute_shader_derivatives', 1, True),
174 ]
175
176 class VkVersion:
177 def __init__(self, string):
178 split = string.split('.')
179 self.major = int(split[0])
180 self.minor = int(split[1])
181 if len(split) > 2:
182 assert len(split) == 3
183 self.patch = int(split[2])
184 else:
185 self.patch = None
186
187 # Sanity check. The range bits are required by the definition of the
188 # VK_MAKE_VERSION macro
189 assert self.major < 1024 and self.minor < 1024
190 assert self.patch is None or self.patch < 4096
191 assert(str(self) == string)
192
193 def __str__(self):
194 ver_list = [str(self.major), str(self.minor)]
195 if self.patch is not None:
196 ver_list.append(str(self.patch))
197 return '.'.join(ver_list)
198
199 def c_vk_version(self):
200 patch = self.patch if self.patch is not None else 0
201 ver_list = [str(self.major), str(self.minor), str(patch)]
202 return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
203
204 def __int_ver(self):
205 # This is just an expansion of VK_VERSION
206 patch = self.patch if self.patch is not None else 0
207 return (self.major << 22) | (self.minor << 12) | patch
208
209 def __gt__(self, other):
210 # If only one of them has a patch version, "ignore" it by making
211 # other's patch version match self.
212 if (self.patch is None) != (other.patch is None):
213 other = copy.copy(other)
214 other.patch = self.patch
215
216 return self.__int_ver() > other.__int_ver()
217
218
219 MAX_API_VERSION = VkVersion(MAX_API_VERSION)
220
221 def _init_exts_from_xml(xml):
222 """ Walk the Vulkan XML and fill out extra extension information. """
223
224 xml = et.parse(xml)
225
226 ext_name_map = {}
227 for ext in EXTENSIONS:
228 ext_name_map[ext.name] = ext
229
230 for ext_elem in xml.findall('.extensions/extension'):
231 ext_name = ext_elem.attrib['name']
232 if ext_name not in ext_name_map:
233 continue
234
235 ext = ext_name_map[ext_name]
236 ext.type = ext_elem.attrib['type']
237 ext.promotedto = ext_elem.attrib.get('promotedto', None)
238 try:
239 ext.requires = ext_elem.attrib['requires'].split(',')
240 except KeyError:
241 ext.requires = []
242
243 def extra_deps(ext):
244 if ext.type == 'instance':
245 check = 'instance->enabled_extensions.{}'.format(ext.name[3:])
246 if ext.promotedto is not None:
247 # the xml contains values like VK_VERSION_1_1, but we need to
248 # translate them to VK_API_VERSION_1_1 for the apiVersion check
249 api_ver = ext.promotedto.replace('VK_VER', 'VK_API_VER')
250 check = '({} || instance->apiVersion >= {})'.format(check, api_ver)
251 return set([check])
252
253 deps = set()
254 for dep in ext.requires:
255 deps |= extra_deps(ext_name_map[dep])
256
257 return deps
258
259 for ext in EXTENSIONS:
260 if ext.type == 'device':
261 for dep in extra_deps(ext):
262 ext.enable += ' && ' + dep
263
264 # Mapping between extension name and the android version in which the extension
265 # was whitelisted in Android CTS.
266 allowed_android_version = {
267 # Allowed Instance KHR Extensions
268 "VK_KHR_surface": 26,
269 "VK_KHR_display": 26,
270 "VK_KHR_android_surface": 26,
271 "VK_KHR_mir_surface": 26,
272 "VK_KHR_wayland_surface": 26,
273 "VK_KHR_win32_surface": 26,
274 "VK_KHR_xcb_surface": 26,
275 "VK_KHR_xlib_surface": 26,
276 "VK_KHR_get_physical_device_properties2": 26,
277 "VK_KHR_get_surface_capabilities2": 26,
278 "VK_KHR_external_memory_capabilities": 28,
279 "VK_KHR_external_semaphore_capabilities": 28,
280 "VK_KHR_external_fence_capabilities": 28,
281 "VK_KHR_device_group_creation": 28,
282
283 # Allowed Device KHR Extensions
284 "VK_KHR_swapchain": 26,
285 "VK_KHR_display_swapchain": 26,
286 "VK_KHR_sampler_mirror_clamp_to_edge": 26,
287 "VK_KHR_shader_draw_parameters": 26,
288 "VK_KHR_maintenance1": 26,
289 "VK_KHR_push_descriptor": 26,
290 "VK_KHR_descriptor_update_template": 26,
291 "VK_KHR_incremental_present": 26,
292 "VK_KHR_shared_presentable_image": 26,
293 "VK_KHR_storage_buffer_storage_class": 28,
294 "VK_KHR_16bit_storage": 28,
295 "VK_KHR_get_memory_requirements2": 28,
296 "VK_KHR_external_memory": 28,
297 "VK_KHR_external_memory_fd": 28,
298 "VK_KHR_external_memory_win32": 28,
299 "VK_KHR_external_semaphore": 28,
300 "VK_KHR_external_semaphore_fd": 28,
301 "VK_KHR_external_semaphore_win32": 28,
302 "VK_KHR_external_fence": 28,
303 "VK_KHR_external_fence_fd": 28,
304 "VK_KHR_external_fence_win32": 28,
305 "VK_KHR_win32_keyed_mutex": 28,
306 "VK_KHR_dedicated_allocation": 28,
307 "VK_KHR_variable_pointers": 28,
308 "VK_KHR_relaxed_block_layout": 28,
309 "VK_KHR_bind_memory2": 28,
310 "VK_KHR_maintenance2": 28,
311 "VK_KHR_image_format_list": 28,
312 "VK_KHR_sampler_ycbcr_conversion": 28,
313 "VK_KHR_device_group": 28,
314 "VK_KHR_multiview": 28,
315 "VK_KHR_maintenance3": 28,
316
317 "VK_GOOGLE_display_timing": 26,
318 "VK_ANDROID_external_memory_android_hardware_buffer": 28,
319 }
320
321 # Extensions with these prefixes are checked in Android CTS, and thus must be
322 # whitelisted per the preceding dict.
323 android_extension_whitelist_prefixes = (
324 "VK_KHX",
325 "VK_KHR",
326 "VK_GOOGLE",
327 "VK_ANDROID"
328 )
329
330 def GetExtensionCondition(ext_name, condition):
331 """ If |ext_name| is an extension that Android CTS cares about, prepend
332 a condition to ensure that the extension is only enabled for Android
333 versions in which the extension is whitelisted in CTS. """
334 if not ext_name.startswith(android_extension_whitelist_prefixes):
335 return condition
336 allowed_version = allowed_android_version.get(ext_name, 9999)
337 return "(!ANDROID || ANDROID_API_LEVEL >= %d) && (%s)" % (allowed_version,
338 condition)
339
340 _TEMPLATE_H = Template(COPYRIGHT + """
341 #ifndef RADV_EXTENSIONS_H
342 #define RADV_EXTENSIONS_H
343
344 enum {
345 RADV_INSTANCE_EXTENSION_COUNT = ${len(instance_extensions)},
346 RADV_DEVICE_EXTENSION_COUNT = ${len(device_extensions)},
347 };
348
349 struct radv_instance_extension_table {
350 union {
351 bool extensions[RADV_INSTANCE_EXTENSION_COUNT];
352 struct {
353 %for ext in instance_extensions:
354 bool ${ext.name[3:]};
355 %endfor
356 };
357 };
358 };
359
360 struct radv_device_extension_table {
361 union {
362 bool extensions[RADV_DEVICE_EXTENSION_COUNT];
363 struct {
364 %for ext in device_extensions:
365 bool ${ext.name[3:]};
366 %endfor
367 };
368 };
369 };
370
371 extern const VkExtensionProperties radv_instance_extensions[RADV_INSTANCE_EXTENSION_COUNT];
372 extern const VkExtensionProperties radv_device_extensions[RADV_DEVICE_EXTENSION_COUNT];
373 extern const struct radv_instance_extension_table radv_supported_instance_extensions;
374
375
376 struct radv_physical_device;
377
378 void radv_fill_device_extension_table(const struct radv_physical_device *device,
379 struct radv_device_extension_table* table);
380 #endif
381 """)
382
383 _TEMPLATE_C = Template(COPYRIGHT + """
384 #include "radv_private.h"
385
386 #include "vk_util.h"
387
388 /* Convert the VK_USE_PLATFORM_* defines to booleans */
389 %for platform in ['ANDROID_KHR', 'WAYLAND_KHR', 'XCB_KHR', 'XLIB_KHR', 'DISPLAY_KHR', 'XLIB_XRANDR_EXT']:
390 #ifdef VK_USE_PLATFORM_${platform}
391 # undef VK_USE_PLATFORM_${platform}
392 # define VK_USE_PLATFORM_${platform} true
393 #else
394 # define VK_USE_PLATFORM_${platform} false
395 #endif
396 %endfor
397
398 /* And ANDROID too */
399 #ifdef ANDROID
400 # undef ANDROID
401 # define ANDROID true
402 #else
403 # define ANDROID false
404 # define ANDROID_API_LEVEL 0
405 #endif
406
407 #define RADV_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
408 VK_USE_PLATFORM_XCB_KHR || \\
409 VK_USE_PLATFORM_XLIB_KHR || \\
410 VK_USE_PLATFORM_DISPLAY_KHR)
411
412
413 const VkExtensionProperties radv_instance_extensions[RADV_INSTANCE_EXTENSION_COUNT] = {
414 %for ext in instance_extensions:
415 {"${ext.name}", ${ext.ext_version}},
416 %endfor
417 };
418
419 const VkExtensionProperties radv_device_extensions[RADV_DEVICE_EXTENSION_COUNT] = {
420 %for ext in device_extensions:
421 {"${ext.name}", ${ext.ext_version}},
422 %endfor
423 };
424
425 const struct radv_instance_extension_table radv_supported_instance_extensions = {
426 %for ext in instance_extensions:
427 .${ext.name[3:]} = ${GetExtensionCondition(ext.name, ext.enable)},
428 %endfor
429 };
430
431 void radv_fill_device_extension_table(const struct radv_physical_device *device,
432 struct radv_device_extension_table* table)
433 {
434 const struct radv_instance *instance = device->instance;
435 %for ext in device_extensions:
436 table->${ext.name[3:]} = ${GetExtensionCondition(ext.name, ext.enable)};
437 %endfor
438 }
439
440 VkResult radv_EnumerateInstanceVersion(
441 uint32_t* pApiVersion)
442 {
443 *pApiVersion = ${MAX_API_VERSION.c_vk_version()};
444 return VK_SUCCESS;
445 }
446
447 uint32_t
448 radv_physical_device_api_version(struct radv_physical_device *dev)
449 {
450 uint32_t override = vk_get_version_override();
451 uint32_t version = VK_MAKE_VERSION(1, 0, 68);
452 if (dev->rad_info.has_syncobj_wait_for_submit)
453 version = ${MAX_API_VERSION.c_vk_version()};
454
455 return override ? MIN2(override, version) : version;
456 }
457 """)
458
459 if __name__ == '__main__':
460 parser = argparse.ArgumentParser()
461 parser.add_argument('--out-c', help='Output C file.', required=True)
462 parser.add_argument('--out-h', help='Output H file.', required=True)
463 parser.add_argument('--xml',
464 help='Vulkan API XML file.',
465 required=True,
466 action='append',
467 dest='xml_files')
468 args = parser.parse_args()
469
470 for filename in args.xml_files:
471 _init_exts_from_xml(filename)
472
473 for ext in EXTENSIONS:
474 assert ext.type == 'instance' or ext.type == 'device'
475
476 template_env = {
477 'MAX_API_VERSION': MAX_API_VERSION,
478 'instance_extensions': [e for e in EXTENSIONS if e.type == 'instance'],
479 'device_extensions': [e for e in EXTENSIONS if e.type == 'device'],
480 'GetExtensionCondition': GetExtensionCondition,
481 }
482
483 with open(args.out_c, 'w') as f:
484 f.write(_TEMPLATE_C.render(**template_env))
485 with open(args.out_h, 'w') as f:
486 f.write(_TEMPLATE_H.render(**template_env))