src/mesa/main/get_hash_generator.py

   1 #!/usr/bin/python2
   2 # coding=utf-8
   3 # -*- Mode: Python; py-indent-offset: 4 -*-
   4 #
   5 # Copyright © 2012 Intel Corporation
   6 #
   7 # Based on code by Kristian Høgsberg <krh@bitplanet.net>,
   8 #   extracted from mesa/main/get.c
   9 #
  10 # Permission is hereby granted, free of charge, to any person obtaining a
  11 # copy of this software and associated documentation files (the "Software"),
  12 # to deal in the Software without restriction, including without limitation
  13 # on the rights to use, copy, modify, merge, publish, distribute, sub
  14 # license, and/or sell copies of the Software, and to permit persons to whom
  15 # the Software is furnished to do so, subject to the following conditions:
  16 #
  17 # The above copyright notice and this permission notice (including the next
  18 # paragraph) shall be included in all copies or substantial portions of the
  19 # Software.
  20 #
  21 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23 # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.  IN NO EVENT SHALL
  24 # IBM AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  26 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  27 # IN THE SOFTWARE.
  28
  29 # Generate a C header file containing hash tables of glGet parameter
  30 # names for each GL API. The generated file is to be included by glGet.c
  31
  32 import os, sys, imp, getopt
  33 from collections import defaultdict
  34 import get_hash_params
  35
  36 cur_dir = os.path.dirname(sys.argv[0])
  37 param_desc_file = "%s/get_hash_params.py" % cur_dir
  38
  39 GLAPI = "%s/../../mapi/glapi/gen" % cur_dir
  40 sys.path.append(GLAPI)
  41 import gl_XML
  42
  43 prime_factor = 89
  44 prime_step = 281
  45 hash_table_size = 1024
  46
  47 gl_apis=set(["GL", "GL_CORE", "GLES", "GLES2"])
  48
  49 def print_header():
  50    print "typedef const unsigned short table_t[%d];\n" % (hash_table_size)
  51    print "static const int prime_factor = %d, prime_step = %d;\n" % \
  52           (prime_factor, prime_step)
  53
  54 def print_params(params):
  55    print "static struct value_desc values[] = {"
  56    for p in params:
  57       print "    { %s, %s }," % (p[0], p[1])
  58
  59    print "};\n"
  60
  61 def api_name(api):
  62    return "API_OPEN%s" % api
  63
  64 # This must match gl_api enum in src/mesa/main/mtypes.h
  65 api_enum = [
  66    'GL',
  67    'GLES',
  68    'GLES2',
  69    'GL_CORE',
  70 ]
  71
  72 def api_index(api):
  73     return api_enum.index(api)
  74
  75 def table_name(api):
  76    return "table_" + api_name(api)
  77
  78 def print_table(api, table):
  79    print "static table_t %s = {" % (table_name(api))
  80
  81    # convert sparse (index, value) table into a dense table
  82    dense_table = [0] * hash_table_size
  83    for i, v in table:
  84       dense_table[i] = v
  85
  86    row_size = 4
  87    for i in range(0, hash_table_size, row_size):
  88       row = dense_table[i : i + row_size]
  89       idx_val = ["%4d" % v for v in row]
  90       print " " * 4 + ", ".join(idx_val) + ","
  91
  92    print "};\n"
  93
  94 def print_tables(tables):
  95    for table in tables:
  96       print_table(table["apis"][0], table["indices"])
  97
  98    dense_tables = ['NULL'] * len(api_enum)
  99    for table in tables:
 100       tname = table_name(table["apis"][0])
 101       for api in table["apis"]:
 102          i = api_index(api)
 103          dense_tables[i] = "&%s" % (tname)
 104
 105    print "static table_t *table_set[] = {"
 106    for expr in dense_tables:
 107       print "   %s," % expr
 108    print "};\n"
 109
 110    print "#define table(api) (*table_set[api])"
 111
 112 # Merge tables with matching parameter lists (i.e. GL and GL_CORE)
 113 def merge_tables(tables):
 114    merged_tables = []
 115    for api, indices in sorted(tables.items()):
 116       matching_table = filter(lambda mt:mt["indices"] == indices,
 117                               merged_tables)
 118       if matching_table:
 119          matching_table[0]["apis"].append(api)
 120       else:
 121          merged_tables.append({"apis": [api], "indices": indices})
 122
 123    return merged_tables
 124
 125 def add_to_hash_table(table, hash_val, value):
 126    while True:
 127       index = hash_val & (hash_table_size - 1)
 128       if index not in table:
 129          table[index] = value
 130          break
 131       hash_val += prime_step
 132
 133 def die(msg):
 134    sys.stderr.write("%s: %s\n" % (program, msg))
 135    exit(1)
 136
 137 program = os.path.basename(sys.argv[0])
 138
 139 def generate_hash_tables(enum_list, enabled_apis, param_descriptors):
 140    tables = defaultdict(lambda:{})
 141
 142    # the first entry should be invalid, so that get.c:find_value can use
 143    # its index for the 'enum not found' condition.
 144    params = [[0, ""]]
 145
 146    for param_block in param_descriptors:
 147       if set(["apis", "params"]) != set(param_block):
 148          die("missing fields (%s) in param descriptor file (%s)" %
 149                (", ".join(set(["apis", "params"]) - set(param_block)),
 150                 param_desc_file))
 151
 152       valid_apis = set(param_block["apis"])
 153       if valid_apis - gl_apis:
 154          die("unknown API(s) in param descriptor file (%s): %s\n" %
 155                (param_desc_file, ",".join(valid_apis - gl_apis)))
 156
 157       if not (valid_apis & enabled_apis):
 158          continue
 159
 160       valid_apis &= enabled_apis
 161
 162       for param in param_block["params"]:
 163          enum_name = param[0]
 164          enum_val = enum_list[enum_name].value
 165          hash_val = enum_val * prime_factor
 166
 167          for api in valid_apis:
 168             add_to_hash_table(tables[api], hash_val, len(params))
 169
 170          params.append(["GL_" + enum_name, param[1]])
 171
 172    sorted_tables={}
 173    for api, indices in tables.items():
 174       sorted_tables[api] = sorted(indices.items())
 175
 176    return params, merge_tables(sorted_tables)
 177
 178 def opt_to_apis(feature):
 179    _map = {"ES1": "GLES", "ES2": "GLES2", "GL": "GL"}
 180    if feature not in _map:
 181       return None
 182
 183    apis = set([_map[feature]])
 184    if "GL" in apis:
 185       apis.add("GL_CORE")
 186
 187    return apis
 188
 189 def show_usage():
 190    sys.stderr.write(
 191 """Usage: %s [OPTIONS]
 192   -f <file>          specify GL API XML file
 193   -a [GL|ES1|ES2]    specify APIs to generate hash tables for
 194 """ % (program))
 195    exit(1)
 196
 197 if __name__ == '__main__':
 198    try:
 199       (opts, args) = getopt.getopt(sys.argv[1:], "f:a:")
 200    except Exception,e:
 201       show_usage()
 202
 203    if len(args) != 0:
 204       show_usage()
 205
 206    enabled_apis = set([])
 207    api_desc_file = ""
 208
 209    for opt_name, opt_val in opts:
 210       if opt_name == "-f":
 211          api_desc_file = opt_val
 212       if opt_name == "-a":
 213          apis = opt_to_apis(opt_val.upper())
 214          if not apis:
 215             die("invalid API %s\n" % opt_val)
 216
 217          enabled_apis |= apis
 218
 219    if not api_desc_file:
 220       die("missing descriptor file (-f)\n")
 221
 222    if len(enabled_apis) == 0:
 223       die("need at least a single enabled API\n")
 224
 225    try:
 226       api_desc = gl_XML.parse_GL_API(api_desc_file)
 227    except Exception:
 228       die("couldn't parse API specification file %s\n" % api_desc_file)
 229
 230    (params, hash_tables) = generate_hash_tables(api_desc.enums_by_name,
 231                               enabled_apis, get_hash_params.descriptor)
 232
 233    print_header()
 234    print_params(params)
 235    print_tables(hash_tables)