]>
git.proxmox.com Git - mirror_qemu.git/blob - scripts/qapi-visit.py
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 implicit_structs_seen
= set()
19 struct_fields_seen
= set()
22 def gen_visit_decl(name
, scalar
=False):
23 c_type
= c_name(name
) + ' *'
27 void visit_type_%(c_name)s(Visitor *v, %(c_type)sobj, const char *name, Error **errp);
29 c_name
=c_name(name
), c_type
=c_type
)
32 def gen_visit_implicit_struct(typ
):
33 if typ
in implicit_structs_seen
:
35 implicit_structs_seen
.add(typ
)
38 if typ
.name
not in struct_fields_seen
:
39 # Need a forward declaration
42 static void visit_type_%(c_type)s_fields(Visitor *v, %(c_type)s **obj, Error **errp);
48 static void visit_type_implicit_%(c_type)s(Visitor *v, %(c_type)s **obj, Error **errp)
52 visit_start_implicit_struct(v, (void **)obj, sizeof(%(c_type)s), &err);
54 visit_type_%(c_type)s_fields(v, obj, errp);
55 visit_end_implicit_struct(v, &err);
57 error_propagate(errp, err);
64 def gen_visit_struct_fields(name
, base
, members
):
65 struct_fields_seen
.add(name
)
70 ret
+= gen_visit_implicit_struct(base
)
74 static void visit_type_%(c_name)s_fields(Visitor *v, %(c_name)s **obj, Error **errp)
84 visit_type_implicit_%(c_type)s(v, &(*obj)->%(c_name)s, &err);
89 c_type
=base
.c_name(), c_name
=c_name('base'))
94 visit_optional(v, &(*obj)->has_%(c_name)s, "%(name)s", &err);
95 if (!err && (*obj)->has_%(c_name)s) {
97 c_name
=c_name(memb
.name
), name
=memb
.name
)
101 visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "%(name)s", &err);
103 c_type
=memb
.type.c_name(), c_name
=c_name(memb
.name
),
118 if re
.search('^ *goto out;', ret
, re
.MULTILINE
):
124 error_propagate(errp, err);
130 def gen_visit_struct(name
, base
, members
):
131 ret
= gen_visit_struct_fields(name
, base
, members
)
133 # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to
134 # *obj, but then visit_type_FOO_fields() fails, we should clean up *obj
135 # rather than leaving it non-NULL. As currently written, the caller must
136 # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
139 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
143 visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
146 visit_type_%(c_name)s_fields(v, obj, errp);
148 visit_end_struct(v, &err);
150 error_propagate(errp, err);
153 name
=name
, c_name
=c_name(name
))
158 def gen_visit_list(name
, element_type
):
161 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
164 GenericList *i, **prev;
166 visit_start_list(v, name, &err);
171 for (prev = (GenericList **)obj;
172 !err && (i = visit_next_list(v, prev, &err)) != NULL;
174 %(c_name)s *native_i = (%(c_name)s *)i;
175 visit_type_%(c_elt_type)s(v, &native_i->value, NULL, &err);
178 error_propagate(errp, err);
180 visit_end_list(v, &err);
182 error_propagate(errp, err);
185 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
188 def gen_visit_enum(name
):
191 void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp)
193 visit_type_enum(v, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
196 c_name
=c_name(name
), name
=name
)
199 def gen_visit_alternate(name
, variants
):
202 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
206 visit_start_implicit_struct(v, (void**) obj, sizeof(%(c_name)s), &err);
210 visit_get_next_type(v, (int*) &(*obj)->kind, %(c_name)s_qtypes, name, &err);
214 switch ((*obj)->kind) {
218 for var
in variants
.variants
:
221 visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, name, &err);
224 case
=c_enum_const(variants
.tag_member
.type.name
,
226 c_type
=var
.type.c_name(),
227 c_name
=c_name(var
.name
))
234 error_propagate(errp, err);
236 visit_end_implicit_struct(v, &err);
238 error_propagate(errp, err);
245 def gen_visit_union(name
, base
, variants
):
249 members
= [m
for m
in base
.members
if m
!= variants
.tag_member
]
250 ret
+= gen_visit_struct_fields(name
, None, members
)
252 for var
in variants
.variants
:
253 # Ugly special case for simple union TODO get rid of it
254 if not var
.simple_union_type():
255 ret
+= gen_visit_implicit_struct(var
.type)
259 void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
263 visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
269 c_name
=c_name(name
), name
=name
)
273 visit_type_%(c_name)s_fields(v, obj, &err);
280 tag_key
= variants
.tag_member
.name
281 if not variants
.tag_name
:
282 # we pointlessly use a different key for simple unions
285 visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "%(name)s", &err);
289 if (!visit_start_union(v, !!(*obj)->data, &err) || err) {
292 switch ((*obj)->%(c_name)s) {
294 c_type
=variants
.tag_member
.type.c_name(),
295 # TODO ugly special case for simple union
296 # Use same tag name in C as on the wire to get rid of
297 # it, then: c_name=c_name(variants.tag_member.name)
298 c_name
=c_name(variants
.tag_name
or 'kind'),
301 for var
in variants
.variants
:
302 # TODO ugly special case for simple union
303 simple_union_type
= var
.simple_union_type()
307 case
=c_enum_const(variants
.tag_member
.type.name
,
309 if simple_union_type
:
311 visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "data", &err);
313 c_type
=simple_union_type
.c_name(),
314 c_name
=c_name(var
.name
))
317 visit_type_implicit_%(c_type)s(v, &(*obj)->%(c_name)s, &err);
319 c_type
=var
.type.c_name(),
320 c_name
=c_name(var
.name
))
330 error_propagate(errp, err);
332 visit_end_union(v, !!(*obj)->data, &err);
333 error_propagate(errp, err);
336 visit_end_struct(v, &err);
338 error_propagate(errp, err);
345 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor
):
351 def visit_begin(self
, schema
):
354 self
._btin
= guardstart('QAPI_VISIT_BUILTIN')
357 # To avoid header dependency hell, we always generate
358 # declarations for built-in types in our header files and
359 # simply guard them. See also do_builtins (command line
361 self
._btin
+= guardend('QAPI_VISIT_BUILTIN')
362 self
.decl
= self
._btin
+ self
.decl
365 def visit_enum_type(self
, name
, info
, values
, prefix
):
366 self
.decl
+= gen_visit_decl(name
, scalar
=True)
367 self
.defn
+= gen_visit_enum(name
)
369 def visit_array_type(self
, name
, info
, element_type
):
370 decl
= gen_visit_decl(name
)
371 defn
= gen_visit_list(name
, element_type
)
372 if isinstance(element_type
, QAPISchemaBuiltinType
):
380 def visit_object_type(self
, name
, info
, base
, members
, variants
):
382 self
.decl
+= gen_visit_decl(name
)
384 assert not members
# not implemented
385 self
.defn
+= gen_visit_union(name
, base
, variants
)
387 self
.defn
+= gen_visit_struct(name
, base
, members
)
389 def visit_alternate_type(self
, name
, info
, variants
):
390 self
.decl
+= gen_visit_decl(name
)
391 self
.defn
+= gen_visit_alternate(name
, variants
)
393 # If you link code generated from multiple schemata, you want only one
394 # instance of the code for built-in types. Generate it only when
395 # do_builtins, enabled by command line option -b. See also
396 # QAPISchemaGenVisitVisitor.visit_end().
399 (input_file
, output_dir
, do_c
, do_h
, prefix
, opts
) = \
400 parse_command_line("b", ["builtins"])
403 if o
in ("-b", "--builtins"):
408 * schema-defined QAPI visitor functions
410 * Copyright IBM, Corp. 2011
413 * Anthony Liguori <aliguori@us.ibm.com>
415 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
416 * See the COPYING.LIB file in the top-level directory.
422 * schema-defined QAPI visitor functions
424 * Copyright IBM, Corp. 2011
427 * Anthony Liguori <aliguori@us.ibm.com>
429 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
430 * See the COPYING.LIB file in the top-level directory.
435 (fdef
, fdecl
) = open_output(output_dir
, do_c
, do_h
, prefix
,
436 'qapi-visit.c', 'qapi-visit.h',
437 c_comment
, h_comment
)
440 #include "qemu-common.h"
441 #include "%(prefix)sqapi-visit.h"
445 fdecl
.write(mcgen('''
446 #include "qapi/visitor.h"
447 #include "%(prefix)sqapi-types.h"
452 schema
= QAPISchema(input_file
)
453 gen
= QAPISchemaGenVisitVisitor()
456 fdecl
.write(gen
.decl
)
458 close_output(fdef
, fdecl
)