scripts/qapi.py

   1 #
   2 # QAPI helper library
   3 #
   4 # Copyright IBM, Corp. 2011
   5 # Copyright (c) 2013 Red Hat Inc.
   6 #
   7 # Authors:
   8 #  Anthony Liguori <[email protected]>
   9 #  Markus Armbruster <[email protected]>
  10 #
  11 # This work is licensed under the terms of the GNU GPL, version 2.
  12 # See the COPYING file in the top-level directory.
  13
  14 from ordereddict import OrderedDict
  15 import sys
  16
  17 builtin_types = [
  18     'str', 'int', 'number', 'bool',
  19     'int8', 'int16', 'int32', 'int64',
  20     'uint8', 'uint16', 'uint32', 'uint64'
  21 ]
  22
  23 builtin_type_qtypes = {
  24     'str':      'QTYPE_QSTRING',
  25     'int':      'QTYPE_QINT',
  26     'number':   'QTYPE_QFLOAT',
  27     'bool':     'QTYPE_QBOOL',
  28     'int8':     'QTYPE_QINT',
  29     'int16':    'QTYPE_QINT',
  30     'int32':    'QTYPE_QINT',
  31     'int64':    'QTYPE_QINT',
  32     'uint8':    'QTYPE_QINT',
  33     'uint16':   'QTYPE_QINT',
  34     'uint32':   'QTYPE_QINT',
  35     'uint64':   'QTYPE_QINT',
  36 }
  37
  38 class QAPISchemaError(Exception):
  39     def __init__(self, schema, msg):
  40         self.fp = schema.fp
  41         self.msg = msg
  42         self.col = 1
  43         self.line = schema.line
  44         for ch in schema.src[schema.line_pos:schema.pos]:
  45             if ch == '\t':
  46                 self.col = (self.col + 7) % 8 + 1
  47             else:
  48                 self.col += 1
  49
  50     def __str__(self):
  51         return "%s:%s:%s: %s" % (self.fp.name, self.line, self.col, self.msg)
  52
  53 class QAPIExprError(Exception):
  54     def __init__(self, expr_info, msg):
  55         self.fp = expr_info['fp']
  56         self.line = expr_info['line']
  57         self.msg = msg
  58
  59     def __str__(self):
  60         return "%s:%s: %s" % (self.fp.name, self.line, self.msg)
  61
  62 class QAPISchema:
  63
  64     def __init__(self, fp):
  65         self.fp = fp
  66         self.src = fp.read()
  67         if self.src == '' or self.src[-1] != '\n':
  68             self.src += '\n'
  69         self.cursor = 0
  70         self.line = 1
  71         self.line_pos = 0
  72         self.exprs = []
  73         self.accept()
  74
  75         while self.tok != None:
  76             expr_info = {'fp': fp, 'line': self.line}
  77             expr_elem = {'expr': self.get_expr(False),
  78                          'info': expr_info}
  79             self.exprs.append(expr_elem)
  80
  81     def accept(self):
  82         while True:
  83             self.tok = self.src[self.cursor]
  84             self.pos = self.cursor
  85             self.cursor += 1
  86             self.val = None
  87
  88             if self.tok == '#':
  89                 self.cursor = self.src.find('\n', self.cursor)
  90             elif self.tok in ['{', '}', ':', ',', '[', ']']:
  91                 return
  92             elif self.tok == "'":
  93                 string = ''
  94                 esc = False
  95                 while True:
  96                     ch = self.src[self.cursor]
  97                     self.cursor += 1
  98                     if ch == '\n':
  99                         raise QAPISchemaError(self,
 100                                               'Missing terminating "\'"')
 101                     if esc:
 102                         string += ch
 103                         esc = False
 104                     elif ch == "\\":
 105                         esc = True
 106                     elif ch == "'":
 107                         self.val = string
 108                         return
 109                     else:
 110                         string += ch
 111             elif self.tok == '\n':
 112                 if self.cursor == len(self.src):
 113                     self.tok = None
 114                     return
 115                 self.line += 1
 116                 self.line_pos = self.cursor
 117             elif not self.tok.isspace():
 118                 raise QAPISchemaError(self, 'Stray "%s"' % self.tok)
 119
 120     def get_members(self):
 121         expr = OrderedDict()
 122         if self.tok == '}':
 123             self.accept()
 124             return expr
 125         if self.tok != "'":
 126             raise QAPISchemaError(self, 'Expected string or "}"')
 127         while True:
 128             key = self.val
 129             self.accept()
 130             if self.tok != ':':
 131                 raise QAPISchemaError(self, 'Expected ":"')
 132             self.accept()
 133             if key in expr:
 134                 raise QAPISchemaError(self, 'Duplicate key "%s"' % key)
 135             expr[key] = self.get_expr(True)
 136             if self.tok == '}':
 137                 self.accept()
 138                 return expr
 139             if self.tok != ',':
 140                 raise QAPISchemaError(self, 'Expected "," or "}"')
 141             self.accept()
 142             if self.tok != "'":
 143                 raise QAPISchemaError(self, 'Expected string')
 144
 145     def get_values(self):
 146         expr = []
 147         if self.tok == ']':
 148             self.accept()
 149             return expr
 150         if not self.tok in [ '{', '[', "'" ]:
 151             raise QAPISchemaError(self, 'Expected "{", "[", "]" or string')
 152         while True:
 153             expr.append(self.get_expr(True))
 154             if self.tok == ']':
 155                 self.accept()
 156                 return expr
 157             if self.tok != ',':
 158                 raise QAPISchemaError(self, 'Expected "," or "]"')
 159             self.accept()
 160
 161     def get_expr(self, nested):
 162         if self.tok != '{' and not nested:
 163             raise QAPISchemaError(self, 'Expected "{"')
 164         if self.tok == '{':
 165             self.accept()
 166             expr = self.get_members()
 167         elif self.tok == '[':
 168             self.accept()
 169             expr = self.get_values()
 170         elif self.tok == "'":
 171             expr = self.val
 172             self.accept()
 173         else:
 174             raise QAPISchemaError(self, 'Expected "{", "[" or string')
 175         return expr
 176
 177 def find_base_fields(base):
 178     base_struct_define = find_struct(base)
 179     if not base_struct_define:
 180         return None
 181     return base_struct_define['data']
 182
 183 def check_union(expr, expr_info):
 184     name = expr['union']
 185     base = expr.get('base')
 186     discriminator = expr.get('discriminator')
 187     members = expr['data']
 188
 189     # If the object has a member 'base', its value must name a complex type.
 190     if base:
 191         base_fields = find_base_fields(base)
 192         if not base_fields:
 193             raise QAPIExprError(expr_info,
 194                                 "Base '%s' is not a valid type"
 195                                 % base)
 196
 197     # If the union object has no member 'discriminator', it's an
 198     # ordinary union.
 199     if not discriminator:
 200         enum_define = None
 201
 202     # Else if the value of member 'discriminator' is {}, it's an
 203     # anonymous union.
 204     elif discriminator == {}:
 205         enum_define = None
 206
 207     # Else, it's a flat union.
 208     else:
 209         # The object must have a member 'base'.
 210         if not base:
 211             raise QAPIExprError(expr_info,
 212                                 "Flat union '%s' must have a base field"
 213                                 % name)
 214         # The value of member 'discriminator' must name a member of the
 215         # base type.
 216         discriminator_type = base_fields.get(discriminator)
 217         if not discriminator_type:
 218             raise QAPIExprError(expr_info,
 219                                 "Discriminator '%s' is not a member of base "
 220                                 "type '%s'"
 221                                 % (discriminator, base))
 222         enum_define = find_enum(discriminator_type)
 223
 224     # Check every branch
 225     for (key, value) in members.items():
 226         # If this named member's value names an enum type, then all members
 227         # of 'data' must also be members of the enum type.
 228         if enum_define and not key in enum_define['enum_values']:
 229             raise QAPIExprError(expr_info,
 230                                 "Discriminator value '%s' is not found in "
 231                                 "enum '%s'" %
 232                                 (key, enum_define["enum_name"]))
 233         # Todo: add checking for values. Key is checked as above, value can be
 234         # also checked here, but we need more functions to handle array case.
 235
 236 def check_exprs(schema):
 237     for expr_elem in schema.exprs:
 238         expr = expr_elem['expr']
 239         if expr.has_key('union'):
 240             check_union(expr, expr_elem['info'])
 241
 242 def parse_schema(fp):
 243     try:
 244         schema = QAPISchema(fp)
 245     except QAPISchemaError, e:
 246         print >>sys.stderr, e
 247         exit(1)
 248
 249     exprs = []
 250
 251     for expr_elem in schema.exprs:
 252         expr = expr_elem['expr']
 253         if expr.has_key('enum'):
 254             add_enum(expr['enum'], expr['data'])
 255         elif expr.has_key('union'):
 256             add_union(expr)
 257             add_enum('%sKind' % expr['union'])
 258         elif expr.has_key('type'):
 259             add_struct(expr)
 260         exprs.append(expr)
 261
 262     try:
 263         check_exprs(schema)
 264     except QAPIExprError, e:
 265         print >>sys.stderr, e
 266         exit(1)
 267
 268     return exprs
 269
 270 def parse_args(typeinfo):
 271     if isinstance(typeinfo, basestring):
 272         struct = find_struct(typeinfo)
 273         assert struct != None
 274         typeinfo = struct['data']
 275
 276     for member in typeinfo:
 277         argname = member
 278         argentry = typeinfo[member]
 279         optional = False
 280         structured = False
 281         if member.startswith('*'):
 282             argname = member[1:]
 283             optional = True
 284         if isinstance(argentry, OrderedDict):
 285             structured = True
 286         yield (argname, argentry, optional, structured)
 287
 288 def de_camel_case(name):
 289     new_name = ''
 290     for ch in name:
 291         if ch.isupper() and new_name:
 292             new_name += '_'
 293         if ch == '-':
 294             new_name += '_'
 295         else:
 296             new_name += ch.lower()
 297     return new_name
 298
 299 def camel_case(name):
 300     new_name = ''
 301     first = True
 302     for ch in name:
 303         if ch in ['_', '-']:
 304             first = True
 305         elif first:
 306             new_name += ch.upper()
 307             first = False
 308         else:
 309             new_name += ch.lower()
 310     return new_name
 311
 312 def c_var(name, protect=True):
 313     # ANSI X3J11/88-090, 3.1.1
 314     c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
 315                      'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
 316                      'for', 'goto', 'if', 'int', 'long', 'register', 'return',
 317                      'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
 318                      'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
 319     # ISO/IEC 9899:1999, 6.4.1
 320     c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
 321     # ISO/IEC 9899:2011, 6.4.1
 322     c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
 323                      '_Static_assert', '_Thread_local'])
 324     # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
 325     # excluding _.*
 326     gcc_words = set(['asm', 'typeof'])
 327     # C++ ISO/IEC 14882:2003 2.11
 328     cpp_words = set(['bool', 'catch', 'class', 'const_cast', 'delete',
 329                      'dynamic_cast', 'explicit', 'false', 'friend', 'mutable',
 330                      'namespace', 'new', 'operator', 'private', 'protected',
 331                      'public', 'reinterpret_cast', 'static_cast', 'template',
 332                      'this', 'throw', 'true', 'try', 'typeid', 'typename',
 333                      'using', 'virtual', 'wchar_t',
 334                      # alternative representations
 335                      'and', 'and_eq', 'bitand', 'bitor', 'compl', 'not',
 336                      'not_eq', 'or', 'or_eq', 'xor', 'xor_eq'])
 337     # namespace pollution:
 338     polluted_words = set(['unix', 'errno'])
 339     if protect and (name in c89_words | c99_words | c11_words | gcc_words | cpp_words | polluted_words):
 340         return "q_" + name
 341     return name.replace('-', '_').lstrip("*")
 342
 343 def c_fun(name, protect=True):
 344     return c_var(name, protect).replace('.', '_')
 345
 346 def c_list_type(name):
 347     return '%sList' % name
 348
 349 def type_name(name):
 350     if type(name) == list:
 351         return c_list_type(name[0])
 352     return name
 353
 354 enum_types = []
 355 struct_types = []
 356 union_types = []
 357
 358 def add_struct(definition):
 359     global struct_types
 360     struct_types.append(definition)
 361
 362 def find_struct(name):
 363     global struct_types
 364     for struct in struct_types:
 365         if struct['type'] == name:
 366             return struct
 367     return None
 368
 369 def add_union(definition):
 370     global union_types
 371     union_types.append(definition)
 372
 373 def find_union(name):
 374     global union_types
 375     for union in union_types:
 376         if union['union'] == name:
 377             return union
 378     return None
 379
 380 def add_enum(name, enum_values = None):
 381     global enum_types
 382     enum_types.append({"enum_name": name, "enum_values": enum_values})
 383
 384 def find_enum(name):
 385     global enum_types
 386     for enum in enum_types:
 387         if enum['enum_name'] == name:
 388             return enum
 389     return None
 390
 391 def is_enum(name):
 392     return find_enum(name) != None
 393
 394 def c_type(name):
 395     if name == 'str':
 396         return 'char *'
 397     elif name == 'int':
 398         return 'int64_t'
 399     elif (name == 'int8' or name == 'int16' or name == 'int32' or
 400           name == 'int64' or name == 'uint8' or name == 'uint16' or
 401           name == 'uint32' or name == 'uint64'):
 402         return name + '_t'
 403     elif name == 'size':
 404         return 'uint64_t'
 405     elif name == 'bool':
 406         return 'bool'
 407     elif name == 'number':
 408         return 'double'
 409     elif type(name) == list:
 410         return '%s *' % c_list_type(name[0])
 411     elif is_enum(name):
 412         return name
 413     elif name == None or len(name) == 0:
 414         return 'void'
 415     elif name == name.upper():
 416         return '%sEvent *' % camel_case(name)
 417     else:
 418         return '%s *' % name
 419
 420 def genindent(count):
 421     ret = ""
 422     for i in range(count):
 423         ret += " "
 424     return ret
 425
 426 indent_level = 0
 427
 428 def push_indent(indent_amount=4):
 429     global indent_level
 430     indent_level += indent_amount
 431
 432 def pop_indent(indent_amount=4):
 433     global indent_level
 434     indent_level -= indent_amount
 435
 436 def cgen(code, **kwds):
 437     indent = genindent(indent_level)
 438     lines = code.split('\n')
 439     lines = map(lambda x: indent + x, lines)
 440     return '\n'.join(lines) % kwds + '\n'
 441
 442 def mcgen(code, **kwds):
 443     return cgen('\n'.join(code.split('\n')[1:-1]), **kwds)
 444
 445 def basename(filename):
 446     return filename.split("/")[-1]
 447
 448 def guardname(filename):
 449     guard = basename(filename).rsplit(".", 1)[0]
 450     for substr in [".", " ", "-"]:
 451         guard = guard.replace(substr, "_")
 452     return guard.upper() + '_H'
 453
 454 def guardstart(name):
 455     return mcgen('''
 456
 457 #ifndef %(name)s
 458 #define %(name)s
 459
 460 ''',
 461                  name=guardname(name))
 462
 463 def guardend(name):
 464     return mcgen('''
 465
 466 #endif /* %(name)s */
 467
 468 ''',
 469                  name=guardname(name))
 470
 471 def _generate_enum_value_string(value):
 472     if value.isupper():
 473         return c_fun(value, False)
 474     new_name = ''
 475     for c in c_fun(value, False):
 476         if c.isupper():
 477             new_name += '_'
 478         new_name += c
 479     return new_name.lstrip('_').upper()
 480
 481 def generate_enum_full_value(enum_name, enum_value):
 482     abbrev_string = de_camel_case(enum_name).upper()
 483     value_string = _generate_enum_value_string(enum_value)
 484     return "%s_%s" % (abbrev_string, value_string)