scripts/qapi-types.py

   1 #
   2 # QAPI types generator
   3 #
   4 # Copyright IBM, Corp. 2011
   5 # Copyright (c) 2013-2016 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 qapi import *
  15
  16
  17 # variants must be emitted before their container; track what has already
  18 # been output
  19 objects_seen = set()
  20
  21
  22 def gen_fwd_object_or_array(name):
  23     return mcgen('''
  24
  25 typedef struct %(c_name)s %(c_name)s;
  26 ''',
  27                  c_name=c_name(name))
  28
  29
  30 def gen_array(name, element_type):
  31     return mcgen('''
  32
  33 struct %(c_name)s {
  34     %(c_name)s *next;
  35     %(c_type)s value;
  36 };
  37 ''',
  38                  c_name=c_name(name), c_type=element_type.c_type())
  39
  40
  41 def gen_struct_members(members):
  42     ret = ''
  43     for memb in members:
  44         if memb.optional:
  45             ret += mcgen('''
  46     bool has_%(c_name)s;
  47 ''',
  48                          c_name=c_name(memb.name))
  49         ret += mcgen('''
  50     %(c_type)s %(c_name)s;
  51 ''',
  52                      c_type=memb.type.c_type(), c_name=c_name(memb.name))
  53     return ret
  54
  55
  56 def gen_object(name, base, members, variants):
  57     if name in objects_seen:
  58         return ''
  59     objects_seen.add(name)
  60
  61     ret = ''
  62     if variants:
  63         for v in variants.variants:
  64             if isinstance(v.type, QAPISchemaObjectType):
  65                 ret += gen_object(v.type.name, v.type.base,
  66                                   v.type.local_members, v.type.variants)
  67
  68     ret += mcgen('''
  69
  70 struct %(c_name)s {
  71 ''',
  72                  c_name=c_name(name))
  73
  74     if base:
  75         ret += mcgen('''
  76     /* Members inherited from %(c_name)s: */
  77 ''',
  78                      c_name=base.c_name())
  79         ret += gen_struct_members(base.members)
  80         ret += mcgen('''
  81     /* Own members: */
  82 ''')
  83     ret += gen_struct_members(members)
  84
  85     if variants:
  86         ret += gen_variants(variants)
  87
  88     # Make sure that all structs have at least one member; this avoids
  89     # potential issues with attempting to malloc space for zero-length
  90     # structs in C, and also incompatibility with C++ (where an empty
  91     # struct is size 1).
  92     if not (base and base.members) and not members and not variants:
  93         ret += mcgen('''
  94     char qapi_dummy_for_empty_struct;
  95 ''')
  96
  97     ret += mcgen('''
  98 };
  99 ''')
 100
 101     return ret
 102
 103
 104 def gen_upcast(name, base):
 105     # C makes const-correctness ugly.  We have to cast away const to let
 106     # this function work for both const and non-const obj.
 107     return mcgen('''
 108
 109 static inline %(base)s *qapi_%(c_name)s_base(const %(c_name)s *obj)
 110 {
 111     return (%(base)s *)obj;
 112 }
 113 ''',
 114                  c_name=c_name(name), base=base.c_name())
 115
 116
 117 def gen_variants(variants):
 118     ret = mcgen('''
 119     union { /* union tag is @%(c_name)s */
 120 ''',
 121                 c_name=c_name(variants.tag_member.name))
 122
 123     for var in variants.variants:
 124         # Ugly special case for simple union TODO get rid of it
 125         simple_union_type = var.simple_union_type()
 126         if simple_union_type:
 127             typ = simple_union_type.c_type()
 128         else:
 129             typ = var.type.c_unboxed_type()
 130         ret += mcgen('''
 131         %(c_type)s %(c_name)s;
 132 ''',
 133                      c_type=typ,
 134                      c_name=c_name(var.name))
 135
 136     ret += mcgen('''
 137     } u;
 138 ''')
 139
 140     return ret
 141
 142
 143 def gen_type_cleanup_decl(name):
 144     ret = mcgen('''
 145
 146 void qapi_free_%(c_name)s(%(c_name)s *obj);
 147 ''',
 148                 c_name=c_name(name))
 149     return ret
 150
 151
 152 def gen_type_cleanup(name):
 153     ret = mcgen('''
 154
 155 void qapi_free_%(c_name)s(%(c_name)s *obj)
 156 {
 157     QapiDeallocVisitor *qdv;
 158     Visitor *v;
 159
 160     if (!obj) {
 161         return;
 162     }
 163
 164     qdv = qapi_dealloc_visitor_new();
 165     v = qapi_dealloc_get_visitor(qdv);
 166     visit_type_%(c_name)s(v, NULL, &obj, NULL);
 167     qapi_dealloc_visitor_cleanup(qdv);
 168 }
 169 ''',
 170                 c_name=c_name(name))
 171     return ret
 172
 173
 174 class QAPISchemaGenTypeVisitor(QAPISchemaVisitor):
 175     def __init__(self):
 176         self.decl = None
 177         self.defn = None
 178         self._fwdecl = None
 179         self._btin = None
 180
 181     def visit_begin(self, schema):
 182         # gen_object() is recursive, ensure it doesn't visit the empty type
 183         objects_seen.add(schema.the_empty_object_type.name)
 184         self.decl = ''
 185         self.defn = ''
 186         self._fwdecl = ''
 187         self._btin = guardstart('QAPI_TYPES_BUILTIN')
 188
 189     def visit_end(self):
 190         self.decl = self._fwdecl + self.decl
 191         self._fwdecl = None
 192         # To avoid header dependency hell, we always generate
 193         # declarations for built-in types in our header files and
 194         # simply guard them.  See also do_builtins (command line
 195         # option -b).
 196         self._btin += guardend('QAPI_TYPES_BUILTIN')
 197         self.decl = self._btin + self.decl
 198         self._btin = None
 199
 200     def _gen_type_cleanup(self, name):
 201         self.decl += gen_type_cleanup_decl(name)
 202         self.defn += gen_type_cleanup(name)
 203
 204     def visit_enum_type(self, name, info, values, prefix):
 205         # Special case for our lone builtin enum type
 206         # TODO use something cleaner than existence of info
 207         if not info:
 208             self._btin += gen_enum(name, values, prefix)
 209             if do_builtins:
 210                 self.defn += gen_enum_lookup(name, values, prefix)
 211         else:
 212             self._fwdecl += gen_enum(name, values, prefix)
 213             self.defn += gen_enum_lookup(name, values, prefix)
 214
 215     def visit_array_type(self, name, info, element_type):
 216         if isinstance(element_type, QAPISchemaBuiltinType):
 217             self._btin += gen_fwd_object_or_array(name)
 218             self._btin += gen_array(name, element_type)
 219             self._btin += gen_type_cleanup_decl(name)
 220             if do_builtins:
 221                 self.defn += gen_type_cleanup(name)
 222         else:
 223             self._fwdecl += gen_fwd_object_or_array(name)
 224             self.decl += gen_array(name, element_type)
 225             self._gen_type_cleanup(name)
 226
 227     def visit_object_type(self, name, info, base, members, variants):
 228         # Nothing to do for the special empty builtin
 229         if name == 'q_empty':
 230             return
 231         self._fwdecl += gen_fwd_object_or_array(name)
 232         self.decl += gen_object(name, base, members, variants)
 233         if base:
 234             self.decl += gen_upcast(name, base)
 235         # TODO Worth changing the visitor signature, so we could
 236         # directly use rather than repeat type.is_implicit()?
 237         if not name.startswith('q_'):
 238             # implicit types won't be directly allocated/freed
 239             self._gen_type_cleanup(name)
 240
 241     def visit_alternate_type(self, name, info, variants):
 242         self._fwdecl += gen_fwd_object_or_array(name)
 243         self.decl += gen_object(name, None, [variants.tag_member], variants)
 244         self._gen_type_cleanup(name)
 245
 246 # If you link code generated from multiple schemata, you want only one
 247 # instance of the code for built-in types.  Generate it only when
 248 # do_builtins, enabled by command line option -b.  See also
 249 # QAPISchemaGenTypeVisitor.visit_end().
 250 do_builtins = False
 251
 252 (input_file, output_dir, do_c, do_h, prefix, opts) = \
 253     parse_command_line("b", ["builtins"])
 254
 255 for o, a in opts:
 256     if o in ("-b", "--builtins"):
 257         do_builtins = True
 258
 259 c_comment = '''
 260 /*
 261  * deallocation functions for schema-defined QAPI types
 262  *
 263  * Copyright IBM, Corp. 2011
 264  *
 265  * Authors:
 266  *  Anthony Liguori   <[email protected]>
 267  *  Michael Roth      <[email protected]>
 268  *
 269  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 270  * See the COPYING.LIB file in the top-level directory.
 271  *
 272  */
 273 '''
 274 h_comment = '''
 275 /*
 276  * schema-defined QAPI types
 277  *
 278  * Copyright IBM, Corp. 2011
 279  *
 280  * Authors:
 281  *  Anthony Liguori   <[email protected]>
 282  *
 283  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 284  * See the COPYING.LIB file in the top-level directory.
 285  *
 286  */
 287 '''
 288
 289 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
 290                             'qapi-types.c', 'qapi-types.h',
 291                             c_comment, h_comment)
 292
 293 fdef.write(mcgen('''
 294 #include "qemu/osdep.h"
 295 #include "qapi/dealloc-visitor.h"
 296 #include "%(prefix)sqapi-types.h"
 297 #include "%(prefix)sqapi-visit.h"
 298 ''',
 299                  prefix=prefix))
 300
 301 # To avoid circular headers, use only typedefs.h here, not qobject.h
 302 fdecl.write(mcgen('''
 303 #include "qemu/typedefs.h"
 304 '''))
 305
 306 schema = QAPISchema(input_file)
 307 gen = QAPISchemaGenTypeVisitor()
 308 schema.visit(gen)
 309 fdef.write(gen.defn)
 310 fdecl.write(gen.decl)
 311
 312 close_output(fdef, fdecl)