scripts/qapi-types.py

   1 #
   2 # QAPI types generator
   3 #
   4 # Copyright IBM, Corp. 2011
   5 #
   6 # Authors:
   7 #  Anthony Liguori <[email protected]>
   8 #
   9 # This work is licensed under the terms of the GNU GPL, version 2.
  10 # See the COPYING file in the top-level directory.
  11
  12 from ordereddict import OrderedDict
  13 from qapi import *
  14 import sys
  15 import os
  16 import getopt
  17 import errno
  18
  19 def generate_fwd_struct(name, members, builtin_type=False):
  20     if builtin_type:
  21         return mcgen('''
  22
  23 typedef struct %(name)sList
  24 {
  25     union {
  26         %(type)s value;
  27         uint64_t padding;
  28     };
  29     struct %(name)sList *next;
  30 } %(name)sList;
  31 ''',
  32                      type=c_type(name),
  33                      name=name)
  34
  35     return mcgen('''
  36
  37 typedef struct %(name)s %(name)s;
  38
  39 typedef struct %(name)sList
  40 {
  41     union {
  42         %(name)s *value;
  43         uint64_t padding;
  44     };
  45     struct %(name)sList *next;
  46 } %(name)sList;
  47 ''',
  48                  name=name)
  49
  50 def generate_fwd_enum_struct(name, members):
  51     return mcgen('''
  52 typedef struct %(name)sList
  53 {
  54     union {
  55         %(name)s value;
  56         uint64_t padding;
  57     };
  58     struct %(name)sList *next;
  59 } %(name)sList;
  60 ''',
  61                  name=name)
  62
  63 def generate_struct_fields(members):
  64     ret = ''
  65
  66     for argname, argentry, optional, structured in parse_args(members):
  67         if optional:
  68             ret += mcgen('''
  69     bool has_%(c_name)s;
  70 ''',
  71                          c_name=c_var(argname))
  72         if structured:
  73             push_indent()
  74             ret += generate_struct({ "field": argname, "data": argentry})
  75             pop_indent()
  76         else:
  77             ret += mcgen('''
  78     %(c_type)s %(c_name)s;
  79 ''',
  80                      c_type=c_type(argentry), c_name=c_var(argname))
  81
  82     return ret
  83
  84 def generate_struct(expr):
  85
  86     structname = expr.get('type', "")
  87     fieldname = expr.get('field', "")
  88     members = expr['data']
  89     base = expr.get('base')
  90
  91     ret = mcgen('''
  92 struct %(name)s
  93 {
  94 ''',
  95           name=structname)
  96
  97     if base:
  98         ret += generate_struct_fields({'base': base})
  99
 100     ret += generate_struct_fields(members)
 101
 102     if len(fieldname):
 103         fieldname = " " + fieldname
 104     ret += mcgen('''
 105 }%(field)s;
 106 ''',
 107             field=fieldname)
 108
 109     return ret
 110
 111 def generate_enum_lookup(name, values):
 112     ret = mcgen('''
 113 const char *%(name)s_lookup[] = {
 114 ''',
 115                          name=name)
 116     i = 0
 117     for value in values:
 118         ret += mcgen('''
 119     "%(value)s",
 120 ''',
 121                      value=value)
 122
 123     ret += mcgen('''
 124     NULL,
 125 };
 126
 127 ''')
 128     return ret
 129
 130 def generate_enum(name, values):
 131     lookup_decl = mcgen('''
 132 extern const char *%(name)s_lookup[];
 133 ''',
 134                 name=name)
 135
 136     enum_decl = mcgen('''
 137 typedef enum %(name)s
 138 {
 139 ''',
 140                 name=name)
 141
 142     # append automatically generated _MAX value
 143     enum_values = values + [ 'MAX' ]
 144
 145     i = 0
 146     for value in enum_values:
 147         enum_decl += mcgen('''
 148     %(abbrev)s_%(value)s = %(i)d,
 149 ''',
 150                      abbrev=de_camel_case(name).upper(),
 151                      value=generate_enum_name(value),
 152                      i=i)
 153         i += 1
 154
 155     enum_decl += mcgen('''
 156 } %(name)s;
 157 ''',
 158                  name=name)
 159
 160     return lookup_decl + enum_decl
 161
 162 def generate_anon_union_qtypes(expr):
 163
 164     name = expr['union']
 165     members = expr['data']
 166
 167     ret = mcgen('''
 168 const int %(name)s_qtypes[QTYPE_MAX] = {
 169 ''',
 170     name=name)
 171
 172     for key in members:
 173         qapi_type = members[key]
 174         if builtin_type_qtypes.has_key(qapi_type):
 175             qtype = builtin_type_qtypes[qapi_type]
 176         elif find_struct(qapi_type):
 177             qtype = "QTYPE_QDICT"
 178         elif find_union(qapi_type):
 179             qtype = "QTYPE_QDICT"
 180         else:
 181             assert False, "Invalid anonymous union member"
 182
 183         ret += mcgen('''
 184     [ %(qtype)s ] = %(abbrev)s_KIND_%(enum)s,
 185 ''',
 186         qtype = qtype,
 187         abbrev = de_camel_case(name).upper(),
 188         enum = c_fun(de_camel_case(key),False).upper())
 189
 190     ret += mcgen('''
 191 };
 192 ''')
 193     return ret
 194
 195
 196 def generate_union(expr):
 197
 198     name = expr['union']
 199     typeinfo = expr['data']
 200
 201     base = expr.get('base')
 202     discriminator = expr.get('discriminator')
 203
 204     ret = mcgen('''
 205 struct %(name)s
 206 {
 207     %(name)sKind kind;
 208     union {
 209         void *data;
 210 ''',
 211                 name=name)
 212
 213     for key in typeinfo:
 214         ret += mcgen('''
 215         %(c_type)s %(c_name)s;
 216 ''',
 217                      c_type=c_type(typeinfo[key]),
 218                      c_name=c_fun(key))
 219
 220     ret += mcgen('''
 221     };
 222 ''')
 223
 224     if base:
 225         base_fields = find_struct(base)['data']
 226         if discriminator:
 227             base_fields = base_fields.copy()
 228             del base_fields[discriminator]
 229         ret += generate_struct_fields(base_fields)
 230     else:
 231         assert not discriminator
 232
 233     ret += mcgen('''
 234 };
 235 ''')
 236     if discriminator == {}:
 237         ret += mcgen('''
 238 extern const int %(name)s_qtypes[];
 239 ''',
 240             name=name)
 241
 242
 243     return ret
 244
 245 def generate_type_cleanup_decl(name):
 246     ret = mcgen('''
 247 void qapi_free_%(type)s(%(c_type)s obj);
 248 ''',
 249                 c_type=c_type(name),type=name)
 250     return ret
 251
 252 def generate_type_cleanup(name):
 253     ret = mcgen('''
 254
 255 void qapi_free_%(type)s(%(c_type)s obj)
 256 {
 257     QapiDeallocVisitor *md;
 258     Visitor *v;
 259
 260     if (!obj) {
 261         return;
 262     }
 263
 264     md = qapi_dealloc_visitor_new();
 265     v = qapi_dealloc_get_visitor(md);
 266     visit_type_%(type)s(v, &obj, NULL, NULL);
 267     qapi_dealloc_visitor_cleanup(md);
 268 }
 269 ''',
 270                 c_type=c_type(name),type=name)
 271     return ret
 272
 273
 274 try:
 275     opts, args = getopt.gnu_getopt(sys.argv[1:], "chbp:o:",
 276                                    ["source", "header", "builtins",
 277                                     "prefix=", "output-dir="])
 278 except getopt.GetoptError, err:
 279     print str(err)
 280     sys.exit(1)
 281
 282 output_dir = ""
 283 prefix = ""
 284 c_file = 'qapi-types.c'
 285 h_file = 'qapi-types.h'
 286
 287 do_c = False
 288 do_h = False
 289 do_builtins = False
 290
 291 for o, a in opts:
 292     if o in ("-p", "--prefix"):
 293         prefix = a
 294     elif o in ("-o", "--output-dir"):
 295         output_dir = a + "/"
 296     elif o in ("-c", "--source"):
 297         do_c = True
 298     elif o in ("-h", "--header"):
 299         do_h = True
 300     elif o in ("-b", "--builtins"):
 301         do_builtins = True
 302
 303 if not do_c and not do_h:
 304     do_c = True
 305     do_h = True
 306
 307 c_file = output_dir + prefix + c_file
 308 h_file = output_dir + prefix + h_file
 309
 310 try:
 311     os.makedirs(output_dir)
 312 except os.error, e:
 313     if e.errno != errno.EEXIST:
 314         raise
 315
 316 def maybe_open(really, name, opt):
 317     if really:
 318         return open(name, opt)
 319     else:
 320         import StringIO
 321         return StringIO.StringIO()
 322
 323 fdef = maybe_open(do_c, c_file, 'w')
 324 fdecl = maybe_open(do_h, h_file, 'w')
 325
 326 fdef.write(mcgen('''
 327 /* AUTOMATICALLY GENERATED, DO NOT MODIFY */
 328
 329 /*
 330  * deallocation functions for schema-defined QAPI types
 331  *
 332  * Copyright IBM, Corp. 2011
 333  *
 334  * Authors:
 335  *  Anthony Liguori   <[email protected]>
 336  *  Michael Roth      <[email protected]>
 337  *
 338  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 339  * See the COPYING.LIB file in the top-level directory.
 340  *
 341  */
 342
 343 #include "qapi/dealloc-visitor.h"
 344 #include "%(prefix)sqapi-types.h"
 345 #include "%(prefix)sqapi-visit.h"
 346
 347 ''',             prefix=prefix))
 348
 349 fdecl.write(mcgen('''
 350 /* AUTOMATICALLY GENERATED, DO NOT MODIFY */
 351
 352 /*
 353  * schema-defined QAPI types
 354  *
 355  * Copyright IBM, Corp. 2011
 356  *
 357  * Authors:
 358  *  Anthony Liguori   <[email protected]>
 359  *
 360  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 361  * See the COPYING.LIB file in the top-level directory.
 362  *
 363  */
 364
 365 #ifndef %(guard)s
 366 #define %(guard)s
 367
 368 #include <stdbool.h>
 369 #include <stdint.h>
 370
 371 ''',
 372                   guard=guardname(h_file)))
 373
 374 exprs = parse_schema(sys.stdin)
 375 exprs = filter(lambda expr: not expr.has_key('gen'), exprs)
 376
 377 fdecl.write(guardstart("QAPI_TYPES_BUILTIN_STRUCT_DECL"))
 378 for typename in builtin_types:
 379     fdecl.write(generate_fwd_struct(typename, None, builtin_type=True))
 380 fdecl.write(guardend("QAPI_TYPES_BUILTIN_STRUCT_DECL"))
 381
 382 for expr in exprs:
 383     ret = "\n"
 384     if expr.has_key('type'):
 385         ret += generate_fwd_struct(expr['type'], expr['data'])
 386     elif expr.has_key('enum'):
 387         ret += generate_enum(expr['enum'], expr['data']) + "\n"
 388         ret += generate_fwd_enum_struct(expr['enum'], expr['data'])
 389         fdef.write(generate_enum_lookup(expr['enum'], expr['data']))
 390     elif expr.has_key('union'):
 391         ret += generate_fwd_struct(expr['union'], expr['data']) + "\n"
 392         ret += generate_enum('%sKind' % expr['union'], expr['data'].keys())
 393         fdef.write(generate_enum_lookup('%sKind' % expr['union'], expr['data'].keys()))
 394         if expr.get('discriminator') == {}:
 395             fdef.write(generate_anon_union_qtypes(expr))
 396     else:
 397         continue
 398     fdecl.write(ret)
 399
 400 # to avoid header dependency hell, we always generate declarations
 401 # for built-in types in our header files and simply guard them
 402 fdecl.write(guardstart("QAPI_TYPES_BUILTIN_CLEANUP_DECL"))
 403 for typename in builtin_types:
 404     fdecl.write(generate_type_cleanup_decl(typename + "List"))
 405 fdecl.write(guardend("QAPI_TYPES_BUILTIN_CLEANUP_DECL"))
 406
 407 # ...this doesn't work for cases where we link in multiple objects that
 408 # have the functions defined, so we use -b option to provide control
 409 # over these cases
 410 if do_builtins:
 411     fdef.write(guardstart("QAPI_TYPES_BUILTIN_CLEANUP_DEF"))
 412     for typename in builtin_types:
 413         fdef.write(generate_type_cleanup(typename + "List"))
 414     fdef.write(guardend("QAPI_TYPES_BUILTIN_CLEANUP_DEF"))
 415
 416 for expr in exprs:
 417     ret = "\n"
 418     if expr.has_key('type'):
 419         ret += generate_struct(expr) + "\n"
 420         ret += generate_type_cleanup_decl(expr['type'] + "List")
 421         fdef.write(generate_type_cleanup(expr['type'] + "List") + "\n")
 422         ret += generate_type_cleanup_decl(expr['type'])
 423         fdef.write(generate_type_cleanup(expr['type']) + "\n")
 424     elif expr.has_key('union'):
 425         ret += generate_union(expr)
 426         ret += generate_type_cleanup_decl(expr['union'] + "List")
 427         fdef.write(generate_type_cleanup(expr['union'] + "List") + "\n")
 428         ret += generate_type_cleanup_decl(expr['union'])
 429         fdef.write(generate_type_cleanup(expr['union']) + "\n")
 430     elif expr.has_key('enum'):
 431         ret += generate_type_cleanup_decl(expr['enum'] + "List")
 432         fdef.write(generate_type_cleanup(expr['enum'] + "List") + "\n")
 433     else:
 434         continue
 435     fdecl.write(ret)
 436
 437 fdecl.write('''
 438 #endif
 439 ''')
 440
 441 fdecl.flush()
 442 fdecl.close()
 443
 444 fdef.flush()
 445 fdef.close()