]>
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-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);
59 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
61 name
=memb
.name
, c_name
=c_name(memb
.name
))
64 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
69 c_type
=memb
.type.c_name(), name
=memb
.name
,
70 c_name
=c_name(memb
.name
))
79 switch (obj->%(c_name)s) {
81 c_name
=c_name(variants
.tag_member
.name
))
83 for var
in variants
.variants
:
86 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
89 case
=c_enum_const(variants
.tag_member
.type.name
,
91 variants
.tag_member
.type.prefix
),
92 c_type
=var
.type.c_name(), c_name
=c_name(var
.name
))
100 # 'goto out' produced for base, for each member, and if variants were
102 if base
or members
or variants
:
108 error_propagate(errp, err);
114 def gen_visit_list(name
, element_type
):
117 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
121 size_t size = sizeof(**obj);
123 visit_start_list(v, name, (GenericList **)obj, size, &err);
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);
137 visit_check_list(v, &err);
139 visit_end_list(v, (void **)obj);
140 if (err && visit_is_input(v)) {
141 qapi_free_%(c_name)s(*obj);
145 error_propagate(errp, err);
148 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
151 def gen_visit_enum(name
):
154 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
157 visit_type_enum(v, name, &value, %(c_name)s_lookup, errp);
164 def gen_visit_alternate(name
, variants
):
167 for var
in variants
.variants
:
168 if var
.type.alternate_qtype() == 'QTYPE_QINT':
169 promote_int
= 'false'
173 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
177 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
178 %(promote_int)s, &err);
185 switch ((*obj)->type) {
187 c_name
=c_name(name
), promote_int
=promote_int
)
189 for var
in variants
.variants
:
193 case
=var
.type.alternate_qtype())
194 if isinstance(var
.type, QAPISchemaObjectType
):
196 visit_start_struct(v, name, NULL, 0, &err);
200 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
202 visit_check_struct(v, &err);
204 visit_end_struct(v, NULL);
206 c_type
=var
.type.c_name(),
207 c_name
=c_name(var
.name
))
210 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
212 c_type
=var
.type.c_name(),
213 c_name
=c_name(var
.name
))
222 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
226 visit_end_alternate(v, (void **)obj);
227 if (err && visit_is_input(v)) {
228 qapi_free_%(c_name)s(*obj);
232 error_propagate(errp, err);
235 name
=name
, c_name
=c_name(name
))
240 def gen_visit_object(name
, base
, members
, variants
):
243 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
247 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
254 visit_type_%(c_name)s_members(v, *obj, &err);
258 visit_check_struct(v, &err);
260 visit_end_struct(v, (void **)obj);
261 if (err && visit_is_input(v)) {
262 qapi_free_%(c_name)s(*obj);
266 error_propagate(errp, err);
272 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor
):
278 def visit_begin(self
, schema
):
281 self
._btin
= guardstart('QAPI_VISIT_BUILTIN')
284 # To avoid header dependency hell, we always generate
285 # declarations for built-in types in our header files and
286 # simply guard them. See also do_builtins (command line
288 self
._btin
+= guardend('QAPI_VISIT_BUILTIN')
289 self
.decl
= self
._btin
+ self
.decl
292 def visit_enum_type(self
, name
, info
, values
, prefix
):
293 # Special case for our lone builtin enum type
294 # TODO use something cleaner than existence of info
296 self
._btin
+= gen_visit_decl(name
, scalar
=True)
298 self
.defn
+= gen_visit_enum(name
)
300 self
.decl
+= gen_visit_decl(name
, scalar
=True)
301 self
.defn
+= gen_visit_enum(name
)
303 def visit_array_type(self
, name
, info
, element_type
):
304 decl
= gen_visit_decl(name
)
305 defn
= gen_visit_list(name
, element_type
)
306 if isinstance(element_type
, QAPISchemaBuiltinType
):
314 def visit_object_type(self
, name
, info
, base
, members
, variants
):
315 # Nothing to do for the special empty builtin
316 if name
== 'q_empty':
318 self
.decl
+= gen_visit_members_decl(name
)
319 self
.defn
+= gen_visit_object_members(name
, base
, members
, variants
)
320 # TODO Worth changing the visitor signature, so we could
321 # directly use rather than repeat type.is_implicit()?
322 if not name
.startswith('q_'):
323 # only explicit types need an allocating visit
324 self
.decl
+= gen_visit_decl(name
)
325 self
.defn
+= gen_visit_object(name
, base
, members
, variants
)
327 def visit_alternate_type(self
, name
, info
, variants
):
328 self
.decl
+= gen_visit_decl(name
)
329 self
.defn
+= gen_visit_alternate(name
, variants
)
331 # If you link code generated from multiple schemata, you want only one
332 # instance of the code for built-in types. Generate it only when
333 # do_builtins, enabled by command line option -b. See also
334 # QAPISchemaGenVisitVisitor.visit_end().
337 (input_file
, output_dir
, do_c
, do_h
, prefix
, opts
) = \
338 parse_command_line('b', ['builtins'])
341 if o
in ('-b', '--builtins'):
346 * schema-defined QAPI visitor functions
348 * Copyright IBM, Corp. 2011
351 * Anthony Liguori <aliguori@us.ibm.com>
353 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
354 * See the COPYING.LIB file in the top-level directory.
360 * schema-defined QAPI visitor functions
362 * Copyright IBM, Corp. 2011
365 * Anthony Liguori <aliguori@us.ibm.com>
367 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
368 * See the COPYING.LIB file in the top-level directory.
373 (fdef
, fdecl
) = open_output(output_dir
, do_c
, do_h
, prefix
,
374 'qapi-visit.c', 'qapi-visit.h',
375 c_comment
, h_comment
)
378 #include "qemu/osdep.h"
379 #include "qemu-common.h"
380 #include "qapi/error.h"
381 #include "%(prefix)sqapi-visit.h"
385 fdecl
.write(mcgen('''
386 #include "qapi/visitor.h"
387 #include "qapi/qmp/qerror.h"
388 #include "%(prefix)sqapi-types.h"
393 schema
= QAPISchema(input_file
)
394 gen
= QAPISchemaGenVisitVisitor()
397 fdecl
.write(gen
.decl
)
399 close_output(fdef
, fdecl
)