Mesa (main): vulkan: Generate code to place commands in a queue
GitLab Mirror
gitlab-mirror at kemper.freedesktop.org
Wed Sep 1 01:35:16 UTC 2021
Module: Mesa
Branch: main
Commit: a7b0946ef046fd75a98136720e90e584a9c3521b
URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=a7b0946ef046fd75a98136720e90e584a9c3521b
Author: Tomeu Vizoso <tomeu.vizoso at collabora.com>
Date: Wed Aug 11 10:01:14 2021 +0200
vulkan: Generate code to place commands in a queue
It can be used by lavapipe and also by drivers for GPUs with command
streams that require values related to the framebuffer, thus the command
stream emission for secondary buffers needs to be deferred until the
framebuffer is known (execution time).
Signed-off-by: Tomeu Vizoso <tomeu.vizoso at collabora.com>
Reviewed-by: Antonio Caggiano <antonio.caggiano at collabora.com>
Acked-By: Mike Blumenkrantz <michael.blumenkrantz at gmail.com>
Reviewed-by: Dave Airlie <airlied at redhat.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/12369>
---
src/vulkan/util/meson.build | 17 +-
src/vulkan/util/vk_cmd_queue_gen.py | 393 ++++++++++++++++++++++++++++++++++++
2 files changed, 409 insertions(+), 1 deletion(-)
diff --git a/src/vulkan/util/meson.build b/src/vulkan/util/meson.build
index d0d55432bd5..055d3598c29 100644
--- a/src/vulkan/util/meson.build
+++ b/src/vulkan/util/meson.build
@@ -34,6 +34,10 @@ vk_entrypoints_gen_depend_files = [
files('vk_dispatch_table_gen.py'),
vk_dispatch_table_gen_depend_files,
]
+vk_cmd_queue_gen_depend_files = [
+ files('vk_dispatch_table_gen.py'),
+ vk_dispatch_table_gen_depend_files,
+]
vk_entrypoints_gen = files('vk_entrypoints_gen.py')
vk_extensions_gen = files('vk_extensions_gen.py')
@@ -110,10 +114,21 @@ vk_extensions = custom_target(
depend_files : vk_extensions_gen_depend_files,
)
+vk_cmd_queue = custom_target(
+ 'vk_cmd_queue',
+ input : ['vk_cmd_queue_gen.py', vk_api_xml],
+ output : ['vk_cmd_queue.c', 'vk_cmd_queue.h'],
+ command : [
+ prog_python, '@INPUT0@', '--xml', '@INPUT1@',
+ '--out-c', '@OUTPUT0@', '--out-h', '@OUTPUT1@'
+ ],
+ depend_files : vk_cmd_queue_gen_depend_files,
+)
+
libvulkan_util = static_library(
'vulkan_util',
[files_vulkan_util, vk_common_entrypoints, vk_dispatch_table,
- vk_enum_to_str, vk_extensions],
+ vk_enum_to_str, vk_extensions, vk_cmd_queue],
include_directories : [inc_include, inc_src, inc_gallium],
dependencies : [vulkan_wsi_deps, idep_mesautil, idep_nir_headers],
# For glsl_type_singleton
diff --git a/src/vulkan/util/vk_cmd_queue_gen.py b/src/vulkan/util/vk_cmd_queue_gen.py
new file mode 100644
index 00000000000..095cf4ca3ae
--- /dev/null
+++ b/src/vulkan/util/vk_cmd_queue_gen.py
@@ -0,0 +1,393 @@
+# coding=utf-8
+COPYRIGHT=u"""
+/* Copyright © 2015-2021 Intel Corporation
+ * Copyright © 2021 Collabora, Ltd.
+ *
+ * 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, sublicense,
+ * 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 NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS 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 argparse
+import os
+import re
+import xml.etree.ElementTree as et
+
+from mako.template import Template
+
+# Mesa-local imports must be declared in meson variable
+# '{file_without_suffix}_depend_files'.
+from vk_dispatch_table_gen import get_entrypoints_from_xml, EntrypointParam
+
+MANUAL_COMMANDS = ['CmdPushDescriptorSetKHR', # This script doesn't know how to copy arrays in structs in arrays
+ 'CmdPushDescriptorSetWithTemplateKHR', # pData's size cannot be calculated from the xml
+ 'CmdDrawMultiEXT', # The size of the elements is specified in a stride param
+ 'CmdDrawMultiIndexedEXT', # The size of the elements is specified in a stride param
+ 'CmdBindDescriptorSets', # The VkPipelineLayout object could be released before the command is executed
+ ]
+
+TEMPLATE_H = Template(COPYRIGHT + """\
+/* This file generated from ${filename}, don't edit directly. */
+
+#pragma once
+
+#include "util/list.h"
+
+#define VK_PROTOTYPES
+#include <vulkan/vulkan.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct vk_cmd_queue {
+ VkAllocationCallbacks *alloc;
+ struct list_head cmds;
+};
+
+enum vk_cmd_type {
+% for c in commands:
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+ ${to_enum_name(c.name)},
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+% endfor
+};
+
+extern const char *vk_cmd_queue_type_names[];
+
+% for c in commands:
+% if len(c.params) <= 1: # Avoid "error C2016: C requires that a struct or union have at least one member"
+<% continue %>
+% endif
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+struct ${to_struct_name(c.name)} {
+% for p in c.params[1:]:
+ ${to_field_decl(p.decl)};
+% endfor
+};
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+% endfor
+
+struct vk_cmd_queue_entry {
+ struct list_head cmd_link;
+ enum vk_cmd_type type;
+ union {
+% for c in commands:
+% if len(c.params) <= 1:
+<% continue %>
+% endif
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+ struct ${to_struct_name(c.name)} ${to_struct_field_name(c.name)};
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+% endfor
+ } u;
+ void *driver_data;
+};
+
+% for c in commands:
+% if c.name in manual_commands:
+<% continue %>
+% endif
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+ void vk_enqueue_${to_underscore(c.name)}(struct vk_cmd_queue *queue
+% for p in c.params[1:]:
+ , ${p.decl}
+% endfor
+ );
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+
+% endfor
+
+void vk_free_queue(struct vk_cmd_queue *queue);
+
+#ifdef __cplusplus
+}
+#endif
+""", output_encoding='utf-8')
+
+TEMPLATE_C = Template(COPYRIGHT + """
+/* This file generated from ${filename}, don't edit directly. */
+
+#include "${header}"
+
+#define VK_PROTOTYPES
+#include <vulkan/vulkan.h>
+
+#include "vk_alloc.h"
+
+const char *vk_cmd_queue_type_names[] = {
+% for c in commands:
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+ "${to_enum_name(c.name)}",
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+% endfor
+};
+
+% for c in commands:
+% if c.name in manual_commands:
+<% continue %>
+% endif
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+void vk_enqueue_${to_underscore(c.name)}(struct vk_cmd_queue *queue
+% for p in c.params[1:]:
+, ${p.decl}
+% endfor
+)
+{
+ struct vk_cmd_queue_entry *cmd = vk_zalloc(queue->alloc,
+ sizeof(*cmd), 8,
+ VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);
+ if (!cmd)
+ return;
+
+ cmd->type = ${to_enum_name(c.name)};
+ list_addtail(&cmd->cmd_link, &queue->cmds);
+
+% for p in c.params[1:]:
+% if p.len:
+ if (${p.name}) {
+ ${get_array_copy(c, p)}
+ }
+% elif '[' in p.decl:
+ memcpy(cmd->u.${to_struct_field_name(c.name)}.${to_field_name(p.name)}, ${p.name},
+ sizeof(*${p.name}) * ${get_array_len(p)});
+% elif '*' in p.decl:
+ ${get_struct_copy(c, p, types)}
+% else:
+ cmd->u.${to_struct_field_name(c.name)}.${to_field_name(p.name)} = ${p.name};
+% endif
+% endfor
+}
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+
+% endfor
+
+void
+vk_free_queue(struct vk_cmd_queue *queue)
+{
+ struct vk_cmd_queue_entry *tmp, *cmd;
+ LIST_FOR_EACH_ENTRY_SAFE(cmd, tmp, &queue->cmds, cmd_link) {
+ switch(cmd->type) {
+% for c in commands:
+% if c.guard is not None:
+#ifdef ${c.guard}
+% endif
+ case ${to_enum_name(c.name)}:
+% for p in c.params[1:]:
+% if p.len:
+ vk_free(queue->alloc, (${p.decl.replace("const", "").removesuffix(p.name)})cmd->u.${to_struct_field_name(c.name)}.${to_field_name(p.name)});
+% elif '*' in p.decl:
+ ${get_struct_free(c, p, types)}
+% endif
+% endfor
+ break;
+% if c.guard is not None:
+#endif // ${c.guard}
+% endif
+% endfor
+ }
+ vk_free(queue->alloc, cmd);
+ }
+}
+
+""", output_encoding='utf-8')
+
+def to_underscore(name):
+ return re.sub('([A-Z]+)', r'_\1', name).lower().removeprefix('_')
+
+def to_struct_field_name(name):
+ return to_underscore(name).replace('cmd_', '')
+
+def to_field_name(name):
+ return to_underscore(name).replace('cmd_', '').removeprefix('p_')
+
+def to_field_decl(decl):
+ decl = decl.replace('const ', '')
+ [decl, name] = decl.rsplit(' ', 1)
+ return decl + ' ' + to_field_name(name)
+
+def to_enum_name(name):
+ return "VK_%s" % to_underscore(name).upper()
+
+def to_struct_name(name):
+ return "vk_%s" % to_underscore(name)
+
+def get_array_len(param):
+ return param.decl[param.decl.find("[") + 1:param.decl.find("]")]
+
+def get_array_copy(command, param):
+ field_name = "cmd->u.%s.%s" % (to_struct_field_name(command.name), to_field_name(param.name))
+ if param.type == "void":
+ field_size = "1"
+ else:
+ field_size = "sizeof(*%s)" % field_name
+ allocation = "%s = vk_zalloc(queue->alloc, %s * %s, 8, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);" % (field_name, field_size, param.len)
+ const_cast = param.decl.replace("const", "").removesuffix(param.name)
+ copy = "memcpy((%s)%s, %s, %s * %s);" % (const_cast, field_name, param.name, field_size, param.len)
+ return "%s\n %s" % (allocation, copy)
+
+def get_array_member_copy(command, param, member):
+ field_name = "cmd->u.%s.%s->%s" % (to_struct_field_name(command.name), to_field_name(param.name), member.name)
+ len_field_name = "cmd->u.%s.%s->%s" % (to_struct_field_name(command.name), to_field_name(param.name), member.len)
+ allocation = "%s = vk_zalloc(queue->alloc, sizeof(*%s) * %s, 8, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);" % (field_name, field_name, len_field_name)
+ const_cast = member.decl.replace("const", "").removesuffix(member.name)
+ copy = "memcpy((%s)%s, %s->%s, sizeof(*%s) * %s);" % (const_cast, field_name, param.name, member.name, field_name, len_field_name)
+ return "%s\n %s\n" % (allocation, copy)
+
+def get_struct_copy(command, param, types):
+ field_name = "cmd->u.%s.%s" % (to_struct_field_name(command.name), to_field_name(param.name))
+
+ if param.type == "void":
+ const_cast = param.decl.replace("const", "").removesuffix(param.name)
+ return "%s = (%s) %s;" % (field_name, const_cast, param.name)
+
+ allocation = "%s = vk_zalloc(queue->alloc, sizeof(*%s), 8, VK_SYSTEM_ALLOCATION_SCOPE_COMMAND);" % (field_name, field_name)
+ copy = "memcpy(%s, %s, sizeof(*%s));" % (field_name, param.name, field_name)
+
+ member_copies = ""
+ if (param.type in types):
+ for member in types[param.type]:
+ if member.len and member.len != 'null-terminated':
+ member_copies += get_array_member_copy(command, param, member)
+
+ null_assignment = "%s = NULL;" % field_name
+ if_stmt = "if (%s) {" % param.name
+ return "%s\n %s\n %s\n %s } else {\n %s\n }" % (if_stmt, allocation, copy, member_copies, null_assignment)
+
+def get_struct_free(command, param, types):
+ field_name = "cmd->u.%s.%s" % (to_struct_field_name(command.name), to_field_name(param.name))
+ const_cast = param.decl.replace("const", "").removesuffix(param.name)
+ driver_data_free = "vk_free(queue->alloc, cmd->driver_data);\n"
+ struct_free = "vk_free(queue->alloc, (%s)%s);" % (const_cast, field_name)
+ member_frees = ""
+ if (param.type in types):
+ for member in types[param.type]:
+ if member.len and member.len != 'null-terminated':
+ member_name = "cmd->u.%s.%s->%s" % (to_struct_field_name(command.name), to_field_name(param.name), member.name)
+ const_cast = member.decl.replace("const", "").removesuffix(member.name)
+ member_frees += "vk_free(queue->alloc, (%s)%s);\n" % (const_cast, member_name)
+ return "%s %s %s\n" % (member_frees, driver_data_free, struct_free)
+
+def get_types(doc):
+ """Extract the types from the registry."""
+ types = {}
+
+ for _type in doc.findall('./types/type'):
+ if _type.attrib.get('category') != 'struct':
+ continue
+ params = [EntrypointParam(
+ type=p.find('./type').text,
+ name=p.find('./name').text,
+ decl=''.join(p.itertext()),
+ len=p.attrib.get('len', None)
+ ) for p in _type.findall('./member')]
+ types[_type.attrib['name']] = params
+
+ return types
+
+def get_types_from_xml(xml_files):
+ types = {}
+
+ for filename in xml_files:
+ doc = et.parse(filename)
+ types.update(get_types(doc))
+
+ return types
+
+def main():
+ parser = argparse.ArgumentParser()
+ parser.add_argument('--out-c', required=True, help='Output C file.')
+ parser.add_argument('--out-h', required=True, help='Output H file.')
+ parser.add_argument('--xml',
+ help='Vulkan API XML file.',
+ required=True, action='append', dest='xml_files')
+ args = parser.parse_args()
+
+ commands = []
+ for e in get_entrypoints_from_xml(args.xml_files):
+ if e.name.startswith('Cmd') and \
+ not e.alias:
+ commands.append(e)
+
+ types = get_types_from_xml(args.xml_files)
+
+ assert os.path.dirname(args.out_c) == os.path.dirname(args.out_h)
+
+ environment = {
+ 'header': os.path.basename(args.out_h),
+ 'commands': commands,
+ 'filename': os.path.basename(__file__),
+ 'to_underscore': to_underscore,
+ 'get_array_len': get_array_len,
+ 'to_struct_field_name': to_struct_field_name,
+ 'to_field_name': to_field_name,
+ 'to_field_decl': to_field_decl,
+ 'to_enum_name': to_enum_name,
+ 'to_struct_name': to_struct_name,
+ 'get_array_copy': get_array_copy,
+ 'get_struct_copy': get_struct_copy,
+ 'get_struct_free': get_struct_free,
+ 'types': types,
+ 'manual_commands': MANUAL_COMMANDS,
+ }
+
+ try:
+ with open(args.out_h, 'wb') as f:
+ guard = os.path.basename(args.out_h).replace('.', '_').upper()
+ f.write(TEMPLATE_H.render(guard=guard, **environment))
+ with open(args.out_c, 'wb') as f:
+ f.write(TEMPLATE_C.render(**environment))
+ except Exception:
+ # In the event there's an error, this imports some helpers from mako
+ # to print a useful stack trace and prints it, then exits with
+ # status 1, if python is run with debug; otherwise it just raises
+ # the exception
+ if __debug__:
+ import sys
+ from mako import exceptions
+ sys.stderr.write(exceptions.text_error_template().render() + '\n')
+ sys.exit(1)
+ raise
+
+if __name__ == '__main__':
+ main()
More information about the mesa-commit
mailing list