1COPYRIGHT = """\
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
27import copy
28import re
29
30def _bool_to_c_expr(b):
31    if b is True:
32        return 'true'
33    if b is False:
34        return 'false'
35    return b
36
37class Extension:
38    def __init__(self, name, ext_version, enable):
39        self.name = name
40        self.ext_version = int(ext_version)
41        self.enable = _bool_to_c_expr(enable)
42
43class ApiVersion:
44    def __init__(self, version, enable):
45        self.version = version
46        self.enable = _bool_to_c_expr(enable)
47
48API_PATCH_VERSION = 102
49
50# Supported API versions.  Each one is the maximum patch version for the given
51# version.  Version come in increasing order and each version is available if
52# it's provided "enable" condition is true and all previous versions are
53# available.
54API_VERSIONS = [
55    ApiVersion('1.0',   True),
56
57    # DRM_IOCTL_SYNCOBJ_WAIT is required for VK_KHR_external_fence which is a
58    # required core feature in Vulkan 1.1
59    ApiVersion('1.1',   'device->has_syncobj_wait'),
60]
61
62MAX_API_VERSION = None # Computed later
63
64# On Android, we disable all surface and swapchain extensions. Android's Vulkan
65# loader implements VK_KHR_surface and VK_KHR_swapchain, and applications
66# cannot access the driver's implementation. Moreoever, if the driver exposes
67# the those extension strings, then tests dEQP-VK.api.info.instance.extensions
68# and dEQP-VK.api.info.device fail due to the duplicated strings.
69EXTENSIONS = [
70    Extension('VK_KHR_8bit_storage',                      1, 'device->info.gen >= 8'),
71    Extension('VK_KHR_16bit_storage',                     1, 'device->info.gen >= 8'),
72    Extension('VK_KHR_bind_memory2',                      1, True),
73    Extension('VK_KHR_create_renderpass2',                1, True),
74    Extension('VK_KHR_dedicated_allocation',              1, True),
75    Extension('VK_KHR_depth_stencil_resolve',             1, True),
76    Extension('VK_KHR_descriptor_update_template',        1, True),
77    Extension('VK_KHR_device_group',                      1, True),
78    Extension('VK_KHR_device_group_creation',             1, True),
79    Extension('VK_KHR_display',                          23, 'VK_USE_PLATFORM_DISPLAY_KHR'),
80    Extension('VK_KHR_draw_indirect_count',               1, True),
81    Extension('VK_KHR_driver_properties',                 1, True),
82    Extension('VK_KHR_external_fence',                    1,
83              'device->has_syncobj_wait'),
84    Extension('VK_KHR_external_fence_capabilities',       1, True),
85    Extension('VK_KHR_external_fence_fd',                 1,
86              'device->has_syncobj_wait'),
87    Extension('VK_KHR_external_memory',                   1, True),
88    Extension('VK_KHR_external_memory_capabilities',      1, True),
89    Extension('VK_KHR_external_memory_fd',                1, True),
90    Extension('VK_KHR_external_semaphore',                1, True),
91    Extension('VK_KHR_external_semaphore_capabilities',   1, True),
92    Extension('VK_KHR_external_semaphore_fd',             1, True),
93    Extension('VK_KHR_get_display_properties2',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
94    Extension('VK_KHR_get_memory_requirements2',          1, True),
95    Extension('VK_KHR_get_physical_device_properties2',   1, True),
96    Extension('VK_KHR_get_surface_capabilities2',         1, 'ANV_HAS_SURFACE'),
97    Extension('VK_KHR_image_format_list',                 1, True),
98    Extension('VK_KHR_incremental_present',               1, 'ANV_HAS_SURFACE'),
99    Extension('VK_KHR_maintenance1',                      1, True),
100    Extension('VK_KHR_maintenance2',                      1, True),
101    Extension('VK_KHR_maintenance3',                      1, True),
102    Extension('VK_KHR_multiview',                         1, True),
103    Extension('VK_KHR_push_descriptor',                   1, True),
104    Extension('VK_KHR_relaxed_block_layout',              1, True),
105    Extension('VK_KHR_sampler_mirror_clamp_to_edge',      1, True),
106    Extension('VK_KHR_sampler_ycbcr_conversion',          1, True),
107    Extension('VK_KHR_shader_atomic_int64',               1,
108              'device->info.gen >= 9 && device->use_softpin'),
109    Extension('VK_KHR_shader_draw_parameters',            1, True),
110    Extension('VK_KHR_shader_float16_int8',               1, 'device->info.gen >= 8'),
111    Extension('VK_KHR_storage_buffer_storage_class',      1, True),
112    Extension('VK_KHR_surface',                          25, 'ANV_HAS_SURFACE'),
113    Extension('VK_KHR_surface_protected_capabilities',    1, 'ANV_HAS_SURFACE'),
114    Extension('VK_KHR_swapchain',                        70, 'ANV_HAS_SURFACE'),
115    Extension('VK_KHR_variable_pointers',                 1, True),
116    Extension('VK_KHR_wayland_surface',                   6, 'VK_USE_PLATFORM_WAYLAND_KHR'),
117    Extension('VK_KHR_xcb_surface',                       6, 'VK_USE_PLATFORM_XCB_KHR'),
118    Extension('VK_KHR_xlib_surface',                      6, 'VK_USE_PLATFORM_XLIB_KHR'),
119    Extension('VK_EXT_acquire_xlib_display',              1, 'VK_USE_PLATFORM_XLIB_XRANDR_EXT'),
120    Extension('VK_EXT_buffer_device_address',             1, 'device->has_a64_buffer_access'),
121    Extension('VK_EXT_calibrated_timestamps',             1, True),
122    Extension('VK_EXT_conditional_rendering',             1, 'device->info.gen >= 8 || device->info.is_haswell'),
123    Extension('VK_EXT_debug_report',                      8, True),
124    Extension('VK_EXT_depth_clip_enable',                 1, True),
125    Extension('VK_EXT_descriptor_indexing',               2,
126              'device->has_a64_buffer_access && device->has_bindless_images'),
127    Extension('VK_EXT_direct_mode_display',               1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
128    Extension('VK_EXT_display_control',                   1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
129    Extension('VK_EXT_display_surface_counter',           1, 'VK_USE_PLATFORM_DISPLAY_KHR'),
130    Extension('VK_EXT_external_memory_dma_buf',           1, True),
131    Extension('VK_EXT_external_memory_host',              1, True),
132    Extension('VK_EXT_global_priority',                   1,
133              'device->has_context_priority'),
134    Extension('VK_EXT_host_query_reset',                  1, True),
135    Extension('VK_EXT_inline_uniform_block',              1, True),
136    Extension('VK_EXT_memory_budget',                     1, 'device->has_mem_available'),
137    Extension('VK_EXT_pci_bus_info',                      2, True),
138    Extension('VK_EXT_pipeline_creation_feedback',        1, True),
139    Extension('VK_EXT_post_depth_coverage',               1, 'device->info.gen >= 9'),
140    Extension('VK_EXT_queue_family_foreign',              1, 'ANDROID'),
141    Extension('VK_EXT_sampler_filter_minmax',             1, 'device->info.gen >= 9'),
142    Extension('VK_EXT_scalar_block_layout',               1, True),
143    Extension('VK_EXT_shader_stencil_export',             1, 'device->info.gen >= 9'),
144    Extension('VK_EXT_shader_viewport_index_layer',       1, True),
145    Extension('VK_EXT_transform_feedback',                1, 'device->info.gen >= 8'),
146    Extension('VK_EXT_vertex_attribute_divisor',          3, True),
147    Extension('VK_EXT_ycbcr_image_arrays',                1, True),
148    Extension('VK_ANDROID_external_memory_android_hardware_buffer', 3, 'ANDROID'),
149    Extension('VK_ANDROID_native_buffer',                 5, 'ANDROID'),
150    Extension('VK_GOOGLE_decorate_string',                1, True),
151    Extension('VK_GOOGLE_hlsl_functionality1',            1, True),
152    Extension('VK_NV_compute_shader_derivatives',         1, True),
153]
154
155# Sort the extension list the way we expect: KHR, then EXT, then vendors
156# alphabetically. For digits, read them as a whole number sort that.
157# eg.: VK_KHR_8bit_storage < VK_KHR_16bit_storage < VK_EXT_acquire_xlib_display
158def extension_order(ext):
159    order = []
160    for substring in re.split('(KHR|EXT|[0-9]+)', ext.name):
161        if substring == 'KHR':
162            order.append(1)
163        if substring == 'EXT':
164            order.append(2)
165        elif substring.isdigit():
166            order.append(int(substring))
167        else:
168            order.append(substring)
169    return order
170for i in range(len(EXTENSIONS) - 1):
171    if extension_order(EXTENSIONS[i + 1]) < extension_order(EXTENSIONS[i]):
172        print(EXTENSIONS[i + 1].name + ' should come before ' + EXTENSIONS[i].name)
173        exit(1)
174
175class VkVersion:
176    def __init__(self, string):
177        split = string.split('.')
178        self.major = int(split[0])
179        self.minor = int(split[1])
180        if len(split) > 2:
181            assert len(split) == 3
182            self.patch = int(split[2])
183        else:
184            self.patch = None
185
186        # Sanity check.  The range bits are required by the definition of the
187        # VK_MAKE_VERSION macro
188        assert self.major < 1024 and self.minor < 1024
189        assert self.patch is None or self.patch < 4096
190        assert str(self) == string
191
192    def __str__(self):
193        ver_list = [str(self.major), str(self.minor)]
194        if self.patch is not None:
195            ver_list.append(str(self.patch))
196        return '.'.join(ver_list)
197
198    def c_vk_version(self):
199        patch = self.patch if self.patch is not None else 0
200        ver_list = [str(self.major), str(self.minor), str(patch)]
201        return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
202
203    def __int_ver(self):
204        # This is just an expansion of VK_VERSION
205        patch = self.patch if self.patch is not None else 0
206        return (self.major << 22) | (self.minor << 12) | patch
207
208    def __gt__(self, other):
209        # If only one of them has a patch version, "ignore" it by making
210        # other's patch version match self.
211        if (self.patch is None) != (other.patch is None):
212            other = copy.copy(other)
213            other.patch = self.patch
214
215        return self.__int_ver() > other.__int_ver()
216
217
218
219MAX_API_VERSION = VkVersion('0.0.0')
220for version in API_VERSIONS:
221    version.version = VkVersion(version.version)
222    version.version.patch = API_PATCH_VERSION
223    assert version.version > MAX_API_VERSION
224    MAX_API_VERSION = version.version
225