3 * Copyright 2017 Intel Corporation
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:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
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.
30 import xml
.etree
.cElementTree
as et
32 from mako
.template
import Template
34 MAX_API_VERSION
= '1.1.90'
37 def __init__(self
, name
, ext_version
, enable
):
39 self
.ext_version
= int(ext_version
)
43 self
.enable
= 'false';
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.
53 Extension('VK_ANDROID_native_buffer', 5, 'ANDROID && device->rad_info.has_syncobj_wait_for_submit'),
54 Extension('VK_KHR_16bit_storage', 1, True),
55 Extension('VK_KHR_bind_memory2', 1, True),
56 Extension('VK_KHR_create_renderpass2', 1, True),
57 Extension('VK_KHR_dedicated_allocation', 1, True),
58 Extension('VK_KHR_descriptor_update_template', 1, True),
59 Extension('VK_KHR_device_group', 1, True),
60 Extension('VK_KHR_device_group_creation', 1, True),
61 Extension('VK_KHR_draw_indirect_count', 1, True),
62 Extension('VK_KHR_driver_properties', 1, True),
63 Extension('VK_KHR_external_fence', 1, 'device->rad_info.has_syncobj_wait_for_submit'),
64 Extension('VK_KHR_external_fence_capabilities', 1, True),
65 Extension('VK_KHR_external_fence_fd', 1, 'device->rad_info.has_syncobj_wait_for_submit'),
66 Extension('VK_KHR_external_memory', 1, True),
67 Extension('VK_KHR_external_memory_capabilities', 1, True),
68 Extension('VK_KHR_external_memory_fd', 1, True),
69 Extension('VK_KHR_external_semaphore', 1, 'device->rad_info.has_syncobj'),
70 Extension('VK_KHR_external_semaphore_capabilities', 1, True),
71 Extension('VK_KHR_external_semaphore_fd', 1, 'device->rad_info.has_syncobj'),
72 Extension('VK_KHR_get_display_properties2', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
73 Extension('VK_KHR_get_memory_requirements2', 1, True),
74 Extension('VK_KHR_get_physical_device_properties2', 1, True),
75 Extension('VK_KHR_get_surface_capabilities2', 1, 'RADV_HAS_SURFACE'),
76 Extension('VK_KHR_image_format_list', 1, True),
77 Extension('VK_KHR_incremental_present', 1, 'RADV_HAS_SURFACE'),
78 Extension('VK_KHR_maintenance1', 1, True),
79 Extension('VK_KHR_maintenance2', 1, True),
80 Extension('VK_KHR_maintenance3', 1, True),
81 Extension('VK_KHR_push_descriptor', 1, True),
82 Extension('VK_KHR_relaxed_block_layout', 1, True),
83 Extension('VK_KHR_sampler_mirror_clamp_to_edge', 1, True),
84 Extension('VK_KHR_shader_draw_parameters', 1, True),
85 Extension('VK_KHR_storage_buffer_storage_class', 1, True),
86 Extension('VK_KHR_surface', 25, 'RADV_HAS_SURFACE'),
87 Extension('VK_KHR_swapchain', 68, 'RADV_HAS_SURFACE'),
88 Extension('VK_KHR_variable_pointers', 1, True),
89 Extension('VK_KHR_wayland_surface', 6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
90 Extension('VK_KHR_xcb_surface', 6, 'VK_USE_PLATFORM_XCB_KHR'),
91 Extension('VK_KHR_xlib_surface', 6, 'VK_USE_PLATFORM_XLIB_KHR'),
92 Extension('VK_KHR_multiview', 1, True),
93 Extension('VK_KHR_display', 23, 'VK_USE_PLATFORM_DISPLAY_KHR'),
94 Extension('VK_EXT_direct_mode_display', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
95 Extension('VK_EXT_acquire_xlib_display', 1, 'VK_USE_PLATFORM_XLIB_XRANDR_EXT'),
96 Extension('VK_EXT_buffer_device_address', 1, True),
97 Extension('VK_EXT_calibrated_timestamps', 1, True),
98 Extension('VK_EXT_conditional_rendering', 1, True),
99 Extension('VK_EXT_conservative_rasterization', 1, 'device->rad_info.chip_class >= GFX9'),
100 Extension('VK_EXT_display_surface_counter', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
101 Extension('VK_EXT_display_control', 1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
102 Extension('VK_EXT_debug_report', 9, True),
103 Extension('VK_EXT_depth_clip_enable', 1, True),
104 Extension('VK_EXT_depth_range_unrestricted', 1, True),
105 Extension('VK_EXT_descriptor_indexing', 2, True),
106 Extension('VK_EXT_discard_rectangles', 1, True),
107 Extension('VK_EXT_external_memory_dma_buf', 1, True),
108 Extension('VK_EXT_external_memory_host', 1, 'device->rad_info.has_userptr'),
109 Extension('VK_EXT_global_priority', 1, 'device->rad_info.has_ctx_priority'),
110 Extension('VK_EXT_memory_budget', 1, True),
111 Extension('VK_EXT_memory_priority', 1, True),
112 Extension('VK_EXT_pci_bus_info', 2, True),
113 Extension('VK_EXT_sampler_filter_minmax', 1, 'device->rad_info.chip_class >= CIK'),
114 Extension('VK_EXT_scalar_block_layout', 1, 'device->rad_info.chip_class >= CIK'),
115 Extension('VK_EXT_shader_viewport_index_layer', 1, True),
116 Extension('VK_EXT_shader_stencil_export', 1, True),
117 Extension('VK_EXT_transform_feedback', 1, True),
118 Extension('VK_EXT_vertex_attribute_divisor', 3, True),
119 Extension('VK_AMD_draw_indirect_count', 1, True),
120 Extension('VK_AMD_gcn_shader', 1, True),
121 Extension('VK_AMD_rasterization_order', 1, 'device->has_out_of_order_rast'),
122 Extension('VK_AMD_shader_core_properties', 1, True),
123 Extension('VK_AMD_shader_info', 1, True),
124 Extension('VK_AMD_shader_trinary_minmax', 1, True),
125 Extension('VK_GOOGLE_decorate_string', 1, True),
126 Extension('VK_GOOGLE_hlsl_functionality1', 1, True),
130 def __init__(self
, string
):
131 split
= string
.split('.')
132 self
.major
= int(split
[0])
133 self
.minor
= int(split
[1])
135 assert len(split
) == 3
136 self
.patch
= int(split
[2])
140 # Sanity check. The range bits are required by the definition of the
141 # VK_MAKE_VERSION macro
142 assert self
.major
< 1024 and self
.minor
< 1024
143 assert self
.patch
is None or self
.patch
< 4096
144 assert(str(self
) == string
)
147 ver_list
= [str(self
.major
), str(self
.minor
)]
148 if self
.patch
is not None:
149 ver_list
.append(str(self
.patch
))
150 return '.'.join(ver_list
)
152 def c_vk_version(self
):
153 patch
= self
.patch
if self
.patch
is not None else 0
154 ver_list
= [str(self
.major
), str(self
.minor
), str(patch
)]
155 return 'VK_MAKE_VERSION(' + ', '.join(ver_list
) + ')'
158 # This is just an expansion of VK_VERSION
159 patch
= self
.patch
if self
.patch
is not None else 0
160 return (self
.major
<< 22) |
(self
.minor
<< 12) | patch
162 def __gt__(self
, other
):
163 # If only one of them has a patch version, "ignore" it by making
164 # other's patch version match self.
165 if (self
.patch
is None) != (other
.patch
is None):
166 other
= copy
.copy(other
)
167 other
.patch
= self
.patch
169 return self
.__int
_ver
() > other
.__int
_ver
()
172 MAX_API_VERSION
= VkVersion(MAX_API_VERSION
)
174 def _init_exts_from_xml(xml
):
175 """ Walk the Vulkan XML and fill out extra extension information. """
180 for ext
in EXTENSIONS
:
181 ext_name_map
[ext
.name
] = ext
183 for ext_elem
in xml
.findall('.extensions/extension'):
184 ext_name
= ext_elem
.attrib
['name']
185 if ext_name
not in ext_name_map
:
188 ext
= ext_name_map
[ext_name
]
189 ext
.type = ext_elem
.attrib
['type']
190 ext
.promotedto
= ext_elem
.attrib
.get('promotedto', None)
192 ext
.requires
= ext_elem
.attrib
['requires'].split(',')
197 if ext
.type == 'instance':
198 check
= 'instance->enabled_extensions.{}'.format(ext
.name
[3:])
199 if ext
.promotedto
is not None:
200 # the xml contains values like VK_VERSION_1_1, but we need to
201 # translate them to VK_API_VERSION_1_1 for the apiVersion check
202 api_ver
= ext
.promotedto
.replace('VK_VER', 'VK_API_VER')
203 check
= '({} || instance->apiVersion >= {})'.format(check
, api_ver
)
207 for dep
in ext
.requires
:
208 deps |
= extra_deps(ext_name_map
[dep
])
212 for ext
in EXTENSIONS
:
213 if ext
.type == 'device':
214 for dep
in extra_deps(ext
):
215 ext
.enable
+= ' && ' + dep
217 _TEMPLATE_H
= Template(COPYRIGHT
+ """
218 #ifndef RADV_EXTENSIONS_H
219 #define RADV_EXTENSIONS_H
222 RADV_INSTANCE_EXTENSION_COUNT = ${len(instance_extensions)},
223 RADV_DEVICE_EXTENSION_COUNT = ${len(device_extensions)},
226 struct radv_instance_extension_table {
228 bool extensions[RADV_INSTANCE_EXTENSION_COUNT];
230 %for ext in instance_extensions:
231 bool ${ext.name[3:]};
237 struct radv_device_extension_table {
239 bool extensions[RADV_DEVICE_EXTENSION_COUNT];
241 %for ext in device_extensions:
242 bool ${ext.name[3:]};
248 extern const VkExtensionProperties radv_instance_extensions[RADV_INSTANCE_EXTENSION_COUNT];
249 extern const VkExtensionProperties radv_device_extensions[RADV_DEVICE_EXTENSION_COUNT];
250 extern const struct radv_instance_extension_table radv_supported_instance_extensions;
253 struct radv_physical_device;
255 void radv_fill_device_extension_table(const struct radv_physical_device *device,
256 struct radv_device_extension_table* table);
260 _TEMPLATE_C
= Template(COPYRIGHT
+ """
261 #include "radv_private.h"
265 /* Convert the VK_USE_PLATFORM_* defines to booleans */
266 %for platform in ['ANDROID_KHR', 'WAYLAND_KHR', 'XCB_KHR', 'XLIB_KHR', 'DISPLAY_KHR', 'XLIB_XRANDR_EXT']:
267 #ifdef VK_USE_PLATFORM_${platform}
268 # undef VK_USE_PLATFORM_${platform}
269 # define VK_USE_PLATFORM_${platform} true
271 # define VK_USE_PLATFORM_${platform} false
275 /* And ANDROID too */
278 # define ANDROID true
280 # define ANDROID false
283 #define RADV_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
284 VK_USE_PLATFORM_XCB_KHR || \\
285 VK_USE_PLATFORM_XLIB_KHR || \\
286 VK_USE_PLATFORM_DISPLAY_KHR)
289 const VkExtensionProperties radv_instance_extensions[RADV_INSTANCE_EXTENSION_COUNT] = {
290 %for ext in instance_extensions:
291 {"${ext.name}", ${ext.ext_version}},
295 const VkExtensionProperties radv_device_extensions[RADV_DEVICE_EXTENSION_COUNT] = {
296 %for ext in device_extensions:
297 {"${ext.name}", ${ext.ext_version}},
301 const struct radv_instance_extension_table radv_supported_instance_extensions = {
302 %for ext in instance_extensions:
303 .${ext.name[3:]} = ${ext.enable},
307 void radv_fill_device_extension_table(const struct radv_physical_device *device,
308 struct radv_device_extension_table* table)
310 const struct radv_instance *instance = device->instance;
311 %for ext in device_extensions:
312 table->${ext.name[3:]} = ${ext.enable};
316 VkResult radv_EnumerateInstanceVersion(
317 uint32_t* pApiVersion)
319 *pApiVersion = ${MAX_API_VERSION.c_vk_version()};
324 radv_physical_device_api_version(struct radv_physical_device *dev)
326 if (!ANDROID && dev->rad_info.has_syncobj_wait_for_submit)
327 return ${MAX_API_VERSION.c_vk_version()};
328 return VK_MAKE_VERSION(1, 0, 68);
332 if __name__
== '__main__':
333 parser
= argparse
.ArgumentParser()
334 parser
.add_argument('--out-c', help='Output C file.', required
=True)
335 parser
.add_argument('--out-h', help='Output H file.', required
=True)
336 parser
.add_argument('--xml',
337 help='Vulkan API XML file.',
341 args
= parser
.parse_args()
343 for filename
in args
.xml_files
:
344 _init_exts_from_xml(filename
)
346 for ext
in EXTENSIONS
:
347 assert ext
.type == 'instance' or ext
.type == 'device'
350 'MAX_API_VERSION': MAX_API_VERSION
,
351 'instance_extensions': [e
for e
in EXTENSIONS
if e
.type == 'instance'],
352 'device_extensions': [e
for e
in EXTENSIONS
if e
.type == 'device'],
355 with
open(args
.out_c
, 'w') as f
:
356 f
.write(_TEMPLATE_C
.render(**template_env
))
357 with
open(args
.out_h
, 'w') as f
:
358 f
.write(_TEMPLATE_H
.render(**template_env
))