scripts/qapi-types.py

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