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