scripts/qapi-visit.py

   1 """
   2 QAPI visitor generator
   3
   4 Copyright IBM, Corp. 2011
   5 Copyright (C) 2014-2018 Red Hat, Inc.
   6
   7 Authors:
   8  Anthony Liguori <[email protected]>
   9  Michael Roth    <[email protected]>
  10  Markus Armbruster <[email protected]>
  11
  12 This work is licensed under the terms of the GNU GPL, version 2.
  13 See the COPYING file in the top-level directory.
  14 """
  15
  16 from qapi import *
  17
  18
  19 def gen_visit_decl(name, scalar=False):
  20     c_type = c_name(name) + ' *'
  21     if not scalar:
  22         c_type += '*'
  23     return mcgen('''
  24 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
  25 ''',
  26                  c_name=c_name(name), c_type=c_type)
  27
  28
  29 def gen_visit_members_decl(name):
  30     return mcgen('''
  31
  32 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
  33 ''',
  34                  c_name=c_name(name))
  35
  36
  37 def gen_visit_object_members(name, base, members, variants):
  38     ret = mcgen('''
  39
  40 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
  41 {
  42     Error *err = NULL;
  43
  44 ''',
  45                 c_name=c_name(name))
  46
  47     if base:
  48         ret += mcgen('''
  49     visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err);
  50     if (err) {
  51         goto out;
  52     }
  53 ''',
  54                      c_type=base.c_name())
  55
  56     for memb in members:
  57         if memb.optional:
  58             ret += mcgen('''
  59     if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
  60 ''',
  61                          name=memb.name, c_name=c_name(memb.name))
  62             push_indent()
  63         ret += mcgen('''
  64     visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
  65     if (err) {
  66         goto out;
  67     }
  68 ''',
  69                      c_type=memb.type.c_name(), name=memb.name,
  70                      c_name=c_name(memb.name))
  71         if memb.optional:
  72             pop_indent()
  73             ret += mcgen('''
  74     }
  75 ''')
  76
  77     if variants:
  78         ret += mcgen('''
  79     switch (obj->%(c_name)s) {
  80 ''',
  81                      c_name=c_name(variants.tag_member.name))
  82
  83         for var in variants.variants:
  84             ret += mcgen('''
  85     case %(case)s:
  86         visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
  87         break;
  88 ''',
  89                          case=c_enum_const(variants.tag_member.type.name,
  90                                            var.name,
  91                                            variants.tag_member.type.prefix),
  92                          c_type=var.type.c_name(), c_name=c_name(var.name))
  93
  94         ret += mcgen('''
  95     default:
  96         abort();
  97     }
  98 ''')
  99
 100     # 'goto out' produced for base, for each member, and if variants were
 101     # present
 102     if base or members or variants:
 103         ret += mcgen('''
 104
 105 out:
 106 ''')
 107     ret += mcgen('''
 108     error_propagate(errp, err);
 109 }
 110 ''')
 111     return ret
 112
 113
 114 def gen_visit_list(name, element_type):
 115     return mcgen('''
 116
 117 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 118 {
 119     Error *err = NULL;
 120     %(c_name)s *tail;
 121     size_t size = sizeof(**obj);
 122
 123     visit_start_list(v, name, (GenericList **)obj, size, &err);
 124     if (err) {
 125         goto out;
 126     }
 127
 128     for (tail = *obj; tail;
 129          tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
 130         visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err);
 131         if (err) {
 132             break;
 133         }
 134     }
 135
 136     if (!err) {
 137         visit_check_list(v, &err);
 138     }
 139     visit_end_list(v, (void **)obj);
 140     if (err && visit_is_input(v)) {
 141         qapi_free_%(c_name)s(*obj);
 142         *obj = NULL;
 143     }
 144 out:
 145     error_propagate(errp, err);
 146 }
 147 ''',
 148                  c_name=c_name(name), c_elt_type=element_type.c_name())
 149
 150
 151 def gen_visit_enum(name):
 152     return mcgen('''
 153
 154 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
 155 {
 156     int value = *obj;
 157     visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp);
 158     *obj = value;
 159 }
 160 ''',
 161                  c_name=c_name(name))
 162
 163
 164 def gen_visit_alternate(name, variants):
 165     ret = mcgen('''
 166
 167 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 168 {
 169     Error *err = NULL;
 170
 171     visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
 172                           &err);
 173     if (err) {
 174         goto out;
 175     }
 176     if (!*obj) {
 177         goto out_obj;
 178     }
 179     switch ((*obj)->type) {
 180 ''',
 181                  c_name=c_name(name))
 182
 183     for var in variants.variants:
 184         ret += mcgen('''
 185     case %(case)s:
 186 ''',
 187                      case=var.type.alternate_qtype())
 188         if isinstance(var.type, QAPISchemaObjectType):
 189             ret += mcgen('''
 190         visit_start_struct(v, name, NULL, 0, &err);
 191         if (err) {
 192             break;
 193         }
 194         visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
 195         if (!err) {
 196             visit_check_struct(v, &err);
 197         }
 198         visit_end_struct(v, NULL);
 199 ''',
 200                          c_type=var.type.c_name(),
 201                          c_name=c_name(var.name))
 202         else:
 203             ret += mcgen('''
 204         visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
 205 ''',
 206                          c_type=var.type.c_name(),
 207                          c_name=c_name(var.name))
 208         ret += mcgen('''
 209         break;
 210 ''')
 211
 212     ret += mcgen('''
 213     case QTYPE_NONE:
 214         abort();
 215     default:
 216         error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
 217                    "%(name)s");
 218     }
 219 out_obj:
 220     visit_end_alternate(v, (void **)obj);
 221     if (err && visit_is_input(v)) {
 222         qapi_free_%(c_name)s(*obj);
 223         *obj = NULL;
 224     }
 225 out:
 226     error_propagate(errp, err);
 227 }
 228 ''',
 229                  name=name, c_name=c_name(name))
 230
 231     return ret
 232
 233
 234 def gen_visit_object(name, base, members, variants):
 235     return mcgen('''
 236
 237 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 238 {
 239     Error *err = NULL;
 240
 241     visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
 242     if (err) {
 243         goto out;
 244     }
 245     if (!*obj) {
 246         goto out_obj;
 247     }
 248     visit_type_%(c_name)s_members(v, *obj, &err);
 249     if (err) {
 250         goto out_obj;
 251     }
 252     visit_check_struct(v, &err);
 253 out_obj:
 254     visit_end_struct(v, (void **)obj);
 255     if (err && visit_is_input(v)) {
 256         qapi_free_%(c_name)s(*obj);
 257         *obj = NULL;
 258     }
 259 out:
 260     error_propagate(errp, err);
 261 }
 262 ''',
 263                  c_name=c_name(name))
 264
 265
 266 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor):
 267     def __init__(self):
 268         self.decl = None
 269         self.defn = None
 270         self._btin = None
 271
 272     def visit_begin(self, schema):
 273         self.decl = ''
 274         self.defn = ''
 275         self._btin = guardstart('QAPI_VISIT_BUILTIN')
 276
 277     def visit_end(self):
 278         # To avoid header dependency hell, we always generate
 279         # declarations for built-in types in our header files and
 280         # simply guard them.  See also do_builtins (command line
 281         # option -b).
 282         self._btin += guardend('QAPI_VISIT_BUILTIN')
 283         self.decl = self._btin + self.decl
 284         self._btin = None
 285
 286     def visit_enum_type(self, name, info, values, prefix):
 287         # Special case for our lone builtin enum type
 288         # TODO use something cleaner than existence of info
 289         if not info:
 290             self._btin += gen_visit_decl(name, scalar=True)
 291             if do_builtins:
 292                 self.defn += gen_visit_enum(name)
 293         else:
 294             self.decl += gen_visit_decl(name, scalar=True)
 295             self.defn += gen_visit_enum(name)
 296
 297     def visit_array_type(self, name, info, element_type):
 298         decl = gen_visit_decl(name)
 299         defn = gen_visit_list(name, element_type)
 300         if isinstance(element_type, QAPISchemaBuiltinType):
 301             self._btin += decl
 302             if do_builtins:
 303                 self.defn += defn
 304         else:
 305             self.decl += decl
 306             self.defn += defn
 307
 308     def visit_object_type(self, name, info, base, members, variants):
 309         # Nothing to do for the special empty builtin
 310         if name == 'q_empty':
 311             return
 312         self.decl += gen_visit_members_decl(name)
 313         self.defn += gen_visit_object_members(name, base, members, variants)
 314         # TODO Worth changing the visitor signature, so we could
 315         # directly use rather than repeat type.is_implicit()?
 316         if not name.startswith('q_'):
 317             # only explicit types need an allocating visit
 318             self.decl += gen_visit_decl(name)
 319             self.defn += gen_visit_object(name, base, members, variants)
 320
 321     def visit_alternate_type(self, name, info, variants):
 322         self.decl += gen_visit_decl(name)
 323         self.defn += gen_visit_alternate(name, variants)
 324
 325 # If you link code generated from multiple schemata, you want only one
 326 # instance of the code for built-in types.  Generate it only when
 327 # do_builtins, enabled by command line option -b.  See also
 328 # QAPISchemaGenVisitVisitor.visit_end().
 329 do_builtins = False
 330
 331 (input_file, output_dir, do_c, do_h, prefix, opts) = \
 332     parse_command_line('b', ['builtins'])
 333
 334 for o, a in opts:
 335     if o in ('-b', '--builtins'):
 336         do_builtins = True
 337
 338 blurb = ' * Schema-defined QAPI visitors'
 339
 340 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
 341                             'qapi-visit.c', 'qapi-visit.h',
 342                             blurb, __doc__)
 343
 344 fdef.write(mcgen('''
 345 #include "qemu/osdep.h"
 346 #include "qemu-common.h"
 347 #include "qapi/error.h"
 348 #include "qapi/qmp/qerror.h"
 349 #include "%(prefix)sqapi-visit.h"
 350 ''',
 351                  prefix=prefix))
 352
 353 fdecl.write(mcgen('''
 354 #include "qapi/visitor.h"
 355 #include "%(prefix)sqapi-types.h"
 356
 357 ''',
 358                   prefix=prefix))
 359
 360 schema = QAPISchema(input_file)
 361 gen = QAPISchemaGenVisitVisitor()
 362 schema.visit(gen)
 363 fdef.write(gen.defn)
 364 fdecl.write(gen.decl)
 365
 366 close_output(fdef, fdecl)