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.82'
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_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),
82 def __init__(self
, string
):
83 split
= string
.split('.')
84 self
.major
= int(split
[0])
85 self
.minor
= int(split
[1])
87 assert len(split
) == 3
88 self
.patch
= int(split
[2])
92 # Sanity check. The range bits are required by the definition of the
93 # VK_MAKE_VERSION macro
94 assert self
.major
< 1024 and self
.minor
< 1024
95 assert self
.patch
is None or self
.patch
< 4096
96 assert(str(self
) == string
)
99 ver_list
= [str(self
.major
), str(self
.minor
)]
100 if self
.patch
is not None:
101 ver_list
.append(str(self
.patch
))
102 return '.'.join(ver_list
)
104 def c_vk_version(self
):
105 patch
= self
.patch
if self
.patch
is not None else 0
106 ver_list
= [str(self
.major
), str(self
.minor
), str(patch
)]
107 return 'VK_MAKE_VERSION(' + ', '.join(ver_list
) + ')'
110 # This is just an expansion of VK_VERSION
111 patch
= self
.patch
if self
.patch
is not None else 0
112 return (self
.major
<< 22) |
(self
.minor
<< 12) | patch
114 def __gt__(self
, other
):
115 # If only one of them has a patch version, "ignore" it by making
116 # other's patch version match self.
117 if (self
.patch
is None) != (other
.patch
is None):
118 other
= copy
.copy(other
)
119 other
.patch
= self
.patch
121 return self
.__int
_ver
() > other
.__int
_ver
()
123 MAX_API_VERSION
= VkVersion(MAX_API_VERSION
)
125 def _init_exts_from_xml(xml
):
126 """ Walk the Vulkan XML and fill out extra extension information. """
131 for ext
in EXTENSIONS
:
132 ext_name_map
[ext
.name
] = ext
134 for ext_elem
in xml
.findall('.extensions/extension'):
135 ext_name
= ext_elem
.attrib
['name']
136 if ext_name
not in ext_name_map
:
139 ext
= ext_name_map
[ext_name
]
140 ext
.type = ext_elem
.attrib
['type']
142 _TEMPLATE_H
= Template(COPYRIGHT
+ """
143 #ifndef TU_EXTENSIONS_H
144 #define TU_EXTENSIONS_H
147 TU_INSTANCE_EXTENSION_COUNT = ${len(instance_extensions)},
148 TU_DEVICE_EXTENSION_COUNT = ${len(device_extensions)},
151 struct tu_instance_extension_table {
153 bool extensions[TU_INSTANCE_EXTENSION_COUNT];
155 %for ext in instance_extensions:
156 bool ${ext.name[3:]};
162 struct tu_device_extension_table {
164 bool extensions[TU_DEVICE_EXTENSION_COUNT];
166 %for ext in device_extensions:
167 bool ${ext.name[3:]};
173 extern const VkExtensionProperties tu_instance_extensions[TU_INSTANCE_EXTENSION_COUNT];
174 extern const VkExtensionProperties tu_device_extensions[TU_DEVICE_EXTENSION_COUNT];
175 extern const struct tu_instance_extension_table tu_supported_instance_extensions;
178 struct tu_physical_device;
180 void tu_fill_device_extension_table(const struct tu_physical_device *device,
181 struct tu_device_extension_table* table);
185 _TEMPLATE_C
= Template(COPYRIGHT
+ """
186 #include "tu_private.h"
190 /* Convert the VK_USE_PLATFORM_* defines to booleans */
191 %for platform in ['ANDROID_KHR', 'WAYLAND_KHR', 'XCB_KHR', 'XLIB_KHR', 'DISPLAY_KHR', 'XLIB_XRANDR_EXT']:
192 #ifdef VK_USE_PLATFORM_${platform}
193 # undef VK_USE_PLATFORM_${platform}
194 # define VK_USE_PLATFORM_${platform} true
196 # define VK_USE_PLATFORM_${platform} false
200 /* And ANDROID too */
203 # define ANDROID true
205 # define ANDROID false
208 #define TU_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
209 VK_USE_PLATFORM_XCB_KHR || \\
210 VK_USE_PLATFORM_XLIB_KHR || \\
211 VK_USE_PLATFORM_DISPLAY_KHR)
214 const VkExtensionProperties tu_instance_extensions[TU_INSTANCE_EXTENSION_COUNT] = {
215 %for ext in instance_extensions:
216 {"${ext.name}", ${ext.ext_version}},
220 const VkExtensionProperties tu_device_extensions[TU_DEVICE_EXTENSION_COUNT] = {
221 %for ext in device_extensions:
222 {"${ext.name}", ${ext.ext_version}},
226 const struct tu_instance_extension_table tu_supported_instance_extensions = {
227 %for ext in instance_extensions:
228 .${ext.name[3:]} = ${ext.enable},
232 void tu_fill_device_extension_table(const struct tu_physical_device *device,
233 struct tu_device_extension_table* table)
235 %for ext in device_extensions:
236 table->${ext.name[3:]} = ${ext.enable};
240 VkResult tu_EnumerateInstanceVersion(
241 uint32_t* pApiVersion)
243 *pApiVersion = ${MAX_API_VERSION.c_vk_version()};
248 tu_physical_device_api_version(struct tu_physical_device *dev)
250 return VK_MAKE_VERSION(1, 1, 82);
254 if __name__
== '__main__':
255 parser
= argparse
.ArgumentParser()
256 parser
.add_argument('--out-c', help='Output C file.', required
=True)
257 parser
.add_argument('--out-h', help='Output H file.', required
=True)
258 parser
.add_argument('--xml',
259 help='Vulkan API XML file.',
263 args
= parser
.parse_args()
265 for filename
in args
.xml_files
:
266 _init_exts_from_xml(filename
)
268 for ext
in EXTENSIONS
:
269 assert ext
.type == 'instance' or ext
.type == 'device'
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'],
277 with
open(args
.out_c
, 'w') as f
:
278 f
.write(_TEMPLATE_C
.render(**template_env
))
279 with
open(args
.out_h
, 'w') as f
:
280 f
.write(_TEMPLATE_H
.render(**template_env
))