2 # QAPI visitor generator
4 # Copyright IBM, Corp. 2011
5 # Copyright (C) 2014-2016 Red Hat, Inc.
8 # Anthony Liguori <aliguori@us.ibm.com>
9 # Michael Roth <mdroth@linux.vnet.ibm.com>
10 # Markus Armbruster <armbru@redhat.com>
12 # This work is licensed under the terms of the GNU GPL, version 2.
13 # See the COPYING file in the top-level directory.
19 def gen_visit_decl(name, scalar=False):
20 c_type = c_name(name) + ' *'
24 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
26 c_name=c_name(name), c_type=c_type)
29 def gen_visit_members_decl(name):
32 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
37 def gen_visit_object_members(name, base, members, variants):
40 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
49 visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err);
52 ret += gen_err_check()
57 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
59 name=memb.name, c_name=c_name(memb.name))
62 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
64 c_type=memb.type.c_name(), name=memb.name,
65 c_name=c_name(memb.name))
66 ret += gen_err_check()
75 switch (obj->%(c_name)s) {
77 c_name=c_name(variants.tag_member.name))
79 for var in variants.variants:
82 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
85 case=c_enum_const(variants.tag_member.type.name,
87 variants.tag_member.type.prefix),
88 c_type=var.type.c_name(), c_name=c_name(var.name))
96 # 'goto out' produced for base, for each member, and if variants were
98 if base or members or variants:
104 error_propagate(errp, err);
110 def gen_visit_list(name, element_type):
111 # FIXME: if *obj is NULL on entry, and the first visit_next_list()
112 # assigns to *obj, while a later one fails, we should clean up *obj
113 # rather than leaving it non-NULL. As currently written, the caller must
114 # call qapi_free_FOOList() to avoid a memory leak of the partial FOOList.
117 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
120 GenericList *i, **prev;
122 visit_start_list(v, name, &err);
127 for (prev = (GenericList **)obj;
128 !err && (i = visit_next_list(v, prev, sizeof(**obj))) != NULL;
130 %(c_name)s *native_i = (%(c_name)s *)i;
131 visit_type_%(c_elt_type)s(v, NULL, &native_i->value, &err);
136 error_propagate(errp, err);
139 c_name=c_name(name), c_elt_type=element_type.c_name())
142 def gen_visit_enum(name):
145 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
148 visit_type_enum(v, name, &value, %(c_name)s_lookup, errp);
155 def gen_visit_alternate(name, variants):
158 for var in variants.variants:
159 if var.type.alternate_qtype() == 'QTYPE_QINT':
160 promote_int = 'false'
164 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
168 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
169 %(promote_int)s, &err);
173 switch ((*obj)->type) {
175 c_name=c_name(name), promote_int=promote_int)
177 for var in variants.variants:
181 case=var.type.alternate_qtype())
182 if isinstance(var.type, QAPISchemaObjectType):
184 visit_start_struct(v, name, NULL, 0, &err);
188 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
189 error_propagate(errp, err);
191 visit_end_struct(v, &err);
193 c_type=var.type.c_name(),
194 c_name=c_name(var.name))
197 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
199 c_type=var.type.c_name(),
200 c_name=c_name(var.name))
207 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
210 visit_end_alternate(v);
212 error_propagate(errp, err);
220 def gen_visit_object(name, base, members, variants):
221 # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to
222 # *obj, but then visit_type_FOO_members() fails, we should clean up *obj
223 # rather than leaving it non-NULL. As currently written, the caller must
224 # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
227 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
231 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
238 visit_type_%(c_name)s_members(v, *obj, &err);
239 error_propagate(errp, err);
242 visit_end_struct(v, &err);
244 error_propagate(errp, err);
250 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor):
256 def visit_begin(self, schema):
259 self._btin = guardstart('QAPI_VISIT_BUILTIN')
262 # To avoid header dependency hell, we always generate
263 # declarations for built-in types in our header files and
264 # simply guard them. See also do_builtins (command line
266 self._btin += guardend('QAPI_VISIT_BUILTIN')
267 self.decl = self._btin + self.decl
270 def visit_enum_type(self, name, info, values, prefix):
271 # Special case for our lone builtin enum type
272 # TODO use something cleaner than existence of info
274 self._btin += gen_visit_decl(name, scalar=True)
276 self.defn += gen_visit_enum(name)
278 self.decl += gen_visit_decl(name, scalar=True)
279 self.defn += gen_visit_enum(name)
281 def visit_array_type(self, name, info, element_type):
282 decl = gen_visit_decl(name)
283 defn = gen_visit_list(name, element_type)
284 if isinstance(element_type, QAPISchemaBuiltinType):
292 def visit_object_type(self, name, info, base, members, variants):
293 # Nothing to do for the special empty builtin
294 if name == 'q_empty':
296 self.decl += gen_visit_members_decl(name)
297 self.defn += gen_visit_object_members(name, base, members, variants)
298 # TODO Worth changing the visitor signature, so we could
299 # directly use rather than repeat type.is_implicit()?
300 if not name.startswith('q_'):
301 # only explicit types need an allocating visit
302 self.decl += gen_visit_decl(name)
303 self.defn += gen_visit_object(name, base, members, variants)
305 def visit_alternate_type(self, name, info, variants):
306 self.decl += gen_visit_decl(name)
307 self.defn += gen_visit_alternate(name, variants)
309 # If you link code generated from multiple schemata, you want only one
310 # instance of the code for built-in types. Generate it only when
311 # do_builtins, enabled by command line option -b. See also
312 # QAPISchemaGenVisitVisitor.visit_end().
315 (input_file, output_dir, do_c, do_h, prefix, opts) = \
316 parse_command_line("b", ["builtins"])
319 if o in ("-b", "--builtins"):
324 * schema-defined QAPI visitor functions
326 * Copyright IBM, Corp. 2011
329 * Anthony Liguori <aliguori@us.ibm.com>
331 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
332 * See the COPYING.LIB file in the top-level directory.
338 * schema-defined QAPI visitor functions
340 * Copyright IBM, Corp. 2011
343 * Anthony Liguori <aliguori@us.ibm.com>
345 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
346 * See the COPYING.LIB file in the top-level directory.
351 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
352 'qapi-visit.c', 'qapi-visit.h',
353 c_comment, h_comment)
356 #include "qemu/osdep.h"
357 #include "qemu-common.h"
358 #include "qapi/error.h"
359 #include "%(prefix)sqapi-visit.h"
363 fdecl.write(mcgen('''
364 #include "qapi/visitor.h"
365 #include "qapi/qmp/qerror.h"
366 #include "%(prefix)sqapi-types.h"
371 schema = QAPISchema(input_file)
372 gen = QAPISchemaGenVisitVisitor()
375 fdecl.write(gen.decl)
377 close_output(fdef, fdecl)