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 *
17 from qapi
.gen
import QAPISchemaModularCVisitor
, ifcontext
18 from qapi
.schema
import QAPISchemaObjectType
21 def gen_visit_decl(name
, scalar
=False):
22 c_type
= c_name(name
) + ' *'
26 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
28 c_name
=c_name(name
), c_type
=c_type
)
31 def gen_visit_members_decl(name
):
34 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
39 def gen_visit_object_members(name
, base
, members
, variants
):
42 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
51 visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err);
59 ret
+= gen_if(memb
.ifcond
)
62 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
64 name
=memb
.name
, c_name
=c_name(memb
.name
))
67 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
72 c_type
=memb
.type.c_name(), name
=memb
.name
,
73 c_name
=c_name(memb
.name
))
79 ret
+= gen_endif(memb
.ifcond
)
83 switch (obj->%(c_name)s) {
85 c_name
=c_name(variants
.tag_member
.name
))
87 for var
in variants
.variants
:
88 case_str
= c_enum_const(variants
.tag_member
.type.name
,
90 variants
.tag_member
.type.prefix
)
91 ret
+= gen_if(var
.ifcond
)
92 if var
.type.name
== 'q_empty':
93 # valid variant and nothing to do
102 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
106 c_type
=var
.type.c_name(), c_name
=c_name(var
.name
))
108 ret
+= gen_endif(var
.ifcond
)
115 # 'goto out' produced for base, for each member, and if variants were
117 if base
or members
or variants
:
123 error_propagate(errp, err);
129 def gen_visit_list(name
, element_type
):
132 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
136 size_t size = sizeof(**obj);
138 visit_start_list(v, name, (GenericList **)obj, size, &err);
143 for (tail = *obj; tail;
144 tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
145 visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err);
152 visit_check_list(v, &err);
154 visit_end_list(v, (void **)obj);
155 if (err && visit_is_input(v)) {
156 qapi_free_%(c_name)s(*obj);
160 error_propagate(errp, err);
163 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
166 def gen_visit_enum(name
):
169 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
172 visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp);
179 def gen_visit_alternate(name
, variants
):
182 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
186 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
194 switch ((*obj)->type) {
198 for var
in variants
.variants
:
199 ret
+= gen_if(var
.ifcond
)
203 case
=var
.type.alternate_qtype())
204 if isinstance(var
.type, QAPISchemaObjectType
):
206 visit_start_struct(v, name, NULL, 0, &err);
210 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
212 visit_check_struct(v, &err);
214 visit_end_struct(v, NULL);
216 c_type
=var
.type.c_name(),
217 c_name
=c_name(var
.name
))
220 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
222 c_type
=var
.type.c_name(),
223 c_name
=c_name(var
.name
))
227 ret
+= gen_endif(var
.ifcond
)
233 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
237 visit_end_alternate(v, (void **)obj);
238 if (err && visit_is_input(v)) {
239 qapi_free_%(c_name)s(*obj);
243 error_propagate(errp, err);
246 name
=name
, c_name
=c_name(name
))
251 def gen_visit_object(name
, base
, members
, variants
):
254 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
258 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
265 visit_type_%(c_name)s_members(v, *obj, &err);
269 visit_check_struct(v, &err);
271 visit_end_struct(v, (void **)obj);
272 if (err && visit_is_input(v)) {
273 qapi_free_%(c_name)s(*obj);
277 error_propagate(errp, err);
283 class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor
):
285 def __init__(self
, prefix
):
286 QAPISchemaModularCVisitor
.__init
__(
287 self
, prefix
, 'qapi-visit', ' * Schema-defined QAPI visitors',
288 ' * Built-in QAPI visitors', __doc__
)
290 def _begin_system_module(self
, name
):
291 self
._genc
.preamble_add(mcgen('''
292 #include "qemu/osdep.h"
293 #include "qapi/error.h"
294 #include "qapi/qapi-builtin-visit.h"
296 self
._genh
.preamble_add(mcgen('''
297 #include "qapi/visitor.h"
298 #include "qapi/qapi-builtin-types.h"
302 def _begin_user_module(self
, name
):
303 types
= self
._module
_basename
('qapi-types', name
)
304 visit
= self
._module
_basename
('qapi-visit', name
)
305 self
._genc
.preamble_add(mcgen('''
306 #include "qemu/osdep.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
,
331 # Nothing to do for the special empty builtin
332 if name
== 'q_empty':
334 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
335 self
._genh
.add(gen_visit_members_decl(name
))
336 self
._genc
.add(gen_visit_object_members(name
, base
,
338 # TODO Worth changing the visitor signature, so we could
339 # directly use rather than repeat type.is_implicit()?
340 if not name
.startswith('q_'):
341 # only explicit types need an allocating visit
342 self
._genh
.add(gen_visit_decl(name
))
343 self
._genc
.add(gen_visit_object(name
, base
, members
, variants
))
345 def visit_alternate_type(self
, name
, info
, ifcond
, variants
):
346 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
347 self
._genh
.add(gen_visit_decl(name
))
348 self
._genc
.add(gen_visit_alternate(name
, variants
))
351 def gen_visit(schema
, output_dir
, prefix
, opt_builtins
):
352 vis
= QAPISchemaGenVisitVisitor(prefix
)
354 vis
.write(output_dir
, opt_builtins
)