src/intel/genxml/gen_bits_header.py

   1 #encoding=utf-8
   2 # Copyright © 2017 Intel Corporation
   3
   4 # Permission is hereby granted, free of charge, to any person obtaining a copy
   5 # of this software and associated documentation files (the "Software"), to deal
   6 # in the Software without restriction, including without limitation the rights
   7 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 # copies of the Software, and to permit persons to whom the Software is
   9 # furnished to do so, subject to the following conditions:
  10
  11 # The above copyright notice and this permission notice shall be included in
  12 # all copies or substantial portions of the Software.
  13
  14 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20 # SOFTWARE.
  21
  22 from __future__ import (
  23     absolute_import, division, print_function, unicode_literals
  24 )
  25
  26 import argparse
  27 import os
  28 import re
  29 import xml.parsers.expat
  30
  31 from mako.template import Template
  32
  33 TEMPLATE = Template("""\
  34 <%!
  35 from operator import itemgetter
  36 %>\
  37 /*
  38  * Copyright © 2017 Intel Corporation
  39  *
  40  * Permission is hereby granted, free of charge, to any person obtaining a
  41  * copy of this software and associated documentation files (the "Software"),
  42  * to deal in the Software without restriction, including without limitation
  43  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  44  * and/or sell copies of the Software, and to permit persons to whom the
  45  * Software is furnished to do so, subject to the following conditions:
  46  *
  47  * The above copyright notice and this permission notice (including the next
  48  * paragraph) shall be included in all copies or substantial portions of the
  49  * Software.
  50  *
  51  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  52  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  53  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  54  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  55  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  56  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  57  * IN THE SOFTWARE.
  58  */
  59
  60 /* THIS FILE HAS BEEN GENERATED, DO NOT HAND EDIT.
  61  *
  62  * Sizes of bitfields in genxml instructions, structures, and registers.
  63  */
  64
  65 #ifndef ${guard}
  66 #define ${guard}
  67
  68 #include <stdint.h>
  69
  70 #include "dev/gen_device_info.h"
  71 #include "util/macros.h"
  72
  73 <%def name="emit_per_gen_prop_func(item, prop)">
  74 %if item.has_prop(prop):
  75 % for gen, value in sorted(item.iter_prop(prop), reverse=True):
  76 #define ${gen.prefix(item.token_name)}_${prop}  ${value}
  77 % endfor
  78
  79 static inline uint32_t ATTRIBUTE_PURE
  80 ${item.token_name}_${prop}(const struct gen_device_info *devinfo)
  81 {
  82    switch (devinfo->gen) {
  83    case 11: return ${item.get_prop(prop, 11)};
  84    case 10: return ${item.get_prop(prop, 10)};
  85    case 9: return ${item.get_prop(prop, 9)};
  86    case 8: return ${item.get_prop(prop, 8)};
  87    case 7:
  88       if (devinfo->is_haswell) {
  89          return ${item.get_prop(prop, 7.5)};
  90       } else {
  91          return ${item.get_prop(prop, 7)};
  92       }
  93    case 6: return ${item.get_prop(prop, 6)};
  94    case 5: return ${item.get_prop(prop, 5)};
  95    case 4:
  96       if (devinfo->is_g4x) {
  97          return ${item.get_prop(prop, 4.5)};
  98       } else {
  99          return ${item.get_prop(prop, 4)};
 100       }
 101    default:
 102       unreachable("Invalid hardware generation");
 103    }
 104 }
 105 %endif
 106 </%def>
 107
 108 #ifdef __cplusplus
 109 extern "C" {
 110 #endif
 111 % for _, container in sorted(containers.items(), key=itemgetter(0)):
 112
 113 /* ${container.name} */
 114
 115 ${emit_per_gen_prop_func(container, 'length')}
 116
 117 % for _, field in sorted(container.fields.items(), key=itemgetter(0)):
 118
 119 /* ${container.name}::${field.name} */
 120
 121 ${emit_per_gen_prop_func(field, 'bits')}
 122
 123 ${emit_per_gen_prop_func(field, 'start')}
 124
 125 % endfor
 126 % endfor
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif
 131
 132 #endif /* ${guard} */""", output_encoding='utf-8')
 133
 134 alphanum_nono = re.compile(r'[ /\[\]()\-:.,=>#&*"+\\]+')
 135 def to_alphanum(name):
 136     global alphanum_nono
 137     return alphanum_nono.sub('', name).replace('α', 'alpha')
 138
 139 def safe_name(name):
 140     name = to_alphanum(name)
 141     if not name[0].isalpha():
 142         name = '_' + name
 143     return name
 144
 145 class Gen(object):
 146
 147     def __init__(self, z):
 148         # Convert potential "major.minor" string
 149         self.tenx = int(float(z) * 10)
 150
 151     def __lt__(self, other):
 152         return self.tenx < other.tenx
 153
 154     def __hash__(self):
 155         return hash(self.tenx)
 156
 157     def __eq__(self, other):
 158         return self.tenx == other.tenx
 159
 160     def prefix(self, token):
 161         gen = self.tenx
 162
 163         if gen % 10 == 0:
 164             gen //= 10
 165
 166         if token[0] == '_':
 167             token = token[1:]
 168
 169         return 'GEN{}_{}'.format(gen, token)
 170
 171 class Container(object):
 172
 173     def __init__(self, name):
 174         self.name = name
 175         self.token_name = safe_name(name)
 176         self.length_by_gen = {}
 177         self.fields = {}
 178
 179     def add_gen(self, gen, xml_attrs):
 180         assert isinstance(gen, Gen)
 181         if 'length' in xml_attrs:
 182             self.length_by_gen[gen] = xml_attrs['length']
 183
 184     def get_field(self, field_name, create=False):
 185         key = to_alphanum(field_name)
 186         if key not in self.fields:
 187             if create:
 188                 self.fields[key] = Field(self, field_name)
 189             else:
 190                 return None
 191         return self.fields[key]
 192
 193     def has_prop(self, prop):
 194         if prop == 'length':
 195             return bool(self.length_by_gen)
 196         else:
 197             raise ValueError('Invalid property: "{0}"'.format(prop))
 198
 199     def iter_prop(self, prop):
 200         if prop == 'length':
 201             return self.length_by_gen.items()
 202         else:
 203             raise ValueError('Invalid property: "{0}"'.format(prop))
 204
 205     def get_prop(self, prop, gen):
 206         if not isinstance(gen, Gen):
 207             gen = Gen(gen)
 208
 209         if prop == 'length':
 210             return self.length_by_gen.get(gen, 0)
 211         else:
 212             raise ValueError('Invalid property: "{0}"'.format(prop))
 213
 214 class Field(object):
 215
 216     def __init__(self, container, name):
 217         self.name = name
 218         self.token_name = safe_name('_'.join([container.name, self.name]))
 219         self.bits_by_gen = {}
 220         self.start_by_gen = {}
 221
 222     def add_gen(self, gen, xml_attrs):
 223         assert isinstance(gen, Gen)
 224         start = int(xml_attrs['start'])
 225         end = int(xml_attrs['end'])
 226         self.start_by_gen[gen] = start
 227         self.bits_by_gen[gen] = 1 + end - start
 228
 229     def has_prop(self, prop):
 230         return True
 231
 232     def iter_prop(self, prop):
 233         if prop == 'bits':
 234             return self.bits_by_gen.items()
 235         elif prop == 'start':
 236             return self.start_by_gen.items()
 237         else:
 238             raise ValueError('Invalid property: "{0}"'.format(prop))
 239
 240     def get_prop(self, prop, gen):
 241         if not isinstance(gen, Gen):
 242             gen = Gen(gen)
 243
 244         if prop == 'bits':
 245             return self.bits_by_gen.get(gen, 0)
 246         elif prop == 'start':
 247             return self.start_by_gen.get(gen, 0)
 248         else:
 249             raise ValueError('Invalid property: "{0}"'.format(prop))
 250
 251 class XmlParser(object):
 252
 253     def __init__(self, containers):
 254         self.parser = xml.parsers.expat.ParserCreate()
 255         self.parser.StartElementHandler = self.start_element
 256         self.parser.EndElementHandler = self.end_element
 257
 258         self.gen = None
 259         self.containers = containers
 260         self.container = None
 261
 262     def parse(self, filename):
 263         with open(filename, 'rb') as f:
 264             self.parser.ParseFile(f)
 265
 266     def start_element(self, name, attrs):
 267         if name == 'genxml':
 268             self.gen = Gen(attrs['gen'])
 269         elif name in ('instruction', 'struct', 'register'):
 270             if name == 'instruction' and 'engine' in attrs:
 271                 engines = set(attrs['engine'].split('|'))
 272                 if not engines & self.engines:
 273                     return
 274             self.start_container(attrs)
 275         elif name == 'field':
 276             self.start_field(attrs)
 277         else:
 278             pass
 279
 280     def end_element(self, name):
 281         if name == 'genxml':
 282             self.gen = None
 283         elif name in ('instruction', 'struct', 'register'):
 284             self.container = None
 285         else:
 286             pass
 287
 288     def start_container(self, attrs):
 289         assert self.container is None
 290         name = attrs['name']
 291         if name not in self.containers:
 292             self.containers[name] = Container(name)
 293         self.container = self.containers[name]
 294         self.container.add_gen(self.gen, attrs)
 295
 296     def start_field(self, attrs):
 297         if self.container is None:
 298             return
 299
 300         field_name = attrs.get('name', None)
 301         if not field_name:
 302             return
 303
 304         self.container.get_field(field_name, True).add_gen(self.gen, attrs)
 305
 306 def parse_args():
 307     p = argparse.ArgumentParser()
 308     p.add_argument('-o', '--output', type=str,
 309                    help="If OUTPUT is unset or '-', then it defaults to '/dev/stdout'")
 310     p.add_argument('--cpp-guard', type=str,
 311                    help='If unset, then CPP_GUARD is derived from OUTPUT.')
 312     p.add_argument('--engines', nargs='?', type=str, default='render',
 313                    help="Comma-separated list of engines whose instructions should be parsed (default: %(default)s)")
 314     p.add_argument('xml_sources', metavar='XML_SOURCE', nargs='+')
 315
 316     pargs = p.parse_args()
 317
 318     if pargs.output in (None, '-'):
 319         pargs.output = '/dev/stdout'
 320
 321     if pargs.cpp_guard is None:
 322         pargs.cpp_guard = os.path.basename(pargs.output).upper().replace('.', '_')
 323
 324     return pargs
 325
 326 def main():
 327     pargs = parse_args()
 328
 329     engines = pargs.engines.split(',')
 330     valid_engines = [ 'render', 'blitter', 'video' ]
 331     if set(engines) - set(valid_engines):
 332         print("Invalid engine specified, valid engines are:\n")
 333         for e in valid_engines:
 334             print("\t%s" % e)
 335         sys.exit(1)
 336
 337     # Maps name => Container
 338     containers = {}
 339
 340     for source in pargs.xml_sources:
 341         p = XmlParser(containers)
 342         p.engines = set(engines)
 343         p.parse(source)
 344
 345     with open(pargs.output, 'wb') as f:
 346         f.write(TEMPLATE.render(containers=containers, guard=pargs.cpp_guard))
 347
 348 if __name__ == '__main__':
 349     main()