# coding=utf-8 # # 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"), # 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 textwrap import xml.etree.ElementTree as et 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', ] # 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 opt_header = False opt_code = False def hash(name): h = 0 for c in name: h = (h * PRIME_FACTOR + ord(c)) & U32_MASK return h 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): """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: continue for command in feature.findall('./require/command'): enabled_commands.add(command.attrib['name']) for extension in doc.findall('.extensions/extension'): if extension.attrib['name'] not in SUPPORTED_EXTENSIONS: 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 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 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') entrypoints_to_defines[fullname] = define return entrypoints_to_defines 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.') args = parser.parse_args() doc = et.parse(args.xml) entrypoints = get_entrypoints(doc, get_entrypoints_defines(doc)) # 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)) # For outputting entrypoints.h we generate a anv_EntryPoint() prototype # per entry point. if args.target == '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, guard in entrypoints: if guard is not None: print "#ifdef {0}".format(guard) print " PFN_vk{0} {0};".format(name) print "#else" print " void *{0};".format(name) print "#endif" else: print " PFN_vk{0} {0};".format(name) print " };\n" print " };\n" print "};\n" print "void anv_set_dispatch_devinfo(const struct gen_device_info *info);\n" for type, name, args, num, h, guard in entrypoints: print_guard_start(guard) 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_guard_end(guard) exit() 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. */ /* DO NOT EDIT! This is a generated file. */ #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[] =""") offsets = [] i = 0 for type, name, args, num, h, guard in entrypoints: print " \"vk%s\\0\"" % name 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 collisions = [0] * 10 for type, name, args, num, h, guard 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 "};" # 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) if __name__ == '__main__': main()