]>
Commit | Line | Data |
---|---|---|
06d64c62 MR |
1 | # |
2 | # QAPI visitor generator | |
3 | # | |
4 | # Copyright IBM, Corp. 2011 | |
92b09bab | 5 | # Copyright (C) 2014-2016 Red Hat, Inc. |
06d64c62 MR |
6 | # |
7 | # Authors: | |
8 | # Anthony Liguori <aliguori@us.ibm.com> | |
9 | # Michael Roth <mdroth@linux.vnet.ibm.com> | |
297a3646 | 10 | # Markus Armbruster <armbru@redhat.com> |
06d64c62 | 11 | # |
678e48a2 MA |
12 | # This work is licensed under the terms of the GNU GPL, version 2. |
13 | # See the COPYING file in the top-level directory. | |
06d64c62 | 14 | |
06d64c62 | 15 | from qapi import * |
297a3646 | 16 | import re |
06d64c62 | 17 | |
d02cf377 EB |
18 | # visit_type_FOO_implicit() is emitted as needed; track if it has already |
19 | # been output. | |
8c07eddc | 20 | implicit_structs_seen = set() |
d02cf377 EB |
21 | |
22 | # visit_type_FOO_fields() is always emitted; track if a forward declaration | |
23 | # or implementation has already been output. | |
8c3f8e77 | 24 | struct_fields_seen = set() |
be3c7717 | 25 | |
e98859a9 | 26 | |
60f8546a MA |
27 | def gen_visit_decl(name, scalar=False): |
28 | c_type = c_name(name) + ' *' | |
29 | if not scalar: | |
30 | c_type += '*' | |
31 | return mcgen(''' | |
51e72bc1 | 32 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp); |
60f8546a MA |
33 | ''', |
34 | c_name=c_name(name), c_type=c_type) | |
35 | ||
36 | ||
d02cf377 | 37 | def gen_visit_fields_decl(typ): |
8c3f8e77 | 38 | ret = '' |
e98859a9 | 39 | if typ.name not in struct_fields_seen: |
8c3f8e77 MA |
40 | ret += mcgen(''' |
41 | ||
f8b7f1a8 | 42 | static void visit_type_%(c_type)s_fields(Visitor *v, %(c_type)s **obj, Error **errp); |
8c3f8e77 | 43 | ''', |
e98859a9 | 44 | c_type=typ.c_name()) |
d02cf377 EB |
45 | struct_fields_seen.add(typ.name) |
46 | return ret | |
47 | ||
48 | ||
49 | def gen_visit_implicit_struct(typ): | |
50 | if typ in implicit_structs_seen: | |
51 | return '' | |
52 | implicit_structs_seen.add(typ) | |
53 | ||
54 | ret = gen_visit_fields_decl(typ) | |
8c3f8e77 MA |
55 | |
56 | ret += mcgen(''' | |
be3c7717 | 57 | |
f8b7f1a8 | 58 | static void visit_type_implicit_%(c_type)s(Visitor *v, %(c_type)s **obj, Error **errp) |
be3c7717 MA |
59 | { |
60 | Error *err = NULL; | |
61 | ||
f8b7f1a8 | 62 | visit_start_implicit_struct(v, (void **)obj, sizeof(%(c_type)s), &err); |
be3c7717 | 63 | if (!err) { |
f8b7f1a8 | 64 | visit_type_%(c_type)s_fields(v, obj, errp); |
08f9541d | 65 | visit_end_implicit_struct(v); |
be3c7717 MA |
66 | } |
67 | error_propagate(errp, err); | |
68 | } | |
69 | ''', | |
e98859a9 | 70 | c_type=typ.c_name()) |
8c3f8e77 | 71 | return ret |
be3c7717 | 72 | |
e98859a9 MA |
73 | |
74 | def gen_visit_struct_fields(name, base, members): | |
d131c897 | 75 | ret = '' |
50f2bdc7 | 76 | |
be3c7717 | 77 | if base: |
ddf21908 | 78 | ret += gen_visit_fields_decl(base) |
be3c7717 | 79 | |
ddf21908 | 80 | struct_fields_seen.add(name) |
50f2bdc7 KW |
81 | ret += mcgen(''' |
82 | ||
f8b7f1a8 | 83 | static void visit_type_%(c_name)s_fields(Visitor *v, %(c_name)s **obj, Error **errp) |
50f2bdc7 KW |
84 | { |
85 | Error *err = NULL; | |
3a864e7c | 86 | |
50f2bdc7 | 87 | ''', |
e98859a9 | 88 | c_name=c_name(name)) |
d195325b | 89 | |
622f557f KW |
90 | if base: |
91 | ret += mcgen(''' | |
ddf21908 | 92 | visit_type_%(c_type)s_fields(v, (%(c_type)s **)obj, &err); |
622f557f | 93 | ''', |
ddf21908 | 94 | c_type=base.c_name()) |
1f353344 | 95 | ret += gen_err_check() |
622f557f | 96 | |
82ca8e46 | 97 | ret += gen_visit_fields(members, prefix='(*obj)->') |
d195325b | 98 | |
f9e6102b EB |
99 | # 'goto out' produced for base, and by gen_visit_fields() for each member |
100 | if base or members: | |
297a3646 | 101 | ret += mcgen(''' |
50f2bdc7 | 102 | |
297a3646 MA |
103 | out: |
104 | ''') | |
105 | ret += mcgen(''' | |
50f2bdc7 KW |
106 | error_propagate(errp, err); |
107 | } | |
108 | ''') | |
d131c897 KW |
109 | return ret |
110 | ||
111 | ||
60f8546a MA |
112 | def gen_visit_struct(name, base, members): |
113 | ret = gen_visit_struct_fields(name, base, members) | |
114 | ||
2f52e205 EB |
115 | # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to |
116 | # *obj, but then visit_type_FOO_fields() fails, we should clean up *obj | |
117 | # rather than leaving it non-NULL. As currently written, the caller must | |
118 | # call qapi_free_FOO() to avoid a memory leak of the partial FOO. | |
60f8546a MA |
119 | ret += mcgen(''' |
120 | ||
51e72bc1 | 121 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
60f8546a | 122 | { |
297a3646 MA |
123 | Error *err = NULL; |
124 | ||
337283df | 125 | visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err); |
92b09bab EB |
126 | if (err) { |
127 | goto out; | |
128 | } | |
129 | if (!*obj) { | |
130 | goto out_obj; | |
50f2bdc7 | 131 | } |
92b09bab EB |
132 | visit_type_%(c_name)s_fields(v, obj, &err); |
133 | error_propagate(errp, err); | |
134 | err = NULL; | |
135 | out_obj: | |
136 | visit_end_struct(v, &err); | |
137 | out: | |
297a3646 | 138 | error_propagate(errp, err); |
60f8546a | 139 | } |
50f2bdc7 | 140 | ''', |
337283df | 141 | c_name=c_name(name)) |
06d64c62 | 142 | |
06d64c62 MR |
143 | return ret |
144 | ||
e98859a9 | 145 | |
441cbac0 | 146 | def gen_visit_list(name, element_type): |
dd5ee2c2 EB |
147 | # FIXME: if *obj is NULL on entry, and the first visit_next_list() |
148 | # assigns to *obj, while a later one fails, we should clean up *obj | |
149 | # rather than leaving it non-NULL. As currently written, the caller must | |
150 | # call qapi_free_FOOList() to avoid a memory leak of the partial FOOList. | |
06d64c62 MR |
151 | return mcgen(''' |
152 | ||
51e72bc1 | 153 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 154 | { |
d195325b | 155 | Error *err = NULL; |
297a3646 | 156 | GenericList *i, **prev; |
06d64c62 | 157 | |
f8b7f1a8 | 158 | visit_start_list(v, name, &err); |
297a3646 MA |
159 | if (err) { |
160 | goto out; | |
161 | } | |
162 | ||
163 | for (prev = (GenericList **)obj; | |
08f9541d | 164 | !err && (i = visit_next_list(v, prev)) != NULL; |
297a3646 | 165 | prev = &i) { |
e98859a9 | 166 | %(c_name)s *native_i = (%(c_name)s *)i; |
51e72bc1 | 167 | visit_type_%(c_elt_type)s(v, NULL, &native_i->value, &err); |
06d64c62 | 168 | } |
297a3646 | 169 | |
08f9541d | 170 | visit_end_list(v); |
297a3646 MA |
171 | out: |
172 | error_propagate(errp, err); | |
06d64c62 MR |
173 | } |
174 | ''', | |
e98859a9 | 175 | c_name=c_name(name), c_elt_type=element_type.c_name()) |
06d64c62 | 176 | |
e98859a9 MA |
177 | |
178 | def gen_visit_enum(name): | |
06d64c62 MR |
179 | return mcgen(''' |
180 | ||
51e72bc1 | 181 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp) |
06d64c62 | 182 | { |
395a233f | 183 | int value = *obj; |
337283df | 184 | visit_type_enum(v, name, &value, %(c_name)s_lookup, errp); |
395a233f | 185 | *obj = value; |
06d64c62 MR |
186 | } |
187 | ''', | |
337283df | 188 | c_name=c_name(name)) |
06d64c62 | 189 | |
e98859a9 | 190 | |
441cbac0 | 191 | def gen_visit_alternate(name, variants): |
d00341af EB |
192 | promote_int = 'true' |
193 | for var in variants.variants: | |
194 | if var.type.alternate_qtype() == 'QTYPE_QINT': | |
195 | promote_int = 'false' | |
196 | ||
69dd62df KW |
197 | ret = mcgen(''' |
198 | ||
51e72bc1 | 199 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
69dd62df KW |
200 | { |
201 | Error *err = NULL; | |
202 | ||
f8b7f1a8 | 203 | visit_start_implicit_struct(v, (void**) obj, sizeof(%(c_name)s), &err); |
297a3646 MA |
204 | if (err) { |
205 | goto out; | |
206 | } | |
51e72bc1 | 207 | visit_get_next_type(v, name, &(*obj)->type, %(promote_int)s, &err); |
297a3646 | 208 | if (err) { |
f782399c | 209 | goto out_obj; |
297a3646 | 210 | } |
150d0564 | 211 | switch ((*obj)->type) { |
69dd62df | 212 | ''', |
d00341af | 213 | c_name=c_name(name), promote_int=promote_int) |
69dd62df | 214 | |
441cbac0 | 215 | for var in variants.variants: |
69dd62df | 216 | ret += mcgen(''' |
e98859a9 | 217 | case %(case)s: |
51e72bc1 | 218 | visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err); |
297a3646 | 219 | break; |
69dd62df | 220 | ''', |
0426d53c | 221 | case=var.type.alternate_qtype(), |
e98859a9 MA |
222 | c_type=var.type.c_name(), |
223 | c_name=c_name(var.name)) | |
69dd62df KW |
224 | |
225 | ret += mcgen(''' | |
297a3646 | 226 | default: |
0426d53c EB |
227 | error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", |
228 | "%(name)s"); | |
69dd62df | 229 | } |
f782399c | 230 | out_obj: |
08f9541d | 231 | visit_end_implicit_struct(v); |
297a3646 MA |
232 | out: |
233 | error_propagate(errp, err); | |
69dd62df | 234 | } |
0426d53c EB |
235 | ''', |
236 | name=name) | |
69dd62df KW |
237 | |
238 | return ret | |
239 | ||
e98859a9 | 240 | |
d7445b57 MA |
241 | def gen_visit_union(name, base, members, variants): |
242 | ret = gen_visit_struct_fields(name, base, members) | |
50f2bdc7 | 243 | |
441cbac0 MA |
244 | for var in variants.variants: |
245 | # Ugly special case for simple union TODO get rid of it | |
246 | if not var.simple_union_type(): | |
e98859a9 | 247 | ret += gen_visit_implicit_struct(var.type) |
be3c7717 | 248 | |
06d64c62 MR |
249 | ret += mcgen(''' |
250 | ||
51e72bc1 | 251 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 252 | { |
dc8fb6df PB |
253 | Error *err = NULL; |
254 | ||
337283df | 255 | visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err); |
297a3646 MA |
256 | if (err) { |
257 | goto out; | |
258 | } | |
e36c714e EB |
259 | if (!*obj) { |
260 | goto out_obj; | |
261 | } | |
d7445b57 | 262 | visit_type_%(c_name)s_fields(v, obj, &err); |
06d64c62 | 263 | ''', |
337283df | 264 | c_name=c_name(name)) |
5c5e51a0 EB |
265 | ret += gen_err_check(label='out_obj') |
266 | ret += mcgen(''' | |
150d0564 | 267 | if (!visit_start_union(v, !!(*obj)->u.data, &err) || err) { |
e36c714e EB |
268 | goto out_obj; |
269 | } | |
270 | switch ((*obj)->%(c_name)s) { | |
0aef92b9 | 271 | ''', |
150d0564 | 272 | c_name=c_name(variants.tag_member.name)) |
0aef92b9 | 273 | |
441cbac0 MA |
274 | for var in variants.variants: |
275 | # TODO ugly special case for simple union | |
276 | simple_union_type = var.simple_union_type() | |
e98859a9 | 277 | ret += mcgen(''' |
e36c714e | 278 | case %(case)s: |
e98859a9 MA |
279 | ''', |
280 | case=c_enum_const(variants.tag_member.type.name, | |
9d3524b3 EB |
281 | var.name, |
282 | variants.tag_member.type.prefix)) | |
441cbac0 | 283 | if simple_union_type: |
e98859a9 | 284 | ret += mcgen(''' |
51e72bc1 | 285 | visit_type_%(c_type)s(v, "data", &(*obj)->u.%(c_name)s, &err); |
e98859a9 MA |
286 | ''', |
287 | c_type=simple_union_type.c_name(), | |
288 | c_name=c_name(var.name)) | |
50f2bdc7 | 289 | else: |
e98859a9 | 290 | ret += mcgen(''' |
150d0564 | 291 | visit_type_implicit_%(c_type)s(v, &(*obj)->u.%(c_name)s, &err); |
e98859a9 MA |
292 | ''', |
293 | c_type=var.type.c_name(), | |
294 | c_name=c_name(var.name)) | |
dc8fb6df | 295 | ret += mcgen(''' |
e36c714e | 296 | break; |
e98859a9 | 297 | ''') |
dc8fb6df PB |
298 | |
299 | ret += mcgen(''' | |
e36c714e EB |
300 | default: |
301 | abort(); | |
468866b8 | 302 | } |
e36c714e | 303 | out_obj: |
e36c714e EB |
304 | error_propagate(errp, err); |
305 | err = NULL; | |
f8b7f1a8 | 306 | visit_end_struct(v, &err); |
297a3646 MA |
307 | out: |
308 | error_propagate(errp, err); | |
dc8fb6df PB |
309 | } |
310 | ''') | |
311 | ||
06d64c62 MR |
312 | return ret |
313 | ||
e98859a9 | 314 | |
441cbac0 MA |
315 | class QAPISchemaGenVisitVisitor(QAPISchemaVisitor): |
316 | def __init__(self): | |
317 | self.decl = None | |
318 | self.defn = None | |
319 | self._btin = None | |
320 | ||
321 | def visit_begin(self, schema): | |
322 | self.decl = '' | |
323 | self.defn = '' | |
324 | self._btin = guardstart('QAPI_VISIT_BUILTIN') | |
325 | ||
326 | def visit_end(self): | |
327 | # To avoid header dependency hell, we always generate | |
328 | # declarations for built-in types in our header files and | |
329 | # simply guard them. See also do_builtins (command line | |
330 | # option -b). | |
331 | self._btin += guardend('QAPI_VISIT_BUILTIN') | |
332 | self.decl = self._btin + self.decl | |
333 | self._btin = None | |
334 | ||
25a0d9c9 EB |
335 | def visit_needed(self, entity): |
336 | # Visit everything except implicit objects | |
49823c4b EB |
337 | return not (entity.is_implicit() and |
338 | isinstance(entity, QAPISchemaObjectType)) | |
25a0d9c9 | 339 | |
441cbac0 | 340 | def visit_enum_type(self, name, info, values, prefix): |
7264f5c5 EB |
341 | # Special case for our lone builtin enum type |
342 | # TODO use something cleaner than existence of info | |
343 | if not info: | |
344 | self._btin += gen_visit_decl(name, scalar=True) | |
345 | if do_builtins: | |
346 | self.defn += gen_visit_enum(name) | |
347 | else: | |
348 | self.decl += gen_visit_decl(name, scalar=True) | |
349 | self.defn += gen_visit_enum(name) | |
441cbac0 MA |
350 | |
351 | def visit_array_type(self, name, info, element_type): | |
352 | decl = gen_visit_decl(name) | |
353 | defn = gen_visit_list(name, element_type) | |
354 | if isinstance(element_type, QAPISchemaBuiltinType): | |
355 | self._btin += decl | |
356 | if do_builtins: | |
357 | self.defn += defn | |
358 | else: | |
359 | self.decl += decl | |
360 | self.defn += defn | |
361 | ||
362 | def visit_object_type(self, name, info, base, members, variants): | |
25a0d9c9 EB |
363 | self.decl += gen_visit_decl(name) |
364 | if variants: | |
d7445b57 | 365 | self.defn += gen_visit_union(name, base, members, variants) |
25a0d9c9 EB |
366 | else: |
367 | self.defn += gen_visit_struct(name, base, members) | |
441cbac0 MA |
368 | |
369 | def visit_alternate_type(self, name, info, variants): | |
370 | self.decl += gen_visit_decl(name) | |
371 | self.defn += gen_visit_alternate(name, variants) | |
372 | ||
373 | # If you link code generated from multiple schemata, you want only one | |
374 | # instance of the code for built-in types. Generate it only when | |
375 | # do_builtins, enabled by command line option -b. See also | |
376 | # QAPISchemaGenVisitVisitor.visit_end(). | |
7c946bc4 | 377 | do_builtins = False |
8d3bc517 | 378 | |
2114f5a9 MA |
379 | (input_file, output_dir, do_c, do_h, prefix, opts) = \ |
380 | parse_command_line("b", ["builtins"]) | |
381 | ||
06d64c62 | 382 | for o, a in opts: |
2114f5a9 | 383 | if o in ("-b", "--builtins"): |
7c946bc4 | 384 | do_builtins = True |
8d3bc517 | 385 | |
12f8e1b9 | 386 | c_comment = ''' |
06d64c62 MR |
387 | /* |
388 | * schema-defined QAPI visitor functions | |
389 | * | |
390 | * Copyright IBM, Corp. 2011 | |
391 | * | |
392 | * Authors: | |
393 | * Anthony Liguori <aliguori@us.ibm.com> | |
394 | * | |
395 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
396 | * See the COPYING.LIB file in the top-level directory. | |
397 | * | |
398 | */ | |
12f8e1b9 MA |
399 | ''' |
400 | h_comment = ''' | |
06d64c62 | 401 | /* |
297a3646 | 402 | * schema-defined QAPI visitor functions |
06d64c62 MR |
403 | * |
404 | * Copyright IBM, Corp. 2011 | |
405 | * | |
406 | * Authors: | |
407 | * Anthony Liguori <aliguori@us.ibm.com> | |
408 | * | |
409 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
410 | * See the COPYING.LIB file in the top-level directory. | |
411 | * | |
412 | */ | |
12f8e1b9 MA |
413 | ''' |
414 | ||
415 | (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix, | |
416 | 'qapi-visit.c', 'qapi-visit.h', | |
417 | c_comment, h_comment) | |
06d64c62 | 418 | |
12f8e1b9 | 419 | fdef.write(mcgen(''' |
9167ebd9 | 420 | #include "qemu/osdep.h" |
12f8e1b9 MA |
421 | #include "qemu-common.h" |
422 | #include "%(prefix)sqapi-visit.h" | |
423 | ''', | |
e98859a9 | 424 | prefix=prefix)) |
06d64c62 | 425 | |
12f8e1b9 | 426 | fdecl.write(mcgen(''' |
7b1b5d19 | 427 | #include "qapi/visitor.h" |
0426d53c | 428 | #include "qapi/qmp/qerror.h" |
06d64c62 | 429 | #include "%(prefix)sqapi-types.h" |
7c946bc4 | 430 | |
06d64c62 | 431 | ''', |
12f8e1b9 | 432 | prefix=prefix)) |
06d64c62 | 433 | |
441cbac0 MA |
434 | schema = QAPISchema(input_file) |
435 | gen = QAPISchemaGenVisitVisitor() | |
436 | schema.visit(gen) | |
437 | fdef.write(gen.defn) | |
438 | fdecl.write(gen.decl) | |
06d64c62 | 439 | |
12f8e1b9 | 440 | close_output(fdef, fdecl) |