X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=src%2Fintel%2Fvulkan%2Fanv_entrypoints_gen.py;h=1a7d75309c478f30d1aa5a275e4bfa1fcb1a995f;hb=c964f0e485dc8cb901a54bf40f1d69f503ac0a0a;hp=cedecfeac702323ed0340a450958039c87ec647f;hpb=2c3f95d6aaab38cd66dd3dee1b089d5c91928eea;p=mesa.git diff --git a/src/intel/vulkan/anv_entrypoints_gen.py b/src/intel/vulkan/anv_entrypoints_gen.py index cedecfeac70..1a7d75309c4 100644 --- a/src/intel/vulkan/anv_entrypoints_gen.py +++ b/src/intel/vulkan/anv_entrypoints_gen.py @@ -1,6 +1,6 @@ # 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"), @@ -22,302 +22,361 @@ # IN THE SOFTWARE. # -import fileinput, re, sys - -# Each function typedef in the vulkan.h header is all on one line and matches -# this regepx. We hope that won't change. - -p = re.compile('typedef ([^ ]*) *\((?:VKAPI_PTR)? *\*PFN_vk([^(]*)\)(.*);') - -entrypoints = [] +import argparse +import functools +import os +import textwrap +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_incremental_present', + '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 +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 + }; + }; + }; + + % 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 + """), output_encoding='utf-8') + +TEMPLATE_C = Template(textwrap.dedent(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 _, name, _, _, _, _ in entrypoints: + "vk${name}\\0" + % endfor + ; + + static const struct anv_entrypoint entrypoints[] = { + % for _, _, _, num, h, _ in entrypoints: + { ${offsets[num]}, ${'{:0=#8x}'.format(h)} }, + % 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']: + % for type_, name, args, _, _, guard in entrypoints: + % if guard is not None: + #ifdef ${guard} + % endif + ${type_} ${layer}_${name}(${args}) __attribute__ ((weak)); + % if guard is not None: + #endif // ${guard} + % endif + % endfor + + const struct anv_dispatch_table ${layer}_layer = { + % for _, name, args, _, _, guard in entrypoints: + % if guard is not None: + #ifdef ${guard} + % endif + .${name} = ${layer}_${name}, + % if guard is not None: + #endif // ${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]; + } + + 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"); + } + } + + /* 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 +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) + + +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']) -prime_factor = 5024183 -prime_step = 19 + for extension in doc.findall('.extensions/extension'): + if extension.attrib['name'] not in SUPPORTED_EXTENSIONS: + continue -def hash(name): - h = 0; - for c in name: - h = (h * prime_factor + ord(c)) & u32_mask + assert extension.attrib['supported'] == 'vulkan' + for command in extension.findall('./require/command'): + enabled_commands.add(command.attrib['name']) - return h + index = 0 + for command in doc.findall('./commands/command'): + type = command.find('./proto/type').text + fullname = command.find('./proto/name').text -opt_header = False -opt_code = False + if fullname not in enabled_commands: + continue -if (sys.argv[1] == "header"): - opt_header = True - sys.argv.pop() -elif (sys.argv[1] == "code"): - opt_code = True - sys.argv.pop() + shortname = fullname[2:] + params = (''.join(p.itertext()) for p in command.findall('./param')) + params = ', '.join(params) + guard = entrypoints_to_defines.get(fullname) + entrypoints.append((type, shortname, params, index, cal_hash(fullname), guard)) + index += 1 -# Parse the entry points in the header + return entrypoints -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() - - - -print """/* - * 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 in entrypoints: - print " \"vk%s\\0\"" % name - offsets.append(i) - i += 2 + len(name) + 1 -print """ ; - -/* Weak aliases for all potential validate functions. 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. - */ -static void __attribute__ ((constructor)) -determine_validate(void) -{ - const char *s = getenv("ANV_VALIDATE"); - - if (s) - enable_validate = atoi(s); -} - -static const struct brw_device_info *dispatch_devinfo; - -void -anv_set_dispatch_devinfo(const struct brw_device_info *devinfo) -{ - dispatch_devinfo = devinfo; -} - -void * __attribute__ ((noinline)) -anv_resolve_entrypoint(uint32_t index) -{ - if (enable_validate && validate_layer.entrypoints[index]) - return validate_layer.entrypoints[index]; - - if (dispatch_devinfo == NULL) { - return anv_layer.entrypoints[index]; - } - - switch (dispatch_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 (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]; - default: - unreachable("unsupported gen\\n"); - } -} -""" - -# 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,", + +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 _, name, _, _, _, _ in entrypoints: + offsets.append(i) + i += 2 + len(name) + 1 + + mapping = [NONE] * HASH_SIZE + collisions = [0] * 10 + for _, name, _, num, h, _ in entrypoints: + level = 0 + while mapping[h & HASH_MASK] != NONE: + h = h + PRIME_STEP + level = level + 1 + if level > 9: + collisions[9] += 1 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 """ -void * -anv_lookup_entrypoint(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(i); -} -""" % (prime_factor, prime_step, hash_mask) + collisions[level] += 1 + mapping[h & HASH_MASK] = 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('--outdir', help='Where to write the files.', + required=True) + parser.add_argument('--xml', help='Vulkan API XML file.', required=True) + 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), + cal_hash('vkCreateDmaBufImageINTEL'), None)) + + # For outputting entrypoints.h we generate a anv_EntryPoint() prototype + # per entry point. + 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)) + + +if __name__ == '__main__': + main()