]>
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 EB |
64 | visit_type_%(c_type)s_fields(v, obj, errp); |
65 | visit_end_implicit_struct(v, &err); | |
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 | ||
51e72bc1 | 125 | visit_start_struct(v, name, (void **)obj, "%(name)s", 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 | ''', |
60f8546a | 141 | name=name, 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; | |
f8b7f1a8 | 164 | !err && (i = visit_next_list(v, prev, &err)) != 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 MA |
169 | |
170 | error_propagate(errp, err); | |
171 | err = NULL; | |
f8b7f1a8 | 172 | visit_end_list(v, &err); |
297a3646 MA |
173 | out: |
174 | error_propagate(errp, err); | |
06d64c62 MR |
175 | } |
176 | ''', | |
e98859a9 | 177 | c_name=c_name(name), c_elt_type=element_type.c_name()) |
06d64c62 | 178 | |
e98859a9 MA |
179 | |
180 | def gen_visit_enum(name): | |
06d64c62 MR |
181 | return mcgen(''' |
182 | ||
51e72bc1 | 183 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp) |
06d64c62 | 184 | { |
395a233f | 185 | int value = *obj; |
51e72bc1 | 186 | visit_type_enum(v, name, &value, %(c_name)s_lookup, "%(name)s", errp); |
395a233f | 187 | *obj = value; |
06d64c62 MR |
188 | } |
189 | ''', | |
40b3adec | 190 | c_name=c_name(name), name=name) |
06d64c62 | 191 | |
e98859a9 | 192 | |
441cbac0 | 193 | def gen_visit_alternate(name, variants): |
d00341af EB |
194 | promote_int = 'true' |
195 | for var in variants.variants: | |
196 | if var.type.alternate_qtype() == 'QTYPE_QINT': | |
197 | promote_int = 'false' | |
198 | ||
69dd62df KW |
199 | ret = mcgen(''' |
200 | ||
51e72bc1 | 201 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
69dd62df KW |
202 | { |
203 | Error *err = NULL; | |
204 | ||
f8b7f1a8 | 205 | visit_start_implicit_struct(v, (void**) obj, sizeof(%(c_name)s), &err); |
297a3646 MA |
206 | if (err) { |
207 | goto out; | |
208 | } | |
51e72bc1 | 209 | visit_get_next_type(v, name, &(*obj)->type, %(promote_int)s, &err); |
297a3646 | 210 | if (err) { |
f782399c | 211 | goto out_obj; |
297a3646 | 212 | } |
150d0564 | 213 | switch ((*obj)->type) { |
69dd62df | 214 | ''', |
d00341af | 215 | c_name=c_name(name), promote_int=promote_int) |
69dd62df | 216 | |
441cbac0 | 217 | for var in variants.variants: |
69dd62df | 218 | ret += mcgen(''' |
e98859a9 | 219 | case %(case)s: |
51e72bc1 | 220 | visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err); |
297a3646 | 221 | break; |
69dd62df | 222 | ''', |
0426d53c | 223 | case=var.type.alternate_qtype(), |
e98859a9 MA |
224 | c_type=var.type.c_name(), |
225 | c_name=c_name(var.name)) | |
69dd62df KW |
226 | |
227 | ret += mcgen(''' | |
297a3646 | 228 | default: |
0426d53c EB |
229 | error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", |
230 | "%(name)s"); | |
69dd62df | 231 | } |
f782399c | 232 | out_obj: |
297a3646 MA |
233 | error_propagate(errp, err); |
234 | err = NULL; | |
f8b7f1a8 | 235 | visit_end_implicit_struct(v, &err); |
297a3646 MA |
236 | out: |
237 | error_propagate(errp, err); | |
69dd62df | 238 | } |
0426d53c EB |
239 | ''', |
240 | name=name) | |
69dd62df KW |
241 | |
242 | return ret | |
243 | ||
e98859a9 | 244 | |
441cbac0 MA |
245 | def gen_visit_union(name, base, variants): |
246 | ret = '' | |
06d64c62 | 247 | |
50f2bdc7 | 248 | if base: |
5c5e51a0 | 249 | ret += gen_visit_fields_decl(base) |
50f2bdc7 | 250 | |
441cbac0 MA |
251 | for var in variants.variants: |
252 | # Ugly special case for simple union TODO get rid of it | |
253 | if not var.simple_union_type(): | |
e98859a9 | 254 | ret += gen_visit_implicit_struct(var.type) |
be3c7717 | 255 | |
06d64c62 MR |
256 | ret += mcgen(''' |
257 | ||
51e72bc1 | 258 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 259 | { |
dc8fb6df PB |
260 | Error *err = NULL; |
261 | ||
51e72bc1 | 262 | visit_start_struct(v, name, (void **)obj, "%(name)s", sizeof(%(c_name)s), &err); |
297a3646 MA |
263 | if (err) { |
264 | goto out; | |
265 | } | |
e36c714e EB |
266 | if (!*obj) { |
267 | goto out_obj; | |
268 | } | |
06d64c62 | 269 | ''', |
40b3adec | 270 | c_name=c_name(name), name=name) |
06d64c62 | 271 | |
0aef92b9 | 272 | if base: |
50f2bdc7 | 273 | ret += mcgen(''' |
5c5e51a0 | 274 | visit_type_%(c_name)s_fields(v, (%(c_name)s **)obj, &err); |
50f2bdc7 | 275 | ''', |
5c5e51a0 EB |
276 | c_name=base.c_name()) |
277 | else: | |
278 | ret += mcgen(''' | |
51e72bc1 | 279 | visit_type_%(c_type)s(v, "%(name)s", &(*obj)->%(c_name)s, &err); |
5c5e51a0 EB |
280 | ''', |
281 | c_type=variants.tag_member.type.c_name(), | |
150d0564 | 282 | c_name=c_name(variants.tag_member.name), |
5c5e51a0 EB |
283 | name=variants.tag_member.name) |
284 | ret += gen_err_check(label='out_obj') | |
285 | ret += mcgen(''' | |
150d0564 | 286 | if (!visit_start_union(v, !!(*obj)->u.data, &err) || err) { |
e36c714e EB |
287 | goto out_obj; |
288 | } | |
289 | switch ((*obj)->%(c_name)s) { | |
0aef92b9 | 290 | ''', |
150d0564 | 291 | c_name=c_name(variants.tag_member.name)) |
0aef92b9 | 292 | |
441cbac0 MA |
293 | for var in variants.variants: |
294 | # TODO ugly special case for simple union | |
295 | simple_union_type = var.simple_union_type() | |
e98859a9 | 296 | ret += mcgen(''' |
e36c714e | 297 | case %(case)s: |
e98859a9 MA |
298 | ''', |
299 | case=c_enum_const(variants.tag_member.type.name, | |
300 | var.name)) | |
441cbac0 | 301 | if simple_union_type: |
e98859a9 | 302 | ret += mcgen(''' |
51e72bc1 | 303 | visit_type_%(c_type)s(v, "data", &(*obj)->u.%(c_name)s, &err); |
e98859a9 MA |
304 | ''', |
305 | c_type=simple_union_type.c_name(), | |
306 | c_name=c_name(var.name)) | |
50f2bdc7 | 307 | else: |
e98859a9 | 308 | ret += mcgen(''' |
150d0564 | 309 | visit_type_implicit_%(c_type)s(v, &(*obj)->u.%(c_name)s, &err); |
e98859a9 MA |
310 | ''', |
311 | c_type=var.type.c_name(), | |
312 | c_name=c_name(var.name)) | |
dc8fb6df | 313 | ret += mcgen(''' |
e36c714e | 314 | break; |
e98859a9 | 315 | ''') |
dc8fb6df PB |
316 | |
317 | ret += mcgen(''' | |
e36c714e EB |
318 | default: |
319 | abort(); | |
468866b8 | 320 | } |
e36c714e | 321 | out_obj: |
e36c714e EB |
322 | error_propagate(errp, err); |
323 | err = NULL; | |
f8b7f1a8 | 324 | visit_end_struct(v, &err); |
297a3646 MA |
325 | out: |
326 | error_propagate(errp, err); | |
dc8fb6df PB |
327 | } |
328 | ''') | |
329 | ||
06d64c62 MR |
330 | return ret |
331 | ||
e98859a9 | 332 | |
441cbac0 MA |
333 | class QAPISchemaGenVisitVisitor(QAPISchemaVisitor): |
334 | def __init__(self): | |
335 | self.decl = None | |
336 | self.defn = None | |
337 | self._btin = None | |
338 | ||
339 | def visit_begin(self, schema): | |
340 | self.decl = '' | |
341 | self.defn = '' | |
342 | self._btin = guardstart('QAPI_VISIT_BUILTIN') | |
343 | ||
344 | def visit_end(self): | |
345 | # To avoid header dependency hell, we always generate | |
346 | # declarations for built-in types in our header files and | |
347 | # simply guard them. See also do_builtins (command line | |
348 | # option -b). | |
349 | self._btin += guardend('QAPI_VISIT_BUILTIN') | |
350 | self.decl = self._btin + self.decl | |
351 | self._btin = None | |
352 | ||
25a0d9c9 EB |
353 | def visit_needed(self, entity): |
354 | # Visit everything except implicit objects | |
49823c4b EB |
355 | return not (entity.is_implicit() and |
356 | isinstance(entity, QAPISchemaObjectType)) | |
25a0d9c9 | 357 | |
441cbac0 | 358 | def visit_enum_type(self, name, info, values, prefix): |
7264f5c5 EB |
359 | # Special case for our lone builtin enum type |
360 | # TODO use something cleaner than existence of info | |
361 | if not info: | |
362 | self._btin += gen_visit_decl(name, scalar=True) | |
363 | if do_builtins: | |
364 | self.defn += gen_visit_enum(name) | |
365 | else: | |
366 | self.decl += gen_visit_decl(name, scalar=True) | |
367 | self.defn += gen_visit_enum(name) | |
441cbac0 MA |
368 | |
369 | def visit_array_type(self, name, info, element_type): | |
370 | decl = gen_visit_decl(name) | |
371 | defn = gen_visit_list(name, element_type) | |
372 | if isinstance(element_type, QAPISchemaBuiltinType): | |
373 | self._btin += decl | |
374 | if do_builtins: | |
375 | self.defn += defn | |
376 | else: | |
377 | self.decl += decl | |
378 | self.defn += defn | |
379 | ||
380 | def visit_object_type(self, name, info, base, members, variants): | |
25a0d9c9 EB |
381 | self.decl += gen_visit_decl(name) |
382 | if variants: | |
da34a9bd EB |
383 | if members: |
384 | # Members other than variants.tag_member not implemented | |
385 | assert len(members) == 1 | |
386 | assert members[0] == variants.tag_member | |
25a0d9c9 EB |
387 | self.defn += gen_visit_union(name, base, variants) |
388 | else: | |
389 | self.defn += gen_visit_struct(name, base, members) | |
441cbac0 MA |
390 | |
391 | def visit_alternate_type(self, name, info, variants): | |
392 | self.decl += gen_visit_decl(name) | |
393 | self.defn += gen_visit_alternate(name, variants) | |
394 | ||
395 | # If you link code generated from multiple schemata, you want only one | |
396 | # instance of the code for built-in types. Generate it only when | |
397 | # do_builtins, enabled by command line option -b. See also | |
398 | # QAPISchemaGenVisitVisitor.visit_end(). | |
7c946bc4 | 399 | do_builtins = False |
8d3bc517 | 400 | |
2114f5a9 MA |
401 | (input_file, output_dir, do_c, do_h, prefix, opts) = \ |
402 | parse_command_line("b", ["builtins"]) | |
403 | ||
06d64c62 | 404 | for o, a in opts: |
2114f5a9 | 405 | if o in ("-b", "--builtins"): |
7c946bc4 | 406 | do_builtins = True |
8d3bc517 | 407 | |
12f8e1b9 | 408 | c_comment = ''' |
06d64c62 MR |
409 | /* |
410 | * schema-defined QAPI visitor functions | |
411 | * | |
412 | * Copyright IBM, Corp. 2011 | |
413 | * | |
414 | * Authors: | |
415 | * Anthony Liguori <aliguori@us.ibm.com> | |
416 | * | |
417 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
418 | * See the COPYING.LIB file in the top-level directory. | |
419 | * | |
420 | */ | |
12f8e1b9 MA |
421 | ''' |
422 | h_comment = ''' | |
06d64c62 | 423 | /* |
297a3646 | 424 | * schema-defined QAPI visitor functions |
06d64c62 MR |
425 | * |
426 | * Copyright IBM, Corp. 2011 | |
427 | * | |
428 | * Authors: | |
429 | * Anthony Liguori <aliguori@us.ibm.com> | |
430 | * | |
431 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
432 | * See the COPYING.LIB file in the top-level directory. | |
433 | * | |
434 | */ | |
12f8e1b9 MA |
435 | ''' |
436 | ||
437 | (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix, | |
438 | 'qapi-visit.c', 'qapi-visit.h', | |
439 | c_comment, h_comment) | |
06d64c62 | 440 | |
12f8e1b9 MA |
441 | fdef.write(mcgen(''' |
442 | #include "qemu-common.h" | |
443 | #include "%(prefix)sqapi-visit.h" | |
444 | ''', | |
e98859a9 | 445 | prefix=prefix)) |
06d64c62 | 446 | |
12f8e1b9 | 447 | fdecl.write(mcgen(''' |
7b1b5d19 | 448 | #include "qapi/visitor.h" |
0426d53c | 449 | #include "qapi/qmp/qerror.h" |
06d64c62 | 450 | #include "%(prefix)sqapi-types.h" |
7c946bc4 | 451 | |
06d64c62 | 452 | ''', |
12f8e1b9 | 453 | prefix=prefix)) |
06d64c62 | 454 | |
441cbac0 MA |
455 | schema = QAPISchema(input_file) |
456 | gen = QAPISchemaGenVisitVisitor() | |
457 | schema.visit(gen) | |
458 | fdef.write(gen.defn) | |
459 | fdecl.write(gen.decl) | |
06d64c62 | 460 | |
12f8e1b9 | 461 | close_output(fdef, fdecl) |