#
import argparse
+import functools
import os
-import textwrap
-import xml.etree.ElementTree as et
+import xml.etree.cElementTree as et
from mako.template import Template
-MAX_API_VERSION = 1.0
-
-SUPPORTED_EXTENSIONS = [
- 'VK_KHR_descriptor_update_template',
- 'VK_KHR_get_physical_device_properties2',
- 'VK_KHR_maintenance1',
- 'VK_KHR_push_descriptor',
- 'VK_KHR_sampler_mirror_clamp_to_edge',
- 'VK_KHR_shader_draw_parameters',
- 'VK_KHR_surface',
- 'VK_KHR_swapchain',
- 'VK_KHR_wayland_surface',
- 'VK_KHR_xcb_surface',
- 'VK_KHR_xlib_surface',
-]
+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.
-TEMPLATE_H = Template(textwrap.dedent("""\
- /* This file generated from ${filename}, don't edit directly. */
-
- struct anv_dispatch_table {
- union {
- void *entrypoints[${len(entrypoints)}];
- struct {
- % for _, name, _, _, _, guard in entrypoints:
- % if guard is not None:
- #ifdef ${guard}
- PFN_vk${name} ${name};
- #else
- void *${name};
- # endif
- % else:
- PFN_vk${name} ${name};
- % endif
- % endfor
- };
- };
- };
-
- void anv_set_dispatch_devinfo(const struct gen_device_info *info);
- % for type_, name, args, num, h, guard in entrypoints:
- % if guard is not None:
- #ifdef ${guard}
- % endif
- ${type_} anv_${name}(${args});
- ${type_} gen7_${name}(${args});
- ${type_} gen75_${name}(${args});
- ${type_} gen8_${name}(${args});
- ${type_} gen9_${name}(${args});
- % if guard is not None:
- #endif // ${guard}
- % endif
- % endfor
- """))
+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
+ };
+ };
+};
+
+% for e in entrypoints:
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ ${e.return_type} ${e.prefixed_name('anv')}(${e.params});
+ ${e.return_type} ${e.prefixed_name('gen7')}(${e.params});
+ ${e.return_type} ${e.prefixed_name('gen75')}(${e.params});
+ ${e.return_type} ${e.prefixed_name('gen8')}(${e.params});
+ ${e.return_type} ${e.prefixed_name('gen9')}(${e.params});
+ ${e.return_type} ${e.prefixed_name('gen10')}(${e.params});
+ % 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
+ * 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.
+ */
+
+/* This file generated from ${filename}, don't edit directly. */
+
+#include "anv_private.h"
+
+struct anv_entrypoint {
+ uint32_t name;
+ uint32_t hash;
+};
+
+/* We use a big string constant to avoid lots of reloctions from the entry
+ * point table to lots of little strings. The entries in the entry point table
+ * store the index into this big string.
+ */
+
+static const char strings[] =
+% for e in entrypoints:
+ "${e.name}\\0"
+% endfor
+;
+
+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 implementations. These will resolve to
+ * NULL if they're not defined, which lets the resolve_entrypoint() function
+ * either pick the correct entry point.
+ */
+
+% for layer in ['anv', 'gen7', 'gen75', 'gen8', 'gen9', 'gen10']:
+ % for e in entrypoints:
+ % if e.guard is not None:
+#ifdef ${e.guard}
+ % endif
+ ${e.return_type} ${e.prefixed_name(layer)}(${e.params}) __attribute__ ((weak));
+ % if e.guard is not None:
+#endif // ${e.guard}
+ % endif
+ % endfor
+
+ const struct anv_dispatch_table ${layer}_layer = {
+ % 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
+
+static void * __attribute__ ((noinline))
+anv_resolve_entrypoint(const struct gen_device_info *devinfo, uint32_t index)
+{
+ if (devinfo == NULL) {
+ return anv_layer.entrypoints[index];
+ }
+
+ const struct anv_dispatch_table *genX_table;
+ switch (devinfo->gen) {
+ case 10:
+ genX_table = &gen10_layer;
+ break;
+ case 9:
+ genX_table = &gen9_layer;
+ break;
+ case 8:
+ genX_table = &gen8_layer;
+ break;
+ case 7:
+ if (devinfo->is_haswell)
+ genX_table = &gen75_layer;
+ else
+ genX_table = &gen7_layer;
+ break;
+ default:
+ unreachable("unsupported gen\\n");
+ }
+
+ if (genX_table->entrypoints[index])
+ return genX_table->entrypoints[index];
+ else
+ return anv_layer.entrypoints[index];
+}
+
+/* Hash table stats:
+ * size ${hash_size} entries
+ * collisions entries:
+% for i in xrange(10):
+ * ${i}${'+' if i == 9 else ''} ${collisions[i]}
+% endfor
+ */
+
+#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
+};
+
+void *
+anv_lookup_entrypoint(const struct gen_device_info *devinfo, const char *name)
+{
+ 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;
+
+ hash = 0;
+ for (p = name; *p; p++)
+ hash = hash * prime_factor + *p;
+
+ h = hash;
+ do {
+ i = map[h & ${hash_mask}];
+ if (i == none)
+ return NULL;
+ e = &entrypoints[i];
+ h += prime_step;
+ } while (e->hash != hash);
+
+ if (strcmp(name, strings + e->name) != 0)
+ return NULL;
+
+ return anv_resolve_entrypoint(devinfo, i);
+}""", output_encoding='utf-8')
NONE = 0xffff
HASH_SIZE = 256
PRIME_FACTOR = 5024183
PRIME_STEP = 19
-opt_header = False
-opt_code = False
+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)
-def hash(name):
- h = 0
- for c in name:
- h = (h * PRIME_FACTOR + ord(c)) & U32_MASK
+class Entrypoint(object):
+ def __init__(self, name, return_type, params, guard = None):
+ self.name = name
+ self.return_type = return_type
+ self.params = ', '.join(params)
+ self.guard = guard
+ self.num = None
- return h
+ def prefixed_name(self, prefix):
+ assert self.name.startswith('vk')
+ return prefix + '_' + self.name[2:]
+ def get_c_hash(self):
+ return cal_hash(self.name)
-def print_guard_start(guard):
- if guard is not None:
- print "#ifdef {0}".format(guard)
-
-
-def print_guard_end(guard):
- if guard is not None:
- print "#endif // {0}".format(guard)
-
-
-def get_entrypoints(doc, entrypoints_to_defines):
+def get_entrypoints(doc, entrypoints_to_defines, start_index):
"""Extract the entry points from the registry."""
entrypoints = []
enabled_commands = set()
for feature in doc.findall('./feature'):
assert feature.attrib['api'] == 'vulkan'
- if float(feature.attrib['number']) > MAX_API_VERSION:
+ if VkVersion(feature.attrib['number']) > MAX_API_VERSION:
continue
for command in feature.findall('./require/command'):
enabled_commands.add(command.attrib['name'])
+ supported = set(ext.name for ext in EXTENSIONS)
for extension in doc.findall('.extensions/extension'):
- if extension.attrib['name'] not in SUPPORTED_EXTENSIONS:
+ if extension.attrib['name'] not in supported:
+ continue
+
+ if extension.attrib['supported'] != 'vulkan':
continue
- assert extension.attrib['supported'] == 'vulkan'
for command in extension.findall('./require/command'):
enabled_commands.add(command.attrib['name'])
- index = 0
for command in doc.findall('./commands/command'):
- type = command.find('./proto/type').text
+ ret_type = command.find('./proto/type').text
fullname = command.find('./proto/name').text
if fullname not in enabled_commands:
continue
- shortname = fullname[2:]
params = (''.join(p.itertext()) for p in command.findall('./param'))
- params = ', '.join(params)
- if fullname in entrypoints_to_defines:
- guard = entrypoints_to_defines[fullname]
- else:
- guard = None
- entrypoints.append((type, shortname, params, index, hash(fullname), guard))
- index += 1
+ guard = entrypoints_to_defines.get(fullname)
+ entrypoints.append(Entrypoint(fullname, ret_type, params, guard))
return entrypoints
def get_entrypoints_defines(doc):
"""Maps entry points to extension defines."""
entrypoints_to_defines = {}
- extensions = doc.findall('./extensions/extension')
- for extension in extensions:
- define = extension.get('protect')
- entrypoints = extension.findall('./require/command')
- for entrypoint in entrypoints:
- fullname = entrypoint.get('name')
+
+ 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):
- print textwrap.dedent("""\
- /*
- * Copyright © 2015 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, 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.
- */
-
- /* This file generated from {}, don't edit directly. */
-
- #include "anv_private.h"
-
- struct anv_entrypoint {{
- uint32_t name;
- uint32_t hash;
- }};
-
- /* We use a big string constant to avoid lots of reloctions from the entry
- * point table to lots of little strings. The entries in the entry point table
- * store the index into this big string.
- */
-
- static const char strings[] =""".format(os.path.basename(__file__)))
-
- offsets = []
+ """Generate the C code."""
i = 0
- for type, name, args, num, h, guard in entrypoints:
- print " \"vk%s\\0\"" % name
+ offsets = []
+ for e in entrypoints:
offsets.append(i)
- i += 2 + len(name) + 1
- print " ;"
-
- # Now generate the table of all entry points
-
- print "\nstatic const struct anv_entrypoint entrypoints[] = {"
- for type, name, args, num, h, guard in entrypoints:
- print " { %5d, 0x%08x }," % (offsets[num], h)
- print "};\n"
-
- print textwrap.dedent("""
-
- /* Weak aliases for all potential implementations. These will resolve to
- * NULL if they're not defined, which lets the resolve_entrypoint() function
- * either pick the correct entry point.
- */
- """)
-
- for layer in ["anv", "gen7", "gen75", "gen8", "gen9"]:
- for type, name, args, num, h, guard in entrypoints:
- print_guard_start(guard)
- print "%s %s_%s(%s) __attribute__ ((weak));" % (type, layer, name, args)
- print_guard_end(guard)
- print "\nconst struct anv_dispatch_table %s_layer = {" % layer
- for type, name, args, num, h, guard in entrypoints:
- print_guard_start(guard)
- print " .%s = %s_%s," % (name, layer, name)
- print_guard_end(guard)
- print "};\n"
-
- print textwrap.dedent("""
- static void * __attribute__ ((noinline))
- anv_resolve_entrypoint(const struct gen_device_info *devinfo, uint32_t index)
- {
- if (devinfo == NULL) {
- return anv_layer.entrypoints[index];
- }
-
- switch (devinfo->gen) {
- case 9:
- if (gen9_layer.entrypoints[index])
- return gen9_layer.entrypoints[index];
- /* fall through */
- case 8:
- if (gen8_layer.entrypoints[index])
- return gen8_layer.entrypoints[index];
- /* fall through */
- case 7:
- if (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];
- default:
- unreachable("unsupported gen\\n");
- }
- }
- """)
-
- # 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] * HASH_SIZE
+ i += len(e.name) + 1
+
+ mapping = [NONE] * HASH_SIZE
collisions = [0] * 10
- for type, name, args, num, h, guard in entrypoints:
+ for e in entrypoints:
level = 0
- while map[h & HASH_MASK] != NONE:
+ 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
- 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 "};"
-
- # Finally we generate the hash table lookup function. The hash function and
- # linear probing algorithm matches the hash table generated above.
-
- print textwrap.dedent("""
- void *
- anv_lookup_entrypoint(const struct gen_device_info *devinfo, const char *name)
- {
- static const uint32_t prime_factor = %d;
- static const uint32_t prime_step = %d;
- const struct anv_entrypoint *e;
- uint32_t hash, h, i;
- const char *p;
-
- hash = 0;
- for (p = name; *p; p++)
- hash = hash * prime_factor + *p;
-
- h = hash;
- do {
- i = map[h & %d];
- if (i == none)
- return NULL;
- e = &entrypoints[i];
- h += prime_step;
- } while (e->hash != hash);
-
- if (strcmp(name, strings + e->name) != 0)
- return NULL;
-
- return anv_resolve_entrypoint(devinfo, i);
- }
- """) % (PRIME_FACTOR, PRIME_STEP, HASH_MASK)
+ mapping[h & HASH_MASK] = e.num
+
+ return TEMPLATE_C.render(entrypoints=entrypoints,
+ 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('target', choices=['header', 'code'],
- help='Which file to generate.')
- parser.add_argument('--xml', help='Vulkan API XML file.')
+ 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()
- doc = et.parse(args.xml)
- entrypoints = get_entrypoints(doc, get_entrypoints_defines(doc))
+ 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(('VkResult', 'CreateDmaBufImageINTEL',
- 'VkDevice device, ' +
- 'const VkDmaBufImageCreateInfo* pCreateInfo, ' +
- 'const VkAllocationCallbacks* pAllocator,' +
- 'VkDeviceMemory* pMem,' +
- 'VkImage* pImage', len(entrypoints),
- hash('vkCreateDmaBufImageINTEL'), None))
+ entrypoints.append(Entrypoint('vkCreateDmaBufImageINTEL', 'VkResult',
+ ['VkDevice device',
+ 'const VkDmaBufImageCreateInfo* pCreateInfo',
+ 'const VkAllocationCallbacks* pAllocator',
+ 'VkDeviceMemory* pMem',
+ 'VkImage* pImage']))
+
+ for num, e in enumerate(entrypoints):
+ e.num = num
# For outputting entrypoints.h we generate a anv_EntryPoint() prototype
# per entry point.
- if args.target == 'header':
- print TEMPLATE_H.render(entrypoints=entrypoints,
- filename=os.path.basename(__file__))
- else:
- gen_code(entrypoints)
+ try:
+ with open(os.path.join(args.outdir, 'anv_entrypoints.h'), 'wb') as f:
+ f.write(TEMPLATE_H.render(entrypoints=entrypoints,
+ 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__':