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.
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 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
171 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
179 switch ((*obj)->type) {
183 for var
in variants
.variants
:
187 case
=var
.type.alternate_qtype())
188 if isinstance(var
.type, QAPISchemaObjectType
):
190 visit_start_struct(v, name, NULL, 0, &err);
194 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
196 visit_check_struct(v, &err);
198 visit_end_struct(v, NULL);
200 c_type
=var
.type.c_name(),
201 c_name
=c_name(var
.name
))
204 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
206 c_type
=var
.type.c_name(),
207 c_name
=c_name(var
.name
))
216 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
220 visit_end_alternate(v, (void **)obj);
221 if (err && visit_is_input(v)) {
222 qapi_free_%(c_name)s(*obj);
226 error_propagate(errp, err);
229 name
=name
, c_name
=c_name(name
))
234 def gen_visit_object(name
, base
, members
, variants
):
237 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
241 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
248 visit_type_%(c_name)s_members(v, *obj, &err);
252 visit_check_struct(v, &err);
254 visit_end_struct(v, (void **)obj);
255 if (err && visit_is_input(v)) {
256 qapi_free_%(c_name)s(*obj);
260 error_propagate(errp, err);
266 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor
):
272 def visit_begin(self
, schema
):
275 self
._btin
= guardstart('QAPI_VISIT_BUILTIN')
278 # To avoid header dependency hell, we always generate
279 # declarations for built-in types in our header files and
280 # simply guard them. See also do_builtins (command line
282 self
._btin
+= guardend('QAPI_VISIT_BUILTIN')
283 self
.decl
= self
._btin
+ self
.decl
286 def visit_enum_type(self
, name
, info
, values
, prefix
):
287 # Special case for our lone builtin enum type
288 # TODO use something cleaner than existence of info
290 self
._btin
+= gen_visit_decl(name
, scalar
=True)
292 self
.defn
+= gen_visit_enum(name
)
294 self
.decl
+= gen_visit_decl(name
, scalar
=True)
295 self
.defn
+= gen_visit_enum(name
)
297 def visit_array_type(self
, name
, info
, element_type
):
298 decl
= gen_visit_decl(name
)
299 defn
= gen_visit_list(name
, element_type
)
300 if isinstance(element_type
, QAPISchemaBuiltinType
):
308 def visit_object_type(self
, name
, info
, base
, members
, variants
):
309 # Nothing to do for the special empty builtin
310 if name
== 'q_empty':
312 self
.decl
+= gen_visit_members_decl(name
)
313 self
.defn
+= gen_visit_object_members(name
, base
, members
, variants
)
314 # TODO Worth changing the visitor signature, so we could
315 # directly use rather than repeat type.is_implicit()?
316 if not name
.startswith('q_'):
317 # only explicit types need an allocating visit
318 self
.decl
+= gen_visit_decl(name
)
319 self
.defn
+= gen_visit_object(name
, base
, members
, variants
)
321 def visit_alternate_type(self
, name
, info
, variants
):
322 self
.decl
+= gen_visit_decl(name
)
323 self
.defn
+= gen_visit_alternate(name
, variants
)
325 # If you link code generated from multiple schemata, you want only one
326 # instance of the code for built-in types. Generate it only when
327 # do_builtins, enabled by command line option -b. See also
328 # QAPISchemaGenVisitVisitor.visit_end().
331 (input_file
, output_dir
, do_c
, do_h
, prefix
, opts
) = \
332 parse_command_line('b', ['builtins'])
335 if o
in ('-b', '--builtins'):
338 blurb
= ' * Schema-defined QAPI visitors'
340 (fdef
, fdecl
) = open_output(output_dir
, do_c
, do_h
, prefix
,
341 'qapi-visit.c', 'qapi-visit.h',
345 #include "qemu/osdep.h"
346 #include "qemu-common.h"
347 #include "qapi/error.h"
348 #include "qapi/qmp/qerror.h"
349 #include "%(prefix)sqapi-visit.h"
353 fdecl
.write(mcgen('''
354 #include "qapi/visitor.h"
355 #include "%(prefix)sqapi-types.h"
360 schema
= QAPISchema(input_file
)
361 vis
= QAPISchemaGenVisitVisitor()
364 fdecl
.write(vis
.decl
)
366 close_output(fdef
, fdecl
)