# coding=utf-8 # # 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. # 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 \*PFN_vk([^(]*)\)(.*);') entrypoints = [] # 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: for type, name, args, num, h in entrypoints: print "%s anv_%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; void *function; void *validate; }; /* 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. */ """ for type, name, args, num, h in entrypoints: print "%s anv_validate_%s%s __attribute__ ((weak));" % (type, name, args) # 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, anv_%s, anv_validate_%s }," % (offsets[num], h, name, 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 void * __attribute__ ((noinline)) resolve_entrypoint(uint32_t index) { if (enable_validate && entrypoints[index].validate) return entrypoints[index].validate; return entrypoints[index].function; } """ # 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 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 "};" # 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 resolve_entrypoint(i); } """ % (prime_factor, prime_step, hash_mask)