]>
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): |
dd5ee2c2 EB |
111 | # FIXME: if *obj is NULL on entry, and the first visit_next_list() |
112 | # assigns to *obj, while a later one fails, we should clean up *obj | |
113 | # rather than leaving it non-NULL. As currently written, the caller must | |
114 | # call qapi_free_FOOList() to avoid a memory leak of the partial FOOList. | |
06d64c62 MR |
115 | return mcgen(''' |
116 | ||
51e72bc1 | 117 | void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 118 | { |
d195325b | 119 | Error *err = NULL; |
d9f62dde EB |
120 | %(c_name)s *tail; |
121 | size_t size = sizeof(**obj); | |
06d64c62 | 122 | |
d9f62dde | 123 | visit_start_list(v, name, (GenericList **)obj, size, &err); |
297a3646 MA |
124 | if (err) { |
125 | goto out; | |
126 | } | |
127 | ||
d9f62dde EB |
128 | for (tail = *obj; tail; |
129 | tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) { | |
130 | visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err); | |
131 | if (err) { | |
132 | break; | |
133 | } | |
06d64c62 | 134 | } |
297a3646 | 135 | |
08f9541d | 136 | visit_end_list(v); |
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); |
297a3646 MA |
214 | out: |
215 | error_propagate(errp, err); | |
69dd62df | 216 | } |
0426d53c EB |
217 | ''', |
218 | name=name) | |
69dd62df KW |
219 | |
220 | return ret | |
221 | ||
e98859a9 | 222 | |
59d9e84c | 223 | def gen_visit_object(name, base, members, variants): |
59d9e84c | 224 | # FIXME: if *obj is NULL on entry, and visit_start_struct() assigns to |
14f00c6c | 225 | # *obj, but then visit_type_FOO_members() fails, we should clean up *obj |
59d9e84c MA |
226 | # rather than leaving it non-NULL. As currently written, the caller must |
227 | # call qapi_free_FOO() to avoid a memory leak of the partial FOO. | |
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); |
297a3646 MA |
248 | out: |
249 | error_propagate(errp, err); | |
dc8fb6df | 250 | } |
9a5cd424 EB |
251 | ''', |
252 | c_name=c_name(name)) | |
dc8fb6df | 253 | |
e98859a9 | 254 | |
441cbac0 MA |
255 | class QAPISchemaGenVisitVisitor(QAPISchemaVisitor): |
256 | def __init__(self): | |
257 | self.decl = None | |
258 | self.defn = None | |
259 | self._btin = None | |
260 | ||
261 | def visit_begin(self, schema): | |
262 | self.decl = '' | |
263 | self.defn = '' | |
264 | self._btin = guardstart('QAPI_VISIT_BUILTIN') | |
265 | ||
266 | def visit_end(self): | |
267 | # To avoid header dependency hell, we always generate | |
268 | # declarations for built-in types in our header files and | |
269 | # simply guard them. See also do_builtins (command line | |
270 | # option -b). | |
271 | self._btin += guardend('QAPI_VISIT_BUILTIN') | |
272 | self.decl = self._btin + self.decl | |
273 | self._btin = None | |
274 | ||
275 | def visit_enum_type(self, name, info, values, prefix): | |
7264f5c5 EB |
276 | # Special case for our lone builtin enum type |
277 | # TODO use something cleaner than existence of info | |
278 | if not info: | |
279 | self._btin += gen_visit_decl(name, scalar=True) | |
280 | if do_builtins: | |
281 | self.defn += gen_visit_enum(name) | |
282 | else: | |
283 | self.decl += gen_visit_decl(name, scalar=True) | |
284 | self.defn += gen_visit_enum(name) | |
441cbac0 MA |
285 | |
286 | def visit_array_type(self, name, info, element_type): | |
287 | decl = gen_visit_decl(name) | |
288 | defn = gen_visit_list(name, element_type) | |
289 | if isinstance(element_type, QAPISchemaBuiltinType): | |
290 | self._btin += decl | |
291 | if do_builtins: | |
292 | self.defn += defn | |
293 | else: | |
294 | self.decl += decl | |
295 | self.defn += defn | |
296 | ||
297 | def visit_object_type(self, name, info, base, members, variants): | |
7ce106a9 EB |
298 | # Nothing to do for the special empty builtin |
299 | if name == 'q_empty': | |
300 | return | |
4d91e911 | 301 | self.decl += gen_visit_members_decl(name) |
7ce106a9 EB |
302 | self.defn += gen_visit_object_members(name, base, members, variants) |
303 | # TODO Worth changing the visitor signature, so we could | |
304 | # directly use rather than repeat type.is_implicit()? | |
305 | if not name.startswith('q_'): | |
306 | # only explicit types need an allocating visit | |
307 | self.decl += gen_visit_decl(name) | |
308 | self.defn += gen_visit_object(name, base, members, variants) | |
441cbac0 MA |
309 | |
310 | def visit_alternate_type(self, name, info, variants): | |
311 | self.decl += gen_visit_decl(name) | |
312 | self.defn += gen_visit_alternate(name, variants) | |
313 | ||
314 | # If you link code generated from multiple schemata, you want only one | |
315 | # instance of the code for built-in types. Generate it only when | |
316 | # do_builtins, enabled by command line option -b. See also | |
317 | # QAPISchemaGenVisitVisitor.visit_end(). | |
7c946bc4 | 318 | do_builtins = False |
8d3bc517 | 319 | |
2114f5a9 MA |
320 | (input_file, output_dir, do_c, do_h, prefix, opts) = \ |
321 | parse_command_line("b", ["builtins"]) | |
322 | ||
06d64c62 | 323 | for o, a in opts: |
2114f5a9 | 324 | if o in ("-b", "--builtins"): |
7c946bc4 | 325 | do_builtins = True |
8d3bc517 | 326 | |
12f8e1b9 | 327 | c_comment = ''' |
06d64c62 MR |
328 | /* |
329 | * schema-defined QAPI visitor functions | |
330 | * | |
331 | * Copyright IBM, Corp. 2011 | |
332 | * | |
333 | * Authors: | |
334 | * Anthony Liguori <aliguori@us.ibm.com> | |
335 | * | |
336 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
337 | * See the COPYING.LIB file in the top-level directory. | |
338 | * | |
339 | */ | |
12f8e1b9 MA |
340 | ''' |
341 | h_comment = ''' | |
06d64c62 | 342 | /* |
297a3646 | 343 | * schema-defined QAPI visitor functions |
06d64c62 MR |
344 | * |
345 | * Copyright IBM, Corp. 2011 | |
346 | * | |
347 | * Authors: | |
348 | * Anthony Liguori <aliguori@us.ibm.com> | |
349 | * | |
350 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
351 | * See the COPYING.LIB file in the top-level directory. | |
352 | * | |
353 | */ | |
12f8e1b9 MA |
354 | ''' |
355 | ||
356 | (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix, | |
357 | 'qapi-visit.c', 'qapi-visit.h', | |
358 | c_comment, h_comment) | |
06d64c62 | 359 | |
12f8e1b9 | 360 | fdef.write(mcgen(''' |
9167ebd9 | 361 | #include "qemu/osdep.h" |
12f8e1b9 | 362 | #include "qemu-common.h" |
da34e65c | 363 | #include "qapi/error.h" |
12f8e1b9 MA |
364 | #include "%(prefix)sqapi-visit.h" |
365 | ''', | |
e98859a9 | 366 | prefix=prefix)) |
06d64c62 | 367 | |
12f8e1b9 | 368 | fdecl.write(mcgen(''' |
7b1b5d19 | 369 | #include "qapi/visitor.h" |
0426d53c | 370 | #include "qapi/qmp/qerror.h" |
06d64c62 | 371 | #include "%(prefix)sqapi-types.h" |
7c946bc4 | 372 | |
06d64c62 | 373 | ''', |
12f8e1b9 | 374 | prefix=prefix)) |
06d64c62 | 375 | |
441cbac0 MA |
376 | schema = QAPISchema(input_file) |
377 | gen = QAPISchemaGenVisitVisitor() | |
378 | schema.visit(gen) | |
379 | fdef.write(gen.defn) | |
380 | fdecl.write(gen.decl) | |
06d64c62 | 381 | |
12f8e1b9 | 382 | close_output(fdef, fdecl) |