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