blob: 1bab885180dadf366139fc1dbed2bb8c1a612503 [file] [log] [blame]
# 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 functools
import os
import xml.etree.cElementTree as et
from collections import OrderedDict, namedtuple
from mako.template import Template
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.
LAYERS = [
'anv',
'gen7',
'gen75',
'gen8',
'gen9',
'gen10'
]
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 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
* 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 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
};
/** 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)
{
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 instance->${e.extension.name[3:]};
% else:
return !device || device->${e.extension.name[3:]};
% endif
% else:
return true;
% endif
% endfor
default:
return false;
}
}
static void * __attribute__ ((noinline))
anv_resolve_entrypoint(const struct gen_device_info *devinfo, uint32_t index)
{
if (devinfo == NULL) {
return anv_dispatch_table.entrypoints[index];
}
const struct anv_dispatch_table *genX_table;
switch (devinfo->gen) {
case 10:
genX_table = &gen10_dispatch_table;
break;
case 9:
genX_table = &gen9_dispatch_table;
break;
case 8:
genX_table = &gen8_dispatch_table;
break;
case 7:
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];
}
/* 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
};
int
anv_get_entrypoint_index(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 -1;
e = &entrypoints[i];
h += prime_step;
} while (e->hash != hash);
if (strcmp(name, strings + e->name) != 0)
return -1;
return i;
}
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()