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.
18 # visit_type_FOO_fields() is always emitted; track if a forward declaration
19 # or implementation has already been output.
20 struct_fields_seen
= set()
23 def gen_visit_decl(name
, scalar
=False):
24 c_type
= c_name(name
) + ' *'
28 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
30 c_name
=c_name(name
), c_type
=c_type
)
33 def gen_visit_fields_decl(typ
):
34 if typ
.name
in struct_fields_seen
:
36 struct_fields_seen
.add(typ
.name
)
39 static void visit_type_%(c_type)s_fields(Visitor *v, %(c_type)s *obj, Error **errp);
44 def gen_visit_struct_fields(name
, base
, members
, variants
):
48 ret
+= gen_visit_fields_decl(base
)
50 for var
in variants
.variants
:
51 # Ugly special case for simple union TODO get rid of it
52 if not var
.simple_union_type():
53 ret
+= gen_visit_fields_decl(var
.type)
55 struct_fields_seen
.add(name
)
58 static void visit_type_%(c_name)s_fields(Visitor *v, %(c_name)s *obj, Error **errp)
67 visit_type_%(c_type)s_fields(v, (%(c_type)s *)obj, &err);
70 ret
+= gen_err_check()
72 ret
+= gen_visit_fields(members
, prefix
='obj->')
76 switch (obj->%(c_name)s) {
78 c_name
=c_name(variants
.tag_member
.name
))
80 for var
in variants
.variants
:
81 # TODO ugly special case for simple union
82 simple_union_type
= var
.simple_union_type()
86 case
=c_enum_const(variants
.tag_member
.type.name
,
88 variants
.tag_member
.type.prefix
))
91 visit_type_%(c_type)s(v, "data", &obj->u.%(c_name)s, &err);
93 c_type
=simple_union_type
.c_name(),
94 c_name
=c_name(var
.name
))
97 visit_type_%(c_type)s_fields(v, &obj->u.%(c_name)s, &err);
99 c_type
=var
.type.c_name(),
100 c_name
=c_name(var
.name
))
111 # 'goto out' produced for base, by gen_visit_fields() for each member,
112 # and if variants were present
113 if base
or members
or variants
:
119 error_propagate(errp, err);
125 def gen_visit_list(name
, element_type
):
126 # FIXME: if *obj is NULL on entry, and the first visit_next_list()
127 # assigns to *obj, while a later one fails, we should clean up *obj
128 # rather than leaving it non-NULL. As currently written, the caller must
129 # call qapi_free_FOOList() to avoid a memory leak of the partial FOOList.
132 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
135 GenericList *i, **prev;
137 visit_start_list(v, name, &err);
142 for (prev = (GenericList **)obj;
143 !err && (i = visit_next_list(v, prev, sizeof(**obj))) != NULL;
145 %(c_name)s *native_i = (%(c_name)s *)i;
146 visit_type_%(c_elt_type)s(v, NULL, &native_i->value, &err);
151 error_propagate(errp, err);
154 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
157 def gen_visit_enum(name
):
160 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
163 visit_type_enum(v, name, &value, %(c_name)s_lookup, errp);
170 def gen_visit_alternate(name
, variants
):
173 for var
in variants
.variants
:
174 if var
.type.alternate_qtype() == 'QTYPE_QINT':
175 promote_int
= 'false'
176 if isinstance(var
.type, QAPISchemaObjectType
):
177 ret
+= gen_visit_fields_decl(var
.type)
181 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
185 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
186 %(promote_int)s, &err);
190 switch ((*obj)->type) {
192 c_name
=c_name(name
), promote_int
=promote_int
)
194 for var
in variants
.variants
:
198 case
=var
.type.alternate_qtype())
199 if isinstance(var
.type, QAPISchemaObjectType
):
201 visit_start_struct(v, name, NULL, 0, &err);
205 visit_type_%(c_type)s_fields(v, &(*obj)->u.%(c_name)s, &err);
206 error_propagate(errp, err);
208 visit_end_struct(v, &err);
210 c_type
=var
.type.c_name(),
211 c_name
=c_name(var
.name
))
214 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
216 c_type
=var
.type.c_name(),
217 c_name
=c_name(var
.name
))
224 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
227 visit_end_alternate(v);
229 error_propagate(errp, err);
237 def gen_visit_object(name
, base
, members
, variants
):
238 ret
= gen_visit_struct_fields(name
, base
, members
, variants
)
240 # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to
241 # *obj, but then visit_type_FOO_fields() fails, we should clean up *obj
242 # rather than leaving it non-NULL. As currently written, the caller must
243 # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
246 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
250 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
257 visit_type_%(c_name)s_fields(v, *obj, &err);
258 error_propagate(errp, err);
261 visit_end_struct(v, &err);
263 error_propagate(errp, err);
271 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor
):
277 def visit_begin(self
, schema
):
280 self
._btin
= guardstart('QAPI_VISIT_BUILTIN')
283 # To avoid header dependency hell, we always generate
284 # declarations for built-in types in our header files and
285 # simply guard them. See also do_builtins (command line
287 self
._btin
+= guardend('QAPI_VISIT_BUILTIN')
288 self
.decl
= self
._btin
+ self
.decl
291 def visit_needed(self
, entity
):
292 # Visit everything except implicit objects
293 return not (entity
.is_implicit() and
294 isinstance(entity
, QAPISchemaObjectType
))
296 def visit_enum_type(self
, name
, info
, values
, prefix
):
297 # Special case for our lone builtin enum type
298 # TODO use something cleaner than existence of info
300 self
._btin
+= gen_visit_decl(name
, scalar
=True)
302 self
.defn
+= gen_visit_enum(name
)
304 self
.decl
+= gen_visit_decl(name
, scalar
=True)
305 self
.defn
+= gen_visit_enum(name
)
307 def visit_array_type(self
, name
, info
, element_type
):
308 decl
= gen_visit_decl(name
)
309 defn
= gen_visit_list(name
, element_type
)
310 if isinstance(element_type
, QAPISchemaBuiltinType
):
318 def visit_object_type(self
, name
, info
, base
, members
, variants
):
319 self
.decl
+= gen_visit_decl(name
)
320 self
.defn
+= gen_visit_object(name
, base
, members
, variants
)
322 def visit_alternate_type(self
, name
, info
, variants
):
323 self
.decl
+= gen_visit_decl(name
)
324 self
.defn
+= gen_visit_alternate(name
, variants
)
326 # If you link code generated from multiple schemata, you want only one
327 # instance of the code for built-in types. Generate it only when
328 # do_builtins, enabled by command line option -b. See also
329 # QAPISchemaGenVisitVisitor.visit_end().
332 (input_file
, output_dir
, do_c
, do_h
, prefix
, opts
) = \
333 parse_command_line("b", ["builtins"])
336 if o
in ("-b", "--builtins"):
341 * schema-defined QAPI visitor functions
343 * Copyright IBM, Corp. 2011
346 * Anthony Liguori <aliguori@us.ibm.com>
348 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
349 * See the COPYING.LIB file in the top-level directory.
355 * schema-defined QAPI visitor functions
357 * Copyright IBM, Corp. 2011
360 * Anthony Liguori <aliguori@us.ibm.com>
362 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
363 * See the COPYING.LIB file in the top-level directory.
368 (fdef
, fdecl
) = open_output(output_dir
, do_c
, do_h
, prefix
,
369 'qapi-visit.c', 'qapi-visit.h',
370 c_comment
, h_comment
)
373 #include "qemu/osdep.h"
374 #include "qemu-common.h"
375 #include "%(prefix)sqapi-visit.h"
379 fdecl
.write(mcgen('''
380 #include "qapi/visitor.h"
381 #include "qapi/qmp/qerror.h"
382 #include "%(prefix)sqapi-types.h"
387 schema
= QAPISchema(input_file
)
388 gen
= QAPISchemaGenVisitVisitor()
391 fdecl
.write(gen
.decl
)
393 close_output(fdef
, fdecl
)