]>
git.proxmox.com Git - qemu.git/blob - scripts/qapi-visit.py
2 # QAPI visitor generator
4 # Copyright IBM, Corp. 2011
7 # Anthony Liguori <aliguori@us.ibm.com>
8 # Michael Roth <mdroth@linux.vnet.ibm.com>
10 # This work is licensed under the terms of the GNU GPLv2.
11 # See the COPYING.LIB file in the top-level directory.
13 from ordereddict
import OrderedDict
20 def generate_visit_struct_fields(name
, field_prefix
, fn_prefix
, members
):
23 full_name
= name
if not fn_prefix
else "%s_%s" % (name
, fn_prefix
)
25 for argname
, argentry
, optional
, structured
in parse_args(members
):
28 nested_fn_prefix
= argname
30 nested_fn_prefix
= "%s_%s" % (fn_prefix
, argname
)
32 nested_field_prefix
= "%s%s." % (field_prefix
, argname
)
33 ret
+= generate_visit_struct_fields(name
, nested_field_prefix
,
34 nested_fn_prefix
, argentry
)
38 static void visit_type_%(full_name)s_fields(Visitor *m, %(name)s ** obj, Error **errp)
42 name
=name
, full_name
=full_name
)
45 for argname
, argentry
, optional
, structured
in parse_args(members
):
48 visit_start_optional(m, obj ? &(*obj)->%(c_prefix)shas_%(c_name)s : NULL, "%(name)s", &err);
49 if (obj && (*obj)->%(prefix)shas_%(c_name)s) {
51 c_prefix
=c_var(field_prefix
), prefix
=field_prefix
,
52 c_name
=c_var(argname
), name
=argname
)
56 ret
+= generate_visit_struct_body(full_name
, argname
, argentry
)
59 visit_type_%(type)s(m, obj ? &(*obj)->%(c_prefix)s%(c_name)s : NULL, "%(name)s", &err);
61 c_prefix
=c_var(field_prefix
), prefix
=field_prefix
,
62 type=type_name(argentry
), c_name
=c_var(argname
),
69 visit_end_optional(m, &err);
75 error_propagate(errp, err);
81 def generate_visit_struct_body(field_prefix
, name
, members
):
83 if (!error_is_set(errp)) {
87 full_name
= name
if not field_prefix
else "%s_%s" % (field_prefix
, name
)
91 Error **errp = &err; /* from outer scope */
93 visit_start_struct(m, NULL, "", "%(name)s", 0, &err);
99 visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(name)s), &err);
106 visit_type_%(name)s_fields(m, obj, &err);
107 error_propagate(errp, err);
115 /* Always call end_struct if start_struct succeeded. */
116 visit_end_struct(m, &err);
118 error_propagate(errp, err);
123 def generate_visit_struct(expr
):
126 members
= expr
['data']
128 ret
= generate_visit_struct_fields(name
, "", "", members
)
132 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
138 ret
+= generate_visit_struct_body("", name
, members
)
146 def generate_visit_list(name
, members
):
149 void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp)
151 GenericList *i, **prev = (GenericList **)obj;
154 if (!error_is_set(errp)) {
155 visit_start_list(m, name, &err);
157 for (; (i = visit_next_list(m, prev, &err)) != NULL; prev = &i) {
158 %(name)sList *native_i = (%(name)sList *)i;
159 visit_type_%(name)s(m, &native_i->value, NULL, &err);
161 error_propagate(errp, err);
164 /* Always call end_list if start_list succeeded. */
165 visit_end_list(m, &err);
167 error_propagate(errp, err);
173 def generate_visit_enum(name
, members
):
176 void visit_type_%(name)s(Visitor *m, %(name)s * obj, const char *name, Error **errp)
178 visit_type_enum(m, (int *)obj, %(name)s_lookup, "%(name)s", name, errp);
183 def generate_visit_anon_union(name
, members
):
186 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
190 if (!error_is_set(errp)) {
191 visit_start_implicit_struct(m, (void**) obj, sizeof(%(name)s), &err);
192 visit_get_next_type(m, (int*) &(*obj)->kind, %(name)s_qtypes, name, &err);
193 switch ((*obj)->kind) {
198 assert (members
[key
] in builtin_types
199 or find_struct(members
[key
])
200 or find_union(members
[key
])), "Invalid anonymous union member"
203 case %(abbrev)s_KIND_%(enum)s:
204 visit_type_%(c_type)s(m, &(*obj)->%(c_name)s, name, &err);
207 abbrev
= de_camel_case(name
).upper(),
208 enum
= c_fun(de_camel_case(key
),False).upper(),
209 c_type
= type_name(members
[key
]),
216 error_propagate(errp, err);
218 visit_end_implicit_struct(m, &err);
226 def generate_visit_union(expr
):
229 members
= expr
['data']
231 base
= expr
.get('base')
232 discriminator
= expr
.get('discriminator')
234 if discriminator
== {}:
236 return generate_visit_anon_union(name
, members
)
238 ret
= generate_visit_enum('%sKind' % name
, members
.keys())
241 base_fields
= find_struct(base
)['data']
243 base_fields
= base_fields
.copy()
244 del base_fields
[discriminator
]
245 ret
+= generate_visit_struct_fields(name
, "", "", base_fields
)
249 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
253 if (!error_is_set(errp)) {
254 visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(name)s), &err);
267 visit_type_%(name)s_fields(m, obj, &err);
273 visit_type_%(name)sKind(m, &(*obj)->kind, "%(type)s", &err);
275 switch ((*obj)->kind) {
277 name
=name
, type="type" if not discriminator
else discriminator
)
280 if not discriminator
:
281 fmt
= 'visit_type_%(c_type)s(m, &(*obj)->%(c_name)s, "data", &err);'
283 fmt
= '''visit_start_implicit_struct(m, (void**) &(*obj)->%(c_name)s, sizeof(%(c_type)s), &err);
285 visit_type_%(c_type)s_fields(m, &(*obj)->%(c_name)s, &err);
286 error_propagate(errp, err);
288 visit_end_implicit_struct(m, &err);
292 case %(abbrev)s_KIND_%(enum)s:
296 abbrev
= de_camel_case(name
).upper(),
297 enum
= c_fun(de_camel_case(key
),False).upper(),
298 c_type
=type_name(members
[key
]),
306 error_propagate(errp, err);
312 /* Always call end_struct if start_struct succeeded. */
313 visit_end_struct(m, &err);
315 error_propagate(errp, err);
326 def generate_declaration(name
, members
, genlist
=True, builtin_type
=False):
331 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp);
337 void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp);
343 def generate_enum_declaration(name
, members
, genlist
=True):
347 void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp);
353 def generate_decl_enum(name
, members
, genlist
=True):
356 void visit_type_%(name)s(Visitor *m, %(name)s * obj, const char *name, Error **errp);
361 opts
, args
= getopt
.gnu_getopt(sys
.argv
[1:], "chbp:o:",
362 ["source", "header", "builtins", "prefix=",
364 except getopt
.GetoptError
, err
:
370 c_file
= 'qapi-visit.c'
371 h_file
= 'qapi-visit.h'
378 if o
in ("-p", "--prefix"):
380 elif o
in ("-o", "--output-dir"):
382 elif o
in ("-c", "--source"):
384 elif o
in ("-h", "--header"):
386 elif o
in ("-b", "--builtins"):
389 if not do_c
and not do_h
:
393 c_file
= output_dir
+ prefix
+ c_file
394 h_file
= output_dir
+ prefix
+ h_file
397 os
.makedirs(output_dir
)
399 if e
.errno
!= errno
.EEXIST
:
402 def maybe_open(really
, name
, opt
):
404 return open(name
, opt
)
407 return StringIO
.StringIO()
409 fdef
= maybe_open(do_c
, c_file
, 'w')
410 fdecl
= maybe_open(do_h
, h_file
, 'w')
413 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
416 * schema-defined QAPI visitor functions
418 * Copyright IBM, Corp. 2011
421 * Anthony Liguori <aliguori@us.ibm.com>
423 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
424 * See the COPYING.LIB file in the top-level directory.
428 #include "qemu-common.h"
429 #include "%(header)s"
431 header
=basename(h_file
)))
433 fdecl
.write(mcgen('''
434 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
437 * schema-defined QAPI visitor function
439 * Copyright IBM, Corp. 2011
442 * Anthony Liguori <aliguori@us.ibm.com>
444 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
445 * See the COPYING.LIB file in the top-level directory.
452 #include "qapi/visitor.h"
453 #include "%(prefix)sqapi-types.h"
456 prefix
=prefix
, guard
=guardname(h_file
)))
458 exprs
= parse_schema(sys
.stdin
)
460 # to avoid header dependency hell, we always generate declarations
461 # for built-in types in our header files and simply guard them
462 fdecl
.write(guardstart("QAPI_VISIT_BUILTIN_VISITOR_DECL"))
463 for typename
in builtin_types
:
464 fdecl
.write(generate_declaration(typename
, None, genlist
=True,
466 fdecl
.write(guardend("QAPI_VISIT_BUILTIN_VISITOR_DECL"))
468 # ...this doesn't work for cases where we link in multiple objects that
469 # have the functions defined, so we use -b option to provide control
472 fdef
.write(guardstart("QAPI_VISIT_BUILTIN_VISITOR_DEF"))
473 for typename
in builtin_types
:
474 fdef
.write(generate_visit_list(typename
, None))
475 fdef
.write(guardend("QAPI_VISIT_BUILTIN_VISITOR_DEF"))
478 if expr
.has_key('type'):
479 ret
= generate_visit_struct(expr
)
480 ret
+= generate_visit_list(expr
['type'], expr
['data'])
483 ret
= generate_declaration(expr
['type'], expr
['data'])
485 elif expr
.has_key('union'):
486 ret
= generate_visit_union(expr
)
487 ret
+= generate_visit_list(expr
['union'], expr
['data'])
490 ret
= generate_decl_enum('%sKind' % expr
['union'], expr
['data'].keys())
491 ret
+= generate_declaration(expr
['union'], expr
['data'])
493 elif expr
.has_key('enum'):
494 ret
= generate_visit_list(expr
['enum'], expr
['data'])
495 ret
+= generate_visit_enum(expr
['enum'], expr
['data'])
498 ret
= generate_decl_enum(expr
['enum'], expr
['data'])
499 ret
+= generate_enum_declaration(expr
['enum'], expr
['data'])