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