vulkan: import common code for generating extensions

ANV and RADV have similar Python code for generating extensions
and dispatch tables.

Signed-off-by: Samuel Pitoiset <samuel.pitoiset@gmail.com>
Acked-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Reviewed-by: Bas Nieuwenhuizen <bas@basnieuwenhuizen.nl>
Reviewed-by: Eric Engestrom <eric@engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4987>
This commit is contained in:
Samuel Pitoiset 2020-05-11 14:36:02 +02:00
parent 9b1138e3f0
commit bee8a57942
2 changed files with 370 additions and 0 deletions

View file

@ -0,0 +1,175 @@
import argparse
import copy
import re
import xml.etree.cElementTree as et
def _bool_to_c_expr(b):
if b is True:
return 'true'
if b is False:
return 'false'
return b
class Extension:
def __init__(self, name, ext_version, enable):
self.name = name
self.ext_version = int(ext_version)
self.enable = _bool_to_c_expr(enable)
class ApiVersion:
def __init__(self, version, enable):
self.version = version
self.enable = _bool_to_c_expr(enable)
class VkVersion:
def __init__(self, string):
split = string.split('.')
self.major = int(split[0])
self.minor = int(split[1])
if len(split) > 2:
assert len(split) == 3
self.patch = int(split[2])
else:
self.patch = None
# Sanity check. The range bits are required by the definition of the
# VK_MAKE_VERSION macro
assert self.major < 1024 and self.minor < 1024
assert self.patch is None or self.patch < 4096
assert(str(self) == string)
def __str__(self):
ver_list = [str(self.major), str(self.minor)]
if self.patch is not None:
ver_list.append(str(self.patch))
return '.'.join(ver_list)
def c_vk_version(self):
patch = self.patch if self.patch is not None else 0
ver_list = [str(self.major), str(self.minor), str(patch)]
return 'VK_MAKE_VERSION(' + ', '.join(ver_list) + ')'
def __int_ver(self):
# This is just an expansion of VK_VERSION
patch = self.patch if self.patch is not None else 0
return (self.major << 22) | (self.minor << 12) | patch
def __gt__(self, other):
# If only one of them has a patch version, "ignore" it by making
# other's patch version match self.
if (self.patch is None) != (other.patch is None):
other = copy.copy(other)
other.patch = self.patch
return self.__int_ver() > other.__int_ver()
def init_exts_from_xml(xml, extensions, platform_defines):
""" Walk the Vulkan XML and fill out extra extension information. """
xml = et.parse(xml)
ext_name_map = {}
for ext in extensions:
ext_name_map[ext.name] = ext
# KHR_display is missing from the list.
platform_defines.append('VK_USE_PLATFORM_DISPLAY_KHR')
for platform in xml.findall('./platforms/platform'):
platform_defines.append(platform.attrib['protect'])
for ext_elem in xml.findall('.extensions/extension'):
ext_name = ext_elem.attrib['name']
if ext_name not in ext_name_map:
continue
ext = ext_name_map[ext_name]
ext.type = ext_elem.attrib['type']
# Mapping between extension name and the android version in which the extension
# was whitelisted in Android CTS.
allowed_android_version = {
# Allowed Instance KHR Extensions
"VK_KHR_surface": 26,
"VK_KHR_display": 26,
"VK_KHR_android_surface": 26,
"VK_KHR_mir_surface": 26,
"VK_KHR_wayland_surface": 26,
"VK_KHR_win32_surface": 26,
"VK_KHR_xcb_surface": 26,
"VK_KHR_xlib_surface": 26,
"VK_KHR_get_physical_device_properties2": 26,
"VK_KHR_get_surface_capabilities2": 26,
"VK_KHR_external_memory_capabilities": 28,
"VK_KHR_external_semaphore_capabilities": 28,
"VK_KHR_external_fence_capabilities": 28,
"VK_KHR_device_group_creation": 28,
"VK_KHR_get_display_properties2": 29,
"VK_KHR_surface_protected_capabilities": 29,
# Allowed Device KHR Extensions
"VK_KHR_swapchain": 26,
"VK_KHR_display_swapchain": 26,
"VK_KHR_sampler_mirror_clamp_to_edge": 26,
"VK_KHR_shader_draw_parameters": 26,
"VK_KHR_shader_float_controls": 29,
"VK_KHR_shader_float16_int8": 29,
"VK_KHR_maintenance1": 26,
"VK_KHR_push_descriptor": 26,
"VK_KHR_descriptor_update_template": 26,
"VK_KHR_incremental_present": 26,
"VK_KHR_shared_presentable_image": 26,
"VK_KHR_storage_buffer_storage_class": 28,
"VK_KHR_8bit_storage": 29,
"VK_KHR_16bit_storage": 28,
"VK_KHR_get_memory_requirements2": 28,
"VK_KHR_external_memory": 28,
"VK_KHR_external_memory_fd": 28,
"VK_KHR_external_memory_win32": 28,
"VK_KHR_external_semaphore": 28,
"VK_KHR_external_semaphore_fd": 28,
"VK_KHR_external_semaphore_win32": 28,
"VK_KHR_external_fence": 28,
"VK_KHR_external_fence_fd": 28,
"VK_KHR_external_fence_win32": 28,
"VK_KHR_win32_keyed_mutex": 28,
"VK_KHR_dedicated_allocation": 28,
"VK_KHR_variable_pointers": 28,
"VK_KHR_relaxed_block_layout": 28,
"VK_KHR_bind_memory2": 28,
"VK_KHR_maintenance2": 28,
"VK_KHR_image_format_list": 28,
"VK_KHR_sampler_ycbcr_conversion": 28,
"VK_KHR_device_group": 28,
"VK_KHR_multiview": 28,
"VK_KHR_maintenance3": 28,
"VK_KHR_draw_indirect_count": 28,
"VK_KHR_create_renderpass2": 28,
"VK_KHR_depth_stencil_resolve": 29,
"VK_KHR_driver_properties": 28,
"VK_KHR_swapchain_mutable_format": 29,
"VK_KHR_shader_atomic_int64": 29,
"VK_KHR_vulkan_memory_model": 29,
"VK_GOOGLE_display_timing": 26,
"VK_ANDROID_native_buffer": 26,
"VK_ANDROID_external_memory_android_hardware_buffer": 28,
}
# Extensions with these prefixes are checked in Android CTS, and thus must be
# whitelisted per the preceding dict.
android_extension_whitelist_prefixes = (
"VK_KHX",
"VK_KHR",
"VK_GOOGLE",
"VK_ANDROID"
)
def get_extension_condition(ext_name, condition):
""" If |ext_name| is an extension that Android CTS cares about, prepend
a condition to ensure that the extension is only enabled for Android
versions in which the extension is whitelisted in CTS. """
if not ext_name.startswith(android_extension_whitelist_prefixes):
return condition
allowed_version = allowed_android_version.get(ext_name, 9999)
return "(!ANDROID || ANDROID_API_LEVEL >= %d) && (%s)" % (allowed_version,
condition)

