4 Copyright IBM, Corp. 2011
5 Copyright (C) 2014-2018 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.
16 from qapi
.common
import *
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);
57 ret
+= gen_if(memb
.ifcond
)
60 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
62 name
=memb
.name
, c_name
=c_name(memb
.name
))
65 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
70 c_type
=memb
.type.c_name(), name
=memb
.name
,
71 c_name
=c_name(memb
.name
))
77 ret
+= gen_endif(memb
.ifcond
)
81 switch (obj->%(c_name)s) {
83 c_name
=c_name(variants
.tag_member
.name
))
85 for var
in variants
.variants
:
86 case_str
= c_enum_const(variants
.tag_member
.type.name
,
88 variants
.tag_member
.type.prefix
)
89 ret
+= gen_if(var
.ifcond
)
90 if var
.type.name
== 'q_empty':
91 # valid variant and nothing to do
100 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
104 c_type
=var
.type.c_name(), c_name
=c_name(var
.name
))
106 ret
+= gen_endif(var
.ifcond
)
113 # 'goto out' produced for base, for each member, and if variants were
115 if base
or members
or variants
:
121 error_propagate(errp, err);
127 def gen_visit_list(name
, element_type
):
130 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
134 size_t size = sizeof(**obj);
136 visit_start_list(v, name, (GenericList **)obj, size, &err);
141 for (tail = *obj; tail;
142 tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
143 visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err);
150 visit_check_list(v, &err);
152 visit_end_list(v, (void **)obj);
153 if (err && visit_is_input(v)) {
154 qapi_free_%(c_name)s(*obj);
158 error_propagate(errp, err);
161 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
164 def gen_visit_enum(name
):
167 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
170 visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp);
177 def gen_visit_alternate(name
, variants
):
180 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
184 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
192 switch ((*obj)->type) {
196 for var
in variants
.variants
:
197 ret
+= gen_if(var
.ifcond
)
201 case
=var
.type.alternate_qtype())
202 if isinstance(var
.type, QAPISchemaObjectType
):
204 visit_start_struct(v, name, NULL, 0, &err);
208 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
210 visit_check_struct(v, &err);
212 visit_end_struct(v, NULL);
214 c_type
=var
.type.c_name(),
215 c_name
=c_name(var
.name
))
218 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
220 c_type
=var
.type.c_name(),
221 c_name
=c_name(var
.name
))
225 ret
+= gen_endif(var
.ifcond
)
231 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
235 visit_end_alternate(v, (void **)obj);
236 if (err && visit_is_input(v)) {
237 qapi_free_%(c_name)s(*obj);
241 error_propagate(errp, err);
244 name
=name
, c_name
=c_name(name
))
249 def gen_visit_object(name
, base
, members
, variants
):
252 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
256 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
263 visit_type_%(c_name)s_members(v, *obj, &err);
267 visit_check_struct(v, &err);
269 visit_end_struct(v, (void **)obj);
270 if (err && visit_is_input(v)) {
271 qapi_free_%(c_name)s(*obj);
275 error_propagate(errp, err);
281 class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor
):
283 def __init__(self
, prefix
):
284 QAPISchemaModularCVisitor
.__init
__(
285 self
, prefix
, 'qapi-visit', ' * Schema-defined QAPI visitors',
287 self
._add
_system
_module
(None, ' * Built-in QAPI visitors')
288 self
._genc
.preamble_add(mcgen('''
289 #include "qemu/osdep.h"
290 #include "qemu-common.h"
291 #include "qapi/error.h"
292 #include "qapi/qapi-builtin-visit.h"
294 self
._genh
.preamble_add(mcgen('''
295 #include "qapi/visitor.h"
296 #include "qapi/qapi-builtin-types.h"
301 def _begin_user_module(self
, name
):
302 types
= self
._module
_basename
('qapi-types', name
)
303 visit
= self
._module
_basename
('qapi-visit', name
)
304 self
._genc
.preamble_add(mcgen('''
305 #include "qemu/osdep.h"
306 #include "qemu-common.h"
307 #include "qapi/error.h"
308 #include "qapi/qmp/qerror.h"
309 #include "%(visit)s.h"
312 self
._genh
.preamble_add(mcgen('''
313 #include "qapi/qapi-builtin-visit.h"
314 #include "%(types)s.h"
319 def visit_enum_type(self
, name
, info
, ifcond
, members
, prefix
):
320 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
321 self
._genh
.add(gen_visit_decl(name
, scalar
=True))
322 self
._genc
.add(gen_visit_enum(name
))
324 def visit_array_type(self
, name
, info
, ifcond
, element_type
):
325 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
326 self
._genh
.add(gen_visit_decl(name
))
327 self
._genc
.add(gen_visit_list(name
, element_type
))
329 def visit_object_type(self
, name
, info
, ifcond
, base
, members
, variants
):
330 # Nothing to do for the special empty builtin
331 if name
== 'q_empty':
333 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
334 self
._genh
.add(gen_visit_members_decl(name
))
335 self
._genc
.add(gen_visit_object_members(name
, base
,
337 # TODO Worth changing the visitor signature, so we could
338 # directly use rather than repeat type.is_implicit()?
339 if not name
.startswith('q_'):
340 # only explicit types need an allocating visit
341 self
._genh
.add(gen_visit_decl(name
))
342 self
._genc
.add(gen_visit_object(name
, base
, members
, variants
))
344 def visit_alternate_type(self
, name
, info
, ifcond
, variants
):
345 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
346 self
._genh
.add(gen_visit_decl(name
))
347 self
._genc
.add(gen_visit_alternate(name
, variants
))
350 def gen_visit(schema
, output_dir
, prefix
, opt_builtins
):
351 vis
= QAPISchemaGenVisitVisitor(prefix
)
353 vis
.write(output_dir
, opt_builtins
)