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