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 typing
import List
, Optional
26 from .gen
import QAPISchemaModularCVisitor
, ifcontext
34 QAPISchemaObjectTypeMember
,
38 from .source
import QAPISourceInfo
41 def gen_visit_decl(name
: str, scalar
: bool = False) -> str:
42 c_type
= c_name(name
) + ' *'
47 bool visit_type_%(c_name)s(Visitor *v, const char *name,
48 %(c_type)sobj, Error **errp);
50 c_name
=c_name(name
), c_type
=c_type
)
53 def gen_visit_members_decl(name
: str) -> str:
56 bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
61 def gen_visit_object_members(name
: str,
62 base
: Optional
[QAPISchemaObjectType
],
63 members
: List
[QAPISchemaObjectTypeMember
],
64 variants
: Optional
[QAPISchemaVariants
]) -> str:
67 bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
74 if (!visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, errp)) {
81 deprecated
= 'deprecated' in [f
.name
for f
in memb
.features
]
82 ret
+= gen_if(memb
.ifcond
.ifcond
)
85 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
87 name
=memb
.name
, c_name
=c_name(memb
.name
))
91 if (!visit_deprecated_accept(v, "%(name)s", errp)) {
94 if (visit_deprecated(v, "%(name)s")) {
99 if (!visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, errp)) {
103 c_type
=memb
.type.c_name(), name
=memb
.name
,
104 c_name
=c_name(memb
.name
))
115 ret
+= gen_endif(memb
.ifcond
.ifcond
)
118 tag_member
= variants
.tag_member
119 assert isinstance(tag_member
.type, QAPISchemaEnumType
)
122 switch (obj->%(c_name)s) {
124 c_name
=c_name(tag_member
.name
))
126 for var
in variants
.variants
:
127 case_str
= c_enum_const(tag_member
.type.name
, var
.name
,
128 tag_member
.type.prefix
)
129 ret
+= gen_if(var
.ifcond
.ifcond
)
130 if var
.type.name
== 'q_empty':
131 # valid variant and nothing to do
140 return visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, errp);
143 c_type
=var
.type.c_name(), c_name
=c_name(var
.name
))
145 ret
+= gen_endif(var
.ifcond
.ifcond
)
159 def gen_visit_list(name
: str, element_type
: QAPISchemaType
) -> str:
162 bool visit_type_%(c_name)s(Visitor *v, const char *name,
163 %(c_name)s **obj, Error **errp)
167 size_t size = sizeof(**obj);
169 if (!visit_start_list(v, name, (GenericList **)obj, size, errp)) {
173 for (tail = *obj; tail;
174 tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
175 if (!visit_type_%(c_elt_type)s(v, NULL, &tail->value, errp)) {
180 ok = visit_check_list(v, errp);
182 visit_end_list(v, (void **)obj);
183 if (!ok && visit_is_input(v)) {
184 qapi_free_%(c_name)s(*obj);
190 c_name
=c_name(name
), c_elt_type
=element_type
.c_name())
193 def gen_visit_enum(name
: str) -> str:
196 bool visit_type_%(c_name)s(Visitor *v, const char *name,
197 %(c_name)s *obj, Error **errp)
200 bool ok = visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp);
208 def gen_visit_alternate(name
: str, variants
: QAPISchemaVariants
) -> str:
211 bool visit_type_%(c_name)s(Visitor *v, const char *name,
212 %(c_name)s **obj, Error **errp)
216 if (!visit_start_alternate(v, name, (GenericAlternate **)obj,
217 sizeof(**obj), errp)) {
222 assert(visit_is_dealloc(v));
226 switch ((*obj)->type) {
230 for var
in variants
.variants
:
231 ret
+= gen_if(var
.ifcond
.ifcond
)
235 case
=var
.type.alternate_qtype())
236 if isinstance(var
.type, QAPISchemaObjectType
):
238 if (!visit_start_struct(v, name, NULL, 0, errp)) {
241 if (visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, errp)) {
242 ok = visit_check_struct(v, errp);
244 visit_end_struct(v, NULL);
246 c_type
=var
.type.c_name(),
247 c_name
=c_name(var
.name
))
250 ok = visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, errp);
252 c_type
=var
.type.c_name(),
253 c_name
=c_name(var
.name
))
257 ret
+= gen_endif(var
.ifcond
.ifcond
)
263 assert(visit_is_input(v));
264 error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
266 /* Avoid passing invalid *obj to qapi_free_%(c_name)s() */
271 visit_end_alternate(v, (void **)obj);
272 if (!ok && visit_is_input(v)) {
273 qapi_free_%(c_name)s(*obj);
279 name
=name
, c_name
=c_name(name
))
284 def gen_visit_object(name
: str) -> str:
287 bool visit_type_%(c_name)s(Visitor *v, const char *name,
288 %(c_name)s **obj, Error **errp)
292 if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), errp)) {
297 assert(visit_is_dealloc(v));
301 if (!visit_type_%(c_name)s_members(v, *obj, errp)) {
304 ok = visit_check_struct(v, errp);
306 visit_end_struct(v, (void **)obj);
307 if (!ok && visit_is_input(v)) {
308 qapi_free_%(c_name)s(*obj);
317 class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor
):
319 def __init__(self
, prefix
: str):
321 prefix
, 'qapi-visit', ' * Schema-defined QAPI visitors',
322 ' * Built-in QAPI visitors', __doc__
)
324 def _begin_builtin_module(self
) -> None:
325 self
._genc
.preamble_add(mcgen('''
326 #include "qemu/osdep.h"
327 #include "qapi/error.h"
328 #include "qapi/qapi-builtin-visit.h"
330 self
._genh
.preamble_add(mcgen('''
331 #include "qapi/visitor.h"
332 #include "qapi/qapi-builtin-types.h"
336 def _begin_user_module(self
, name
: str) -> None:
337 types
= self
._module
_basename
('qapi-types', name
)
338 visit
= self
._module
_basename
('qapi-visit', name
)
339 self
._genc
.preamble_add(mcgen('''
340 #include "qemu/osdep.h"
341 #include "qapi/error.h"
342 #include "qapi/qmp/qerror.h"
343 #include "%(visit)s.h"
346 self
._genh
.preamble_add(mcgen('''
347 #include "qapi/qapi-builtin-visit.h"
348 #include "%(types)s.h"
353 def visit_enum_type(self
,
355 info
: Optional
[QAPISourceInfo
],
356 ifcond
: QAPISchemaIfCond
,
357 features
: List
[QAPISchemaFeature
],
358 members
: List
[QAPISchemaEnumMember
],
359 prefix
: Optional
[str]) -> None:
360 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
361 self
._genh
.add(gen_visit_decl(name
, scalar
=True))
362 self
._genc
.add(gen_visit_enum(name
))
364 def visit_array_type(self
,
366 info
: Optional
[QAPISourceInfo
],
367 ifcond
: QAPISchemaIfCond
,
368 element_type
: QAPISchemaType
) -> None:
369 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
370 self
._genh
.add(gen_visit_decl(name
))
371 self
._genc
.add(gen_visit_list(name
, element_type
))
373 def visit_object_type(self
,
375 info
: Optional
[QAPISourceInfo
],
376 ifcond
: QAPISchemaIfCond
,
377 features
: List
[QAPISchemaFeature
],
378 base
: Optional
[QAPISchemaObjectType
],
379 members
: List
[QAPISchemaObjectTypeMember
],
380 variants
: Optional
[QAPISchemaVariants
]) -> None:
381 # Nothing to do for the special empty builtin
382 if name
== 'q_empty':
384 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
385 self
._genh
.add(gen_visit_members_decl(name
))
386 self
._genc
.add(gen_visit_object_members(name
, base
,
388 # TODO Worth changing the visitor signature, so we could
389 # directly use rather than repeat type.is_implicit()?
390 if not name
.startswith('q_'):
391 # only explicit types need an allocating visit
392 self
._genh
.add(gen_visit_decl(name
))
393 self
._genc
.add(gen_visit_object(name
))
395 def visit_alternate_type(self
,
397 info
: Optional
[QAPISourceInfo
],
398 ifcond
: QAPISchemaIfCond
,
399 features
: List
[QAPISchemaFeature
],
400 variants
: QAPISchemaVariants
) -> None:
401 with
ifcontext(ifcond
, self
._genh
, self
._genc
):
402 self
._genh
.add(gen_visit_decl(name
))
403 self
._genc
.add(gen_visit_alternate(name
, variants
))
406 def gen_visit(schema
: QAPISchema
,
409 opt_builtins
: bool) -> None:
410 vis
= QAPISchemaGenVisitVisitor(prefix
)
412 vis
.write(output_dir
, opt_builtins
)