2 # QAPI visitor generator
4 # Copyright IBM, Corp. 2011
5 # Copyright (C) 2014-2015 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_implicit() is emitted as needed; track if it has already
20 implicit_structs_seen
= set()
22 # visit_type_FOO_fields() is always emitted; track if a forward declaration
23 # or implementation has already been output.
24 struct_fields_seen
= set()
27 def gen_visit_decl(name
, scalar
=False):
28 c_type
= c_name(name
) + ' *'
32 void visit_type_%(c_name)s(Visitor *v, %(c_type)sobj, const char *name, Error **errp);
34 c_name
=c_name(name
), c_type
=c_type
)
37 def gen_visit_fields_decl(typ
):
39 if typ
.name
not in struct_fields_seen
:
42 static void visit_type_%(c_type)s_fields(Visitor *v, %(c_type)s **obj, Error **errp);
45 struct_fields_seen
.add(typ
.name
)
49 def gen_visit_implicit_struct(typ
):
50 if typ
in implicit_structs_seen
:
52 implicit_structs_seen
.add(typ
)
54 ret
= gen_visit_fields_decl(typ
)
58 static void visit_type_implicit_%(c_type)s(Visitor *v, %(c_type)s **obj, Error **errp)
62 visit_start_implicit_struct(v, (void **)obj, sizeof(%(c_type)s), &err);
64 visit_type_%(c_type)s_fields(v, obj, errp);
65 visit_end_implicit_struct(v, &err);
67 error_propagate(errp, err);
74 def gen_visit_struct_fields(name
, base
, members
):
78 ret
+= gen_visit_fields_decl(base
)
80 struct_fields_seen
.add(name
)
83 static void visit_type_%(c_name)s_fields(Visitor *v, %(c_name)s **obj, Error **errp)
92 visit_type_%(c_type)s_fields(v, (%(c_type)s **)obj, &err);
95 ret
+= gen_err_check()
97 ret
+= gen_visit_fields(members
, prefix
='(*obj)->')
99 # 'goto out' produced for base, and by gen_visit_fields() for each member
106 error_propagate(errp, err);
112 def gen_visit_struct(name
, base
, members
):
113 ret
= gen_visit_struct_fields(name
, base
, members
)
115 # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to
116 # *obj, but then visit_type_FOO_fields() fails, we should clean up *obj
117 # rather than leaving it non-NULL. As currently written, the caller must
118 # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
121 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
125 visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
128 visit_type_%(c_name)s_fields(v, obj, errp);
130 visit_end_struct(v, &err);
132 error_propagate(errp, err);
135 name
=name
, c_name
=c_name(name
))
140 def gen_visit_list(name
, element_type
):
143 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
146 GenericList *i, **prev;
148 visit_start_list(v, name, &err);
153 for (prev = (GenericList **)obj;
154 !err && (i = visit_next_list(v, prev, &err)) != NULL;
156 %(c_name)s *native_i = (%(c_name)s *)i;
157 visit_type_%(c_elt_type)s(v, &native_i->value, NULL, &err);
160 error_propagate(errp, err);
162 visit_end_list(v, &err);
164 error_propagate(errp, err);
167 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
170 def gen_visit_enum(name
):
173 void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp)
175 visit_type_enum(v, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
178 c_name
=c_name(name
), name
=name
)
181 def gen_visit_alternate(name
, variants
):
184 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
188 visit_start_implicit_struct(v, (void**) obj, sizeof(%(c_name)s), &err);
192 visit_get_next_type(v, (int*) &(*obj)->type, %(c_name)s_qtypes, name, &err);
196 switch ((*obj)->type) {
200 for var
in variants
.variants
:
203 visit_type_%(c_type)s(v, &(*obj)->u.%(c_name)s, name, &err);
206 case
=c_enum_const(variants
.tag_member
.type.name
,
208 c_type
=var
.type.c_name(),
209 c_name
=c_name(var
.name
))
216 error_propagate(errp, err);
218 visit_end_implicit_struct(v, &err);
220 error_propagate(errp, err);
227 def gen_visit_union(name
, base
, variants
):
231 ret
+= gen_visit_fields_decl(base
)
233 for var
in variants
.variants
:
234 # Ugly special case for simple union TODO get rid of it
235 if not var
.simple_union_type():
236 ret
+= gen_visit_implicit_struct(var
.type)
240 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
244 visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
252 c_name
=c_name(name
), name
=name
)
256 visit_type_%(c_name)s_fields(v, (%(c_name)s **)obj, &err);
258 c_name
=base
.c_name())
261 visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "%(name)s", &err);
263 c_type
=variants
.tag_member
.type.c_name(),
264 c_name
=c_name(variants
.tag_member
.name
),
265 name
=variants
.tag_member
.name
)
266 ret
+= gen_err_check(label
='out_obj')
268 if (!visit_start_union(v, !!(*obj)->u.data, &err) || err) {
271 switch ((*obj)->%(c_name)s) {
273 c_name
=c_name(variants
.tag_member
.name
))
275 for var
in variants
.variants
:
276 # TODO ugly special case for simple union
277 simple_union_type
= var
.simple_union_type()
281 case
=c_enum_const(variants
.tag_member
.type.name
,
283 if simple_union_type
:
285 visit_type_%(c_type)s(v, &(*obj)->u.%(c_name)s, "data", &err);
287 c_type
=simple_union_type
.c_name(),
288 c_name
=c_name(var
.name
))
291 visit_type_implicit_%(c_type)s(v, &(*obj)->u.%(c_name)s, &err);
293 c_type
=var
.type.c_name(),
294 c_name
=c_name(var
.name
))
304 error_propagate(errp, err);
307 visit_end_union(v, !!(*obj)->u.data, &err);
309 error_propagate(errp, err);
311 visit_end_struct(v, &err);
313 error_propagate(errp, err);
320 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor
):
326 def visit_begin(self
, schema
):
329 self
._btin
= guardstart('QAPI_VISIT_BUILTIN')
332 # To avoid header dependency hell, we always generate
333 # declarations for built-in types in our header files and
334 # simply guard them. See also do_builtins (command line
336 self
._btin
+= guardend('QAPI_VISIT_BUILTIN')
337 self
.decl
= self
._btin
+ self
.decl
340 def visit_needed(self
, entity
):
341 # Visit everything except implicit objects
342 return not (entity
.is_implicit() and
343 isinstance(entity
, QAPISchemaObjectType
))
345 def visit_enum_type(self
, name
, info
, values
, prefix
):
346 self
.decl
+= gen_visit_decl(name
, scalar
=True)
347 self
.defn
+= gen_visit_enum(name
)
349 def visit_array_type(self
, name
, info
, element_type
):
350 decl
= gen_visit_decl(name
)
351 defn
= gen_visit_list(name
, element_type
)
352 if isinstance(element_type
, QAPISchemaBuiltinType
):
360 def visit_object_type(self
, name
, info
, base
, members
, variants
):
361 self
.decl
+= gen_visit_decl(name
)
363 assert not members
# not implemented
364 self
.defn
+= gen_visit_union(name
, base
, variants
)
366 self
.defn
+= gen_visit_struct(name
, base
, members
)
368 def visit_alternate_type(self
, name
, info
, variants
):
369 self
.decl
+= gen_visit_decl(name
)
370 self
.defn
+= gen_visit_alternate(name
, variants
)
372 # If you link code generated from multiple schemata, you want only one
373 # instance of the code for built-in types. Generate it only when
374 # do_builtins, enabled by command line option -b. See also
375 # QAPISchemaGenVisitVisitor.visit_end().
378 (input_file
, output_dir
, do_c
, do_h
, prefix
, opts
) = \
379 parse_command_line("b", ["builtins"])
382 if o
in ("-b", "--builtins"):
387 * schema-defined QAPI visitor functions
389 * Copyright IBM, Corp. 2011
392 * Anthony Liguori <aliguori@us.ibm.com>
394 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
395 * See the COPYING.LIB file in the top-level directory.
401 * schema-defined QAPI visitor functions
403 * Copyright IBM, Corp. 2011
406 * Anthony Liguori <aliguori@us.ibm.com>
408 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
409 * See the COPYING.LIB file in the top-level directory.
414 (fdef
, fdecl
) = open_output(output_dir
, do_c
, do_h
, prefix
,
415 'qapi-visit.c', 'qapi-visit.h',
416 c_comment
, h_comment
)
419 #include "qemu-common.h"
420 #include "%(prefix)sqapi-visit.h"
424 fdecl
.write(mcgen('''
425 #include "qapi/visitor.h"
426 #include "%(prefix)sqapi-types.h"
431 schema
= QAPISchema(input_file
)
432 gen
= QAPISchemaGenVisitVisitor()
435 fdecl
.write(gen
.decl
)
437 close_output(fdef
, fdecl
)