View file

@ -0,0 +1,195 @@
COPYRIGHT = """\
/*
* Copyright 2017 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sub license, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice (including the
* next paragraph) shall be included in all copies or substantial portions
* of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
* IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
"""
import xml.etree.cElementTree as et
from mako.template import Template
from vk_extensions import *
_TEMPLATE_H = Template(COPYRIGHT + """
#ifndef ${driver.upper()}_EXTENSIONS_H
#define ${driver.upper()}_EXTENSIONS_H
%for include in includes:
#include "${include}"
%endfor
#define ${driver.upper()}_INSTANCE_EXTENSION_COUNT ${len(instance_extensions)}
extern const VkExtensionProperties ${driver}_instance_extensions[];
struct ${driver}_instance_extension_table {
union {
bool extensions[${driver.upper()}_INSTANCE_EXTENSION_COUNT];
struct {
%for ext in instance_extensions:
bool ${ext.name[3:]};
%endfor
};
};
};
extern const struct ${driver}_instance_extension_table ${driver}_instance_extensions_supported;
#define ${driver.upper()}_DEVICE_EXTENSION_COUNT ${len(device_extensions)}
extern const VkExtensionProperties ${driver}_device_extensions[];
struct ${driver}_device_extension_table {
union {
bool extensions[${driver.upper()}_DEVICE_EXTENSION_COUNT];
struct {
%for ext in device_extensions:
bool ${ext.name[3:]};
%endfor
};
};
};
struct ${driver}_physical_device;
void
${driver}_physical_device_get_supported_extensions(const struct ${driver}_physical_device *device,
struct ${driver}_device_extension_table *extensions);
#endif /* ${driver.upper()}_EXTENSIONS_H */
""")
_TEMPLATE_C = Template(COPYRIGHT + """
#include "${driver}_private.h"
#include "vk_util.h"
/* Convert the VK_USE_PLATFORM_* defines to booleans */
%for platform_define in platform_defines:
#ifdef ${platform_define}
# undef ${platform_define}
# define ${platform_define} true
#else
# define ${platform_define} false
#endif
%endfor
/* And ANDROID too */
#ifdef ANDROID
# undef ANDROID
# define ANDROID true
#else
# define ANDROID false
# define ANDROID_API_LEVEL 0
#endif
#define ${driver.upper()}_HAS_SURFACE (VK_USE_PLATFORM_WAYLAND_KHR || \\
VK_USE_PLATFORM_XCB_KHR || \\
VK_USE_PLATFORM_XLIB_KHR || \\
VK_USE_PLATFORM_DISPLAY_KHR)
static const uint32_t MAX_API_VERSION = ${MAX_API_VERSION.c_vk_version()};
VkResult ${driver}_EnumerateInstanceVersion(
uint32_t* pApiVersion)
{
*pApiVersion = MAX_API_VERSION;
return VK_SUCCESS;
}
const VkExtensionProperties ${driver}_instance_extensions[${driver.upper()}_INSTANCE_EXTENSION_COUNT] = {
%for ext in instance_extensions:
{"${ext.name}", ${ext.ext_version}},
%endfor
};
const struct ${driver}_instance_extension_table ${driver}_instance_extensions_supported = {
%for ext in instance_extensions:
.${ext.name[3:]} = ${get_extension_condition(ext.name, ext.enable)},
%endfor
};
uint32_t
${driver}_physical_device_api_version(struct ${driver}_physical_device *device)
{
uint32_t version = 0;
uint32_t override = vk_get_version_override();
if (override)
return MIN2(override, MAX_API_VERSION);
%for version in API_VERSIONS:
if (!(${version.enable}))
return version;
version = ${version.version.c_vk_version()};
%endfor
return version;
}
const VkExtensionProperties ${driver}_device_extensions[${driver.upper()}_DEVICE_EXTENSION_COUNT] = {
%for ext in device_extensions:
{"${ext.name}", ${ext.ext_version}},
%endfor
};
void
${driver}_physical_device_get_supported_extensions(const struct ${driver}_physical_device *device,
struct ${driver}_device_extension_table *extensions)
{
*extensions = (struct ${driver}_device_extension_table) {
%for ext in device_extensions:
.${ext.name[3:]} = ${get_extension_condition(ext.name, ext.enable)},
%endfor
};
}
""")
def gen_extensions(driver, xml_files, api_versions, max_api_version, extensions, out_c, out_h, includes = []):
platform_defines = []
for filename in xml_files:
init_exts_from_xml(filename, extensions, platform_defines)
for ext in extensions:
assert ext.type == 'instance' or ext.type == 'device'
template_env = {
'driver': driver,
'API_VERSIONS': api_versions,
'MAX_API_VERSION': max_api_version,
'instance_extensions': [e for e in extensions if e.type == 'instance'],
'device_extensions': [e for e in extensions if e.type == 'device'],
'platform_defines': platform_defines,
'get_extension_condition': get_extension_condition,
'includes': includes,
}
if out_h:
with open(out_h, 'w') as f:
f.write(_TEMPLATE_H.render(**template_env))
if out_c:
with open(out_c, 'w') as f:
f.write(_TEMPLATE_C.render(**template_env))