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 <aliguori@us.ibm.com>
   9 #  Markus Armbruster <armbru@redhat.com>
  10 #
  11 # This work is licensed under the terms of the GNU GPLv2.
  12 # See the COPYING.LIB 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.line = self.col = 1
  43         for ch in schema.src[0:schema.pos]:
  44             if ch == '\n':
  45                 self.line += 1
  46                 self.col = 1
  47             elif ch == '\t':
  48                 self.col = (self.col + 7) % 8 + 1
  49             else:
  50                 self.col += 1
  51
  52     def __str__(self):
  53         return "%s:%s:%s: %s" % (self.fp.name, self.line, self.col, self.msg)
  54
  55 class QAPISchema:
  56
  57     def __init__(self, fp):
  58         self.fp = fp
  59         self.src = fp.read()
  60         if self.src == '' or self.src[-1] != '\n':
  61             self.src += '\n'
  62         self.cursor = 0
  63         self.exprs = []
  64         self.accept()
  65
  66         while self.tok != None:
  67             self.exprs.append(self.get_expr())
  68
  69     def accept(self):
  70         while True:
  71             bol = self.cursor == 0 or self.src[self.cursor-1] == '\n'
  72             self.tok = self.src[self.cursor]
  73             self.pos = self.cursor
  74             self.cursor += 1
  75             self.val = None
  76
  77             if self.tok == '#' and bol:
  78                 self.cursor = self.src.find('\n', self.cursor)
  79             elif self.tok in ['{', '}', ':', ',', '[', ']']:
  80                 return
  81             elif self.tok == "'":
  82                 string = ''
  83                 esc = False
  84                 while True:
  85                     ch = self.src[self.cursor]
  86                     self.cursor += 1
  87                     if ch == '\n':
  88                         raise QAPISchemaError(self,
  89                                               'Missing terminating "\'"')
  90                     if esc:
  91                         string += ch
  92                         esc = False
  93                     elif ch == "\\":
  94                         esc = True
  95                     elif ch == "'":
  96                         self.val = string
  97                         return
  98                     else:
  99                         string += ch
 100             elif self.tok == '\n':
 101                 if self.cursor == len(self.src):
 102                     self.tok = None
 103                     return
 104
 105     def get_members(self):
 106         expr = OrderedDict()
 107         while self.tok != '}':
 108             key = self.val
 109             self.accept()
 110             self.accept()        # :
 111             expr[key] = self.get_expr()
 112             if self.tok == ',':
 113                 self.accept()
 114         self.accept()
 115         return expr
 116
 117     def get_values(self):
 118         expr = []
 119         while self.tok != ']':
 120             expr.append(self.get_expr())
 121             if self.tok == ',':
 122                 self.accept()
 123         self.accept()
 124         return expr
 125
 126     def get_expr(self):
 127         if self.tok == '{':
 128             self.accept()
 129             expr = self.get_members()
 130         elif self.tok == '[':
 131             self.accept()
 132             expr = self.get_values()
 133         else:
 134             expr = self.val
 135             self.accept()
 136         return expr
 137
 138 def parse_schema(fp):
 139     try:
 140         schema = QAPISchema(fp)
 141     except QAPISchemaError as e:
 142         print >>sys.stderr, e
 143         exit(1)
 144
 145     exprs = []
 146
 147     for expr_eval in schema.exprs:
 148         if expr_eval.has_key('enum'):
 149             add_enum(expr_eval['enum'])
 150         elif expr_eval.has_key('union'):
 151             add_union(expr_eval)
 152             add_enum('%sKind' % expr_eval['union'])
 153         elif expr_eval.has_key('type'):
 154             add_struct(expr_eval)
 155         exprs.append(expr_eval)
 156
 157     return exprs
 158
 159 def parse_args(typeinfo):
 160     if isinstance(typeinfo, basestring):
 161         struct = find_struct(typeinfo)
 162         assert struct != None
 163         typeinfo = struct['data']
 164
 165     for member in typeinfo:
 166         argname = member
 167         argentry = typeinfo[member]
 168         optional = False
 169         structured = False
 170         if member.startswith('*'):
 171             argname = member[1:]
 172             optional = True
 173         if isinstance(argentry, OrderedDict):
 174             structured = True
 175         yield (argname, argentry, optional, structured)
 176
 177 def de_camel_case(name):
 178     new_name = ''
 179     for ch in name:
 180         if ch.isupper() and new_name:
 181             new_name += '_'
 182         if ch == '-':
 183             new_name += '_'
 184         else:
 185             new_name += ch.lower()
 186     return new_name
 187
 188 def camel_case(name):
 189     new_name = ''
 190     first = True
 191     for ch in name:
 192         if ch in ['_', '-']:
 193             first = True
 194         elif first:
 195             new_name += ch.upper()
 196             first = False
 197         else:
 198             new_name += ch.lower()
 199     return new_name
 200
 201 def c_var(name, protect=True):
 202     # ANSI X3J11/88-090, 3.1.1
 203     c89_words = set(['auto', 'break', 'case', 'char', 'const', 'continue',
 204                      'default', 'do', 'double', 'else', 'enum', 'extern', 'float',
 205                      'for', 'goto', 'if', 'int', 'long', 'register', 'return',
 206                      'short', 'signed', 'sizeof', 'static', 'struct', 'switch',
 207                      'typedef', 'union', 'unsigned', 'void', 'volatile', 'while'])
 208     # ISO/IEC 9899:1999, 6.4.1
 209     c99_words = set(['inline', 'restrict', '_Bool', '_Complex', '_Imaginary'])
 210     # ISO/IEC 9899:2011, 6.4.1
 211     c11_words = set(['_Alignas', '_Alignof', '_Atomic', '_Generic', '_Noreturn',
 212                      '_Static_assert', '_Thread_local'])
 213     # GCC http://gcc.gnu.org/onlinedocs/gcc-4.7.1/gcc/C-Extensions.html
 214     # excluding _.*
 215     gcc_words = set(['asm', 'typeof'])
 216     # namespace pollution:
 217     polluted_words = set(['unix'])
 218     if protect and (name in c89_words | c99_words | c11_words | gcc_words | polluted_words):
 219         return "q_" + name
 220     return name.replace('-', '_').lstrip("*")
 221
 222 def c_fun(name, protect=True):
 223     return c_var(name, protect).replace('.', '_')
 224
 225 def c_list_type(name):
 226     return '%sList' % name
 227
 228 def type_name(name):
 229     if type(name) == list:
 230         return c_list_type(name[0])
 231     return name
 232
 233 enum_types = []
 234 struct_types = []
 235 union_types = []
 236
 237 def add_struct(definition):
 238     global struct_types
 239     struct_types.append(definition)
 240
 241 def find_struct(name):
 242     global struct_types
 243     for struct in struct_types:
 244         if struct['type'] == name:
 245             return struct
 246     return None
 247
 248 def add_union(definition):
 249     global union_types
 250     union_types.append(definition)
 251
 252 def find_union(name):
 253     global union_types
 254     for union in union_types:
 255         if union['union'] == name:
 256             return union
 257     return None
 258
 259 def add_enum(name):
 260     global enum_types
 261     enum_types.append(name)
 262
 263 def is_enum(name):
 264     global enum_types
 265     return (name in enum_types)
 266
 267 def c_type(name):
 268     if name == 'str':
 269         return 'char *'
 270     elif name == 'int':
 271         return 'int64_t'
 272     elif (name == 'int8' or name == 'int16' or name == 'int32' or
 273           name == 'int64' or name == 'uint8' or name == 'uint16' or
 274           name == 'uint32' or name == 'uint64'):
 275         return name + '_t'
 276     elif name == 'size':
 277         return 'uint64_t'
 278     elif name == 'bool':
 279         return 'bool'
 280     elif name == 'number':
 281         return 'double'
 282     elif type(name) == list:
 283         return '%s *' % c_list_type(name[0])
 284     elif is_enum(name):
 285         return name
 286     elif name == None or len(name) == 0:
 287         return 'void'
 288     elif name == name.upper():
 289         return '%sEvent *' % camel_case(name)
 290     else:
 291         return '%s *' % name
 292
 293 def genindent(count):
 294     ret = ""
 295     for i in range(count):
 296         ret += " "
 297     return ret
 298
 299 indent_level = 0
 300
 301 def push_indent(indent_amount=4):
 302     global indent_level
 303     indent_level += indent_amount
 304
 305 def pop_indent(indent_amount=4):
 306     global indent_level
 307     indent_level -= indent_amount
 308
 309 def cgen(code, **kwds):
 310     indent = genindent(indent_level)
 311     lines = code.split('\n')
 312     lines = map(lambda x: indent + x, lines)
 313     return '\n'.join(lines) % kwds + '\n'
 314
 315 def mcgen(code, **kwds):
 316     return cgen('\n'.join(code.split('\n')[1:-1]), **kwds)
 317
 318 def basename(filename):
 319     return filename.split("/")[-1]
 320
 321 def guardname(filename):
 322     guard = basename(filename).rsplit(".", 1)[0]
 323     for substr in [".", " ", "-"]:
 324         guard = guard.replace(substr, "_")
 325     return guard.upper() + '_H'
 326
 327 def guardstart(name):
 328     return mcgen('''
 329
 330 #ifndef %(name)s
 331 #define %(name)s
 332
 333 ''',
 334                  name=guardname(name))
 335
 336 def guardend(name):
 337     return mcgen('''
 338
 339 #endif /* %(name)s */
 340
 341 ''',
 342                  name=guardname(name))