# coding=utf-8
#
-# Copyright © 2015 Intel Corporation
+# Copyright © 2015, 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"),
# IN THE SOFTWARE.
#
-import fileinput, re, sys
+import argparse
+import functools
+import os
+import xml.etree.cElementTree as et
-# Each function typedef in the vulkan.h header is all on one line and matches
-# this regepx. We hope that won't change.
+from collections import OrderedDict, namedtuple
+from mako.template import Template
-p = re.compile('typedef ([^ ]*) *\((?:VKAPI_PTR)? *\*PFN_vk([^(]*)\)(.*);')
-
-entrypoints = []
+from anv_extensions import *
# We generate a static hash table for entry point lookup
# (vkGetProcAddress). We use a linear congruential generator for our hash
# function and a power-of-two size table. The prime numbers are determined
# experimentally.
-none = 0xffff
-hash_size = 256
-u32_mask = 2**32 - 1
-hash_mask = hash_size - 1
-
-prime_factor = 5024183
-prime_step = 19
-
-def hash(name):
- h = 0;
- for c in name:
- h = (h * prime_factor + ord(c)) & u32_mask
-
- return h
-
-opt_header = False
-opt_code = False
-
-if (sys.argv[1] == "header"):
- opt_header = True
- sys.argv.pop()
-elif (sys.argv[1] == "code"):
- opt_code = True
- sys.argv.pop()
-
-# Parse the entry points in the header
-
-i = 0
-for line in fileinput.input():
- m = p.match(line)
- if (m):
- if m.group(2) == 'VoidFunction':
- continue
- fullname = "vk" + m.group(2)
- h = hash(fullname)
- entrypoints.append((m.group(1), m.group(2), m.group(3), i, h))
- i = i + 1
-
-# For outputting entrypoints.h we generate a anv_EntryPoint() prototype
-# per entry point.
-
-if opt_header:
- print "/* This file generated from vk_gen.py, don't edit directly. */\n"
-
- print "struct anv_dispatch_table {"
- print " union {"
- print " void *entrypoints[%d];" % len(entrypoints)
- print " struct {"
-
- for type, name, args, num, h in entrypoints:
- print " %s (*%s)%s;" % (type, name, args)
- print " };\n"
- print " };\n"
- print "};\n"
-
- print "void anv_set_dispatch_devinfo(const struct brw_device_info *info);\n"
-
- for type, name, args, num, h in entrypoints:
- print "%s anv_%s%s;" % (type, name, args)
- print "%s gen7_%s%s;" % (type, name, args)
- print "%s gen75_%s%s;" % (type, name, args)
- print "%s gen8_%s%s;" % (type, name, args)
- print "%s gen9_%s%s;" % (type, name, args)
- print "%s anv_validate_%s%s;" % (type, name, args)
- exit()
-
-
+LAYERS = [
+ 'anv',
+ 'gen7',
+ 'gen75',
+ 'gen8',
+ 'gen9',
+ 'gen10',
+ 'gen11',
+]
+
+TEMPLATE_H = Template("""\
+/* This file generated from ${filename}, don't edit directly. */
+
+struct anv_dispatch_table {
+ union {
+ void *entrypoints[${len(entrypoints)}];
+ struct {
+ % for e in entrypoints:
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ PFN_${e.name} ${e.name};
+#else
+ void *${e.name};
+# endif
+ % else:
+ PFN_${e.name} ${e.name};
+ % endif
+ % endfor
+ };
+ };
+};
-print """/*
+%for layer in LAYERS:
+extern const struct anv_dispatch_table ${layer}_dispatch_table;
+%endfor
+extern const struct anv_dispatch_table anv_tramp_dispatch_table;
+
+% for e in entrypoints:
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ % for layer in LAYERS:
+ ${e.return_type} ${e.prefixed_name(layer)}(${e.decl_params()});
+ % endfor
+ % if e.guard is not None:
+#endif // ${e.guard}
+ % endif
+% endfor
+""", output_encoding='utf-8')
+
+TEMPLATE_C = Template(u"""\
+/*
* Copyright © 2015 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* IN THE SOFTWARE.
*/
-/* DO NOT EDIT! This is a generated file. */
+/* This file generated from ${filename}, don't edit directly. */
#include "anv_private.h"
* store the index into this big string.
*/
-static const char strings[] ="""
+static const char strings[] =
+% for e in entrypoints:
+ "${e.name}\\0"
+% endfor
+;
-offsets = []
-i = 0;
-for type, name, args, num, h in entrypoints:
- print " \"vk%s\\0\"" % name
- offsets.append(i)
- i += 2 + len(name) + 1
-print """ ;
+static const struct anv_entrypoint entrypoints[] = {
+% for e in entrypoints:
+ [${e.num}] = { ${offsets[e.num]}, ${'{:0=#8x}'.format(e.get_c_hash())} }, /* ${e.name} */
+% endfor
+};
-/* Weak aliases for all potential validate functions. These will resolve to
+/* Weak aliases for all potential implementations. These will resolve to
* NULL if they're not defined, which lets the resolve_entrypoint() function
- * either pick a validate wrapper if available or just plug in the actual
- * entry point.
- */
-"""
-
-# Now generate the table of all entry points and their validation functions
-
-print "\nstatic const struct anv_entrypoint entrypoints[] = {"
-for type, name, args, num, h in entrypoints:
- print " { %5d, 0x%08x }," % (offsets[num], h)
-print "};\n"
-
-for layer in [ "anv", "validate", "gen7", "gen75", "gen8", "gen9" ]:
- for type, name, args, num, h in entrypoints:
- print "%s %s_%s%s __attribute__ ((weak));" % (type, layer, name, args)
- print "\nconst struct anv_dispatch_table %s_layer = {" % layer
- for type, name, args, num, h in entrypoints:
- print " .%s = %s_%s," % (name, layer, name)
- print "};\n"
-
-print """
-#ifdef DEBUG
-static bool enable_validate = true;
-#else
-static bool enable_validate = false;
-#endif
-
-/* We can't use symbols that need resolving (like, oh, getenv) in the resolve
- * function. This means that we have to determine whether or not to use the
- * validation layer sometime before that. The constructor function attribute asks
- * the dynamic linker to invoke determine_validate() at dlopen() time which
- * works.
+ * either pick the correct entry point.
*/
-static void __attribute__ ((constructor))
-determine_validate(void)
-{
- const char *s = getenv("ANV_VALIDATE");
- if (s)
- enable_validate = atoi(s);
-}
+% for layer in LAYERS:
+ % for e in entrypoints:
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ ${e.return_type} ${e.prefixed_name(layer)}(${e.decl_params()}) __attribute__ ((weak));
+ % if e.guard is not None:
+#endif // ${e.guard}
+ % endif
+ % endfor
+
+ const struct anv_dispatch_table ${layer}_dispatch_table = {
+ % for e in entrypoints:
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ .${e.name} = ${e.prefixed_name(layer)},
+ % if e.guard is not None:
+#endif // ${e.guard}
+ % endif
+ % endfor
+ };
+% endfor
+
+
+/** Trampoline entrypoints for all device functions */
+
+% for e in entrypoints:
+ % if e.params[0].type not in ('VkDevice', 'VkCommandBuffer'):
+ <% continue %>
+ % endif
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ static ${e.return_type}
+ ${e.prefixed_name('anv_tramp')}(${e.decl_params()})
+ {
+ % if e.params[0].type == 'VkDevice':
+ ANV_FROM_HANDLE(anv_device, anv_device, ${e.params[0].name});
+ return anv_device->dispatch.${e.name}(${e.call_params()});
+ % else:
+ ANV_FROM_HANDLE(anv_cmd_buffer, anv_cmd_buffer, ${e.params[0].name});
+ return anv_cmd_buffer->device->dispatch.${e.name}(${e.call_params()});
+ % endif
+ }
+ % if e.guard is not None:
+#endif // ${e.guard}
+ % endif
+% endfor
+
+const struct anv_dispatch_table anv_tramp_dispatch_table = {
+% for e in entrypoints:
+ % if e.params[0].type not in ('VkDevice', 'VkCommandBuffer'):
+ <% continue %>
+ % endif
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ .${e.name} = ${e.prefixed_name('anv_tramp')},
+ % if e.guard is not None:
+#endif // ${e.guard}
+ % endif
+% endfor
+};
-static const struct brw_device_info *dispatch_devinfo;
-void
-anv_set_dispatch_devinfo(const struct brw_device_info *devinfo)
+/** Return true if the core version or extension in which the given entrypoint
+ * is defined is enabled.
+ *
+ * If device is NULL, all device extensions are considered enabled.
+ */
+bool
+anv_entrypoint_is_enabled(int index, uint32_t core_version,
+ const struct anv_instance_extension_table *instance,
+ const struct anv_device_extension_table *device)
{
- dispatch_devinfo = devinfo;
+ switch (index) {
+% for e in entrypoints:
+ case ${e.num}:
+ % if e.core_version:
+ return ${e.core_version.c_vk_version()} <= core_version;
+ % elif e.extension:
+ % if e.extension.type == 'instance':
+ return !device && instance->${e.extension.name[3:]};
+ % else:
+ return !device || device->${e.extension.name[3:]};
+ % endif
+ % else:
+ return true;
+ % endif
+% endfor
+ default:
+ return false;
+ }
}
-void * __attribute__ ((noinline))
-anv_resolve_entrypoint(uint32_t index)
+static void * __attribute__ ((noinline))
+anv_resolve_entrypoint(const struct gen_device_info *devinfo, uint32_t index)
{
- if (enable_validate && validate_layer.entrypoints[index])
- return validate_layer.entrypoints[index];
-
- if (dispatch_devinfo == NULL) {
- return anv_layer.entrypoints[index];
+ if (devinfo == NULL) {
+ return anv_dispatch_table.entrypoints[index];
}
- switch (dispatch_devinfo->gen) {
+ const struct anv_dispatch_table *genX_table;
+ switch (devinfo->gen) {
+ case 11:
+ genX_table = &gen11_dispatch_table;
+ break;
+ case 10:
+ genX_table = &gen10_dispatch_table;
+ break;
case 9:
- if (gen9_layer.entrypoints[index])
- return gen9_layer.entrypoints[index];
- /* fall through */
+ genX_table = &gen9_dispatch_table;
+ break;
case 8:
- if (gen8_layer.entrypoints[index])
- return gen8_layer.entrypoints[index];
- /* fall through */
+ genX_table = &gen8_dispatch_table;
+ break;
case 7:
- if (dispatch_devinfo->is_haswell && gen75_layer.entrypoints[index])
- return gen75_layer.entrypoints[index];
-
- if (gen7_layer.entrypoints[index])
- return gen7_layer.entrypoints[index];
- /* fall through */
- case 0:
- return anv_layer.entrypoints[index];
+ if (devinfo->is_haswell)
+ genX_table = &gen75_dispatch_table;
+ else
+ genX_table = &gen7_dispatch_table;
+ break;
default:
unreachable("unsupported gen\\n");
}
+
+ if (genX_table->entrypoints[index])
+ return genX_table->entrypoints[index];
+ else
+ return anv_dispatch_table.entrypoints[index];
}
-"""
-
-# Now output ifuncs and their resolve helpers for all entry points. The
-# resolve helper calls resolve_entrypoint() with the entry point index, which
-# lets the resolver look it up in the table.
-
-for type, name, args, num, h in entrypoints:
- print "static void *resolve_%s(void) { return anv_resolve_entrypoint(%d); }" % (name, num)
- print "%s vk%s%s\n __attribute__ ((ifunc (\"resolve_%s\"), visibility (\"default\")));\n" % (type, name, args, name)
-
-
-# Now generate the hash table used for entry point look up. This is a
-# uint16_t table of entry point indices. We use 0xffff to indicate an entry
-# in the hash table is empty.
-
-map = [none for f in xrange(hash_size)]
-collisions = [0 for f in xrange(10)]
-for type, name, args, num, h in entrypoints:
- level = 0
- while map[h & hash_mask] != none:
- h = h + prime_step
- level = level + 1
- if level > 9:
- collisions[9] += 1
- else:
- collisions[level] += 1
- map[h & hash_mask] = num
-
-print "/* Hash table stats:"
-print " * size %d entries" % hash_size
-print " * collisions entries"
-for i in xrange(10):
- if (i == 9):
- plus = "+"
- else:
- plus = " "
-
- print " * %2d%s %4d" % (i, plus, collisions[i])
-print " */\n"
-
-print "#define none 0x%04x\n" % none
-
-print "static const uint16_t map[] = {"
-for i in xrange(0, hash_size, 8):
- print " ",
- for j in xrange(i, i + 8):
- if map[j] & 0xffff == 0xffff:
- print " none,",
- else:
- print "0x%04x," % (map[j] & 0xffff),
- print
-print "};"
+/* Hash table stats:
+ * size ${hash_size} entries
+ * collisions entries:
+% for i in xrange(10):
+ * ${i}${'+' if i == 9 else ''} ${collisions[i]}
+% endfor
+ */
-# Finally we generate the hash table lookup function. The hash function and
-# linear probing algorithm matches the hash table generated above.
+#define none ${'{:#x}'.format(none)}
+static const uint16_t map[] = {
+% for i in xrange(0, hash_size, 8):
+ % for j in xrange(i, i + 8):
+ ## This is 6 because the 0x is counted in the length
+ % if mapping[j] & 0xffff == 0xffff:
+ none,
+ % else:
+ ${'{:0=#6x}'.format(mapping[j] & 0xffff)},
+ % endif
+ % endfor
+% endfor
+};
-print """
-void *
-anv_lookup_entrypoint(const char *name)
+int
+anv_get_entrypoint_index(const char *name)
{
- static const uint32_t prime_factor = %d;
- static const uint32_t prime_step = %d;
+ static const uint32_t prime_factor = ${prime_factor};
+ static const uint32_t prime_step = ${prime_step};
const struct anv_entrypoint *e;
uint32_t hash, h, i;
const char *p;
h = hash;
do {
- i = map[h & %d];
+ i = map[h & ${hash_mask}];
if (i == none)
- return NULL;
+ return -1;
e = &entrypoints[i];
h += prime_step;
} while (e->hash != hash);
if (strcmp(name, strings + e->name) != 0)
- return NULL;
+ return -1;
- return anv_resolve_entrypoint(i);
+ return i;
}
-""" % (prime_factor, prime_step, hash_mask)
+
+void *
+anv_lookup_entrypoint(const struct gen_device_info *devinfo, const char *name)
+{
+ int idx = anv_get_entrypoint_index(name);
+ if (idx < 0)
+ return NULL;
+ return anv_resolve_entrypoint(devinfo, idx);
+}""", output_encoding='utf-8')
+
+NONE = 0xffff
+HASH_SIZE = 256
+U32_MASK = 2**32 - 1
+HASH_MASK = HASH_SIZE - 1
+
+PRIME_FACTOR = 5024183
+PRIME_STEP = 19
+
+
+def cal_hash(name):
+ """Calculate the same hash value that Mesa will calculate in C."""
+ return functools.reduce(
+ lambda h, c: (h * PRIME_FACTOR + ord(c)) & U32_MASK, name, 0)
+
+EntrypointParam = namedtuple('EntrypointParam', 'type name decl')
+
+class Entrypoint(object):
+ def __init__(self, name, return_type, params, guard = None):
+ self.name = name
+ self.return_type = return_type
+ self.params = params
+ self.guard = guard
+ self.enabled = False
+ self.num = None
+ # Extensions which require this entrypoint
+ self.core_version = None
+ self.extension = None
+
+ def prefixed_name(self, prefix):
+ assert self.name.startswith('vk')
+ return prefix + '_' + self.name[2:]
+
+ def decl_params(self):
+ return ', '.join(p.decl for p in self.params)
+
+ def call_params(self):
+ return ', '.join(p.name for p in self.params)
+
+ def get_c_hash(self):
+ return cal_hash(self.name)
+
+def get_entrypoints(doc, entrypoints_to_defines, start_index):
+ """Extract the entry points from the registry."""
+ entrypoints = OrderedDict()
+
+ for command in doc.findall('./commands/command'):
+ ret_type = command.find('./proto/type').text
+ fullname = command.find('./proto/name').text
+ params = [EntrypointParam(
+ type = p.find('./type').text,
+ name = p.find('./name').text,
+ decl = ''.join(p.itertext())
+ ) for p in command.findall('./param')]
+ guard = entrypoints_to_defines.get(fullname)
+ # They really need to be unique
+ assert fullname not in entrypoints
+ entrypoints[fullname] = Entrypoint(fullname, ret_type, params, guard)
+
+ enabled_commands = set()
+ for feature in doc.findall('./feature'):
+ assert feature.attrib['api'] == 'vulkan'
+ version = VkVersion(feature.attrib['number'])
+ if version > MAX_API_VERSION:
+ continue
+
+ for command in feature.findall('./require/command'):
+ e = entrypoints[command.attrib['name']]
+ e.enabled = True
+ assert e.core_version is None
+ e.core_version = version
+
+ supported_exts = dict((ext.name, ext) for ext in EXTENSIONS)
+ for extension in doc.findall('.extensions/extension'):
+ ext_name = extension.attrib['name']
+ if ext_name not in supported_exts:
+ continue
+
+ if extension.attrib['supported'] != 'vulkan':
+ continue
+
+ ext = supported_exts[ext_name]
+ ext.type = extension.attrib['type']
+
+ for command in extension.findall('./require/command'):
+ e = entrypoints[command.attrib['name']]
+ e.enabled = True
+ assert e.core_version is None
+ assert e.extension is None
+ e.extension = ext
+
+ return [e for e in entrypoints.itervalues() if e.enabled]
+
+
+def get_entrypoints_defines(doc):
+ """Maps entry points to extension defines."""
+ entrypoints_to_defines = {}
+
+ for extension in doc.findall('./extensions/extension[@protect]'):
+ define = extension.attrib['protect']
+
+ for entrypoint in extension.findall('./require/command'):
+ fullname = entrypoint.attrib['name']
+ entrypoints_to_defines[fullname] = define
+
+ return entrypoints_to_defines
+
+
+def gen_code(entrypoints):
+ """Generate the C code."""
+ i = 0
+ offsets = []
+ for e in entrypoints:
+ offsets.append(i)
+ i += len(e.name) + 1
+
+ mapping = [NONE] * HASH_SIZE
+ collisions = [0] * 10
+ for e in entrypoints:
+ level = 0
+ h = e.get_c_hash()
+ while mapping[h & HASH_MASK] != NONE:
+ h = h + PRIME_STEP
+ level = level + 1
+ if level > 9:
+ collisions[9] += 1
+ else:
+ collisions[level] += 1
+ mapping[h & HASH_MASK] = e.num
+
+ return TEMPLATE_C.render(entrypoints=entrypoints,
+ LAYERS=LAYERS,
+ offsets=offsets,
+ collisions=collisions,
+ mapping=mapping,
+ hash_mask=HASH_MASK,
+ prime_step=PRIME_STEP,
+ prime_factor=PRIME_FACTOR,
+ none=NONE,
+ hash_size=HASH_SIZE,
+ filename=os.path.basename(__file__))
+
+
+def main():
+ parser = argparse.ArgumentParser()
+ parser.add_argument('--outdir', help='Where to write the files.',
+ required=True)
+ parser.add_argument('--xml',
+ help='Vulkan API XML file.',
+ required=True,
+ action='append',
+ dest='xml_files')
+ args = parser.parse_args()
+
+ entrypoints = []
+
+ for filename in args.xml_files:
+ doc = et.parse(filename)
+ entrypoints += get_entrypoints(doc, get_entrypoints_defines(doc),
+ start_index=len(entrypoints))
+
+ # Manually add CreateDmaBufImageINTEL for which we don't have an extension
+ # defined.
+ entrypoints.append(Entrypoint('vkCreateDmaBufImageINTEL', 'VkResult', [
+ EntrypointParam('VkDevice', 'device', 'VkDevice device'),
+ EntrypointParam('VkDmaBufImageCreateInfo', 'pCreateInfo',
+ 'const VkDmaBufImageCreateInfo* pCreateInfo'),
+ EntrypointParam('VkAllocationCallbacks', 'pAllocator',
+ 'const VkAllocationCallbacks* pAllocator'),
+ EntrypointParam('VkDeviceMemory', 'pMem', 'VkDeviceMemory* pMem'),
+ EntrypointParam('VkImage', 'pImage', 'VkImage* pImage')
+ ]))
+
+ for num, e in enumerate(entrypoints):
+ e.num = num
+
+ # For outputting entrypoints.h we generate a anv_EntryPoint() prototype
+ # per entry point.
+ try:
+ with open(os.path.join(args.outdir, 'anv_entrypoints.h'), 'wb') as f:
+ f.write(TEMPLATE_H.render(entrypoints=entrypoints,
+ LAYERS=LAYERS,
+ filename=os.path.basename(__file__)))
+ with open(os.path.join(args.outdir, 'anv_entrypoints.c'), 'wb') as f:
+ f.write(gen_code(entrypoints))
+ except Exception:
+ # In the even 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()
projects / mesa.git / blobdiff