]>
Commit | Line | Data |
---|---|---|
5ddeec83 MA |
1 | """ |
2 | QAPI visitor generator | |
3 | ||
4 | Copyright IBM, Corp. 2011 | |
5 | Copyright (C) 2014-2018 Red Hat, Inc. | |
6 | ||
7 | Authors: | |
8 | Anthony Liguori <aliguori@us.ibm.com> | |
9 | Michael Roth <mdroth@linux.vnet.ibm.com> | |
10 | Markus Armbruster <armbru@redhat.com> | |
11 | ||
12 | This work is licensed under the terms of the GNU GPL, version 2. | |
13 | See the COPYING file in the top-level directory. | |
14 | """ | |
06d64c62 | 15 | |
fb0bc835 | 16 | from qapi.common import * |
e6c42b96 MA |
17 | from qapi.gen import QAPISchemaModularCVisitor, ifcontext |
18 | from qapi.schema import QAPISchemaObjectType | |
06d64c62 | 19 | |
e98859a9 | 20 | |
60f8546a MA |
21 | def gen_visit_decl(name, scalar=False): |
22 | c_type = c_name(name) + ' *' | |
23 | if not scalar: | |
24 | c_type += '*' | |
25 | return mcgen(''' | |
012d4c96 | 26 | bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp); |
60f8546a MA |
27 | ''', |
28 | c_name=c_name(name), c_type=c_type) | |
29 | ||
30 | ||
4d91e911 | 31 | def gen_visit_members_decl(name): |
2208d649 | 32 | return mcgen(''' |
8c3f8e77 | 33 | |
012d4c96 | 34 | bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp); |
8c3f8e77 | 35 | ''', |
4d91e911 | 36 | c_name=c_name(name)) |
d02cf377 EB |
37 | |
38 | ||
14f00c6c | 39 | def gen_visit_object_members(name, base, members, variants): |
4d91e911 | 40 | ret = mcgen(''' |
50f2bdc7 | 41 | |
012d4c96 | 42 | bool visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp) |
50f2bdc7 | 43 | { |
50f2bdc7 | 44 | ''', |
4d91e911 | 45 | c_name=c_name(name)) |
d195325b | 46 | |
622f557f KW |
47 | if base: |
48 | ret += mcgen(''' | |
012d4c96 MA |
49 | if (!visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, errp)) { |
50 | return false; | |
fa274ed6 | 51 | } |
622f557f | 52 | ''', |
ddf21908 | 53 | c_type=base.c_name()) |
622f557f | 54 | |
12f254fd | 55 | for memb in members: |
8ee06f61 | 56 | ret += gen_if(memb.ifcond) |
12f254fd EB |
57 | if memb.optional: |
58 | ret += mcgen(''' | |
59 | if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) { | |
60 | ''', | |
61 | name=memb.name, c_name=c_name(memb.name)) | |
62 | push_indent() | |
63 | ret += mcgen(''' | |
012d4c96 MA |
64 | if (!visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, errp)) { |
65 | return false; | |
fa274ed6 | 66 | } |
12f254fd EB |
67 | ''', |
68 | c_type=memb.type.c_name(), name=memb.name, | |
69 | c_name=c_name(memb.name)) | |
12f254fd EB |
70 | if memb.optional: |
71 | pop_indent() | |
72 | ret += mcgen(''' | |
73 | } | |
74 | ''') | |
8ee06f61 | 75 | ret += gen_endif(memb.ifcond) |
d195325b | 76 | |
9a5cd424 EB |
77 | if variants: |
78 | ret += mcgen(''' | |
65551903 | 79 | switch (obj->%(c_name)s) { |
9a5cd424 EB |
80 | ''', |
81 | c_name=c_name(variants.tag_member.name)) | |
82 | ||
83 | for var in variants.variants: | |
800877bb AN |
84 | case_str = c_enum_const(variants.tag_member.type.name, |
85 | var.name, | |
86 | variants.tag_member.type.prefix) | |
8ee06f61 | 87 | ret += gen_if(var.ifcond) |
800877bb AN |
88 | if var.type.name == 'q_empty': |
89 | # valid variant and nothing to do | |
90 | ret += mcgen(''' | |
91 | case %(case)s: | |
92 | break; | |
93 | ''', | |
94 | case=case_str) | |
95 | else: | |
96 | ret += mcgen(''' | |
9a5cd424 | 97 | case %(case)s: |
cdd2b228 | 98 | return visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, errp); |
9a5cd424 | 99 | ''', |
800877bb AN |
100 | case=case_str, |
101 | c_type=var.type.c_name(), c_name=c_name(var.name)) | |
9a5cd424 | 102 | |
8ee06f61 | 103 | ret += gen_endif(var.ifcond) |
9a5cd424 EB |
104 | ret += mcgen(''' |
105 | default: | |
106 | abort(); | |
107 | } | |
108 | ''') | |
109 | ||
297a3646 | 110 | ret += mcgen(''' |
cdd2b228 | 111 | return true; |
50f2bdc7 KW |
112 | } |
113 | ''') | |
d131c897 KW |
114 | return ret |
115 | ||
116 | ||
441cbac0 | 117 | def gen_visit_list(name, element_type): |
06d64c62 MR |
118 | return mcgen(''' |
119 | ||
012d4c96 | 120 | bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 121 | { |
cdd2b228 | 122 | bool ok = false; |
d9f62dde EB |
123 | %(c_name)s *tail; |
124 | size_t size = sizeof(**obj); | |
06d64c62 | 125 | |
012d4c96 MA |
126 | if (!visit_start_list(v, name, (GenericList **)obj, size, errp)) { |
127 | return false; | |
297a3646 MA |
128 | } |
129 | ||
d9f62dde EB |
130 | for (tail = *obj; tail; |
131 | tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) { | |
cdd2b228 MA |
132 | if (!visit_type_%(c_elt_type)s(v, NULL, &tail->value, errp)) { |
133 | goto out_obj; | |
d9f62dde | 134 | } |
06d64c62 | 135 | } |
297a3646 | 136 | |
cdd2b228 MA |
137 | ok = visit_check_list(v, errp); |
138 | out_obj: | |
1158bb2a | 139 | visit_end_list(v, (void **)obj); |
cdd2b228 | 140 | if (!ok && visit_is_input(v)) { |
68ab47e4 EB |
141 | qapi_free_%(c_name)s(*obj); |
142 | *obj = NULL; | |
143 | } | |
cdd2b228 | 144 | return ok; |
06d64c62 MR |
145 | } |
146 | ''', | |
e98859a9 | 147 | c_name=c_name(name), c_elt_type=element_type.c_name()) |
06d64c62 | 148 | |
e98859a9 MA |
149 | |
150 | def gen_visit_enum(name): | |
06d64c62 MR |
151 | return mcgen(''' |
152 | ||
012d4c96 | 153 | bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp) |
06d64c62 | 154 | { |
395a233f | 155 | int value = *obj; |
012d4c96 | 156 | bool ok = visit_type_enum(v, name, &value, &%(c_name)s_lookup, errp); |
395a233f | 157 | *obj = value; |
012d4c96 | 158 | return ok; |
06d64c62 MR |
159 | } |
160 | ''', | |
337283df | 161 | c_name=c_name(name)) |
06d64c62 | 162 | |
e98859a9 | 163 | |
441cbac0 | 164 | def gen_visit_alternate(name, variants): |
60390d2d | 165 | ret = mcgen(''' |
69dd62df | 166 | |
012d4c96 | 167 | bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
69dd62df | 168 | { |
cdd2b228 | 169 | bool ok = false; |
69dd62df | 170 | |
012d4c96 MA |
171 | if (!visit_start_alternate(v, name, (GenericAlternate **)obj, |
172 | sizeof(**obj), errp)) { | |
173 | return false; | |
297a3646 | 174 | } |
9b4e38fe | 175 | if (!*obj) { |
8e08bf4e MA |
176 | /* incomplete */ |
177 | assert(visit_is_dealloc(v)); | |
cdd2b228 | 178 | ok = true; |
9b4e38fe EB |
179 | goto out_obj; |
180 | } | |
150d0564 | 181 | switch ((*obj)->type) { |
69dd62df | 182 | ''', |
b736e25a | 183 | c_name=c_name(name)) |
69dd62df | 184 | |
441cbac0 | 185 | for var in variants.variants: |
8ee06f61 | 186 | ret += gen_if(var.ifcond) |
69dd62df | 187 | ret += mcgen(''' |
e98859a9 | 188 | case %(case)s: |
becceedc EB |
189 | ''', |
190 | case=var.type.alternate_qtype()) | |
191 | if isinstance(var.type, QAPISchemaObjectType): | |
192 | ret += mcgen(''' | |
cdd2b228 | 193 | if (!visit_start_struct(v, name, NULL, 0, errp)) { |
becceedc EB |
194 | break; |
195 | } | |
cdd2b228 MA |
196 | if (visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, errp)) { |
197 | ok = visit_check_struct(v, errp); | |
15c2f669 | 198 | } |
1158bb2a | 199 | visit_end_struct(v, NULL); |
becceedc EB |
200 | ''', |
201 | c_type=var.type.c_name(), | |
202 | c_name=c_name(var.name)) | |
203 | else: | |
204 | ret += mcgen(''' | |
cdd2b228 | 205 | ok = visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, errp); |
69dd62df | 206 | ''', |
becceedc EB |
207 | c_type=var.type.c_name(), |
208 | c_name=c_name(var.name)) | |
209 | ret += mcgen(''' | |
210 | break; | |
211 | ''') | |
8ee06f61 | 212 | ret += gen_endif(var.ifcond) |
69dd62df KW |
213 | |
214 | ret += mcgen(''' | |
9b4e38fe EB |
215 | case QTYPE_NONE: |
216 | abort(); | |
297a3646 | 217 | default: |
7111a86e | 218 | assert(visit_is_input(v)); |
cdd2b228 | 219 | error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null", |
0426d53c | 220 | "%(name)s"); |
c978bd52 MA |
221 | /* Avoid passing invalid *obj to qapi_free_%(c_name)s() */ |
222 | g_free(*obj); | |
223 | *obj = NULL; | |
69dd62df | 224 | } |
9b4e38fe | 225 | out_obj: |
1158bb2a | 226 | visit_end_alternate(v, (void **)obj); |
cdd2b228 | 227 | if (!ok && visit_is_input(v)) { |
68ab47e4 EB |
228 | qapi_free_%(c_name)s(*obj); |
229 | *obj = NULL; | |
230 | } | |
cdd2b228 | 231 | return ok; |
69dd62df | 232 | } |
0426d53c | 233 | ''', |
68ab47e4 | 234 | name=name, c_name=c_name(name)) |
69dd62df KW |
235 | |
236 | return ret | |
237 | ||
e98859a9 | 238 | |
59d9e84c | 239 | def gen_visit_object(name, base, members, variants): |
7ce106a9 | 240 | return mcgen(''' |
06d64c62 | 241 | |
012d4c96 | 242 | bool visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp) |
06d64c62 | 243 | { |
cdd2b228 | 244 | bool ok = false; |
dc8fb6df | 245 | |
012d4c96 MA |
246 | if (!visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), errp)) { |
247 | return false; | |
297a3646 | 248 | } |
e36c714e | 249 | if (!*obj) { |
8e08bf4e MA |
250 | /* incomplete */ |
251 | assert(visit_is_dealloc(v)); | |
cbf97d5b | 252 | ok = true; |
e36c714e EB |
253 | goto out_obj; |
254 | } | |
cdd2b228 | 255 | if (!visit_type_%(c_name)s_members(v, *obj, errp)) { |
15c2f669 EB |
256 | goto out_obj; |
257 | } | |
cdd2b228 | 258 | ok = visit_check_struct(v, errp); |
9a5cd424 | 259 | out_obj: |
1158bb2a | 260 | visit_end_struct(v, (void **)obj); |
cdd2b228 | 261 | if (!ok && visit_is_input(v)) { |
68ab47e4 EB |
262 | qapi_free_%(c_name)s(*obj); |
263 | *obj = NULL; | |
264 | } | |
cdd2b228 | 265 | return ok; |
dc8fb6df | 266 | } |
9a5cd424 EB |
267 | ''', |
268 | c_name=c_name(name)) | |
dc8fb6df | 269 | |
e98859a9 | 270 | |
cdb6610a | 271 | class QAPISchemaGenVisitVisitor(QAPISchemaModularCVisitor): |
71b3f045 | 272 | |
cdb6610a | 273 | def __init__(self, prefix): |
2cae67bc MA |
274 | super().__init__( |
275 | prefix, 'qapi-visit', ' * Schema-defined QAPI visitors', | |
3bef3aae MA |
276 | ' * Built-in QAPI visitors', __doc__) |
277 | ||
278 | def _begin_system_module(self, name): | |
cdb6610a MA |
279 | self._genc.preamble_add(mcgen(''' |
280 | #include "qemu/osdep.h" | |
cdb6610a | 281 | #include "qapi/error.h" |
eb815e24 | 282 | #include "qapi/qapi-builtin-visit.h" |
cdb6610a MA |
283 | ''')) |
284 | self._genh.preamble_add(mcgen(''' | |
285 | #include "qapi/visitor.h" | |
eb815e24 | 286 | #include "qapi/qapi-builtin-types.h" |
cdb6610a | 287 | |
3bef3aae | 288 | ''')) |
cdb6610a | 289 | |
dcac6471 | 290 | def _begin_user_module(self, name): |
9af23989 MA |
291 | types = self._module_basename('qapi-types', name) |
292 | visit = self._module_basename('qapi-visit', name) | |
71b3f045 MA |
293 | self._genc.preamble_add(mcgen(''' |
294 | #include "qemu/osdep.h" | |
71b3f045 MA |
295 | #include "qapi/error.h" |
296 | #include "qapi/qmp/qerror.h" | |
9af23989 | 297 | #include "%(visit)s.h" |
71b3f045 | 298 | ''', |
a48e7542 | 299 | visit=visit)) |
71b3f045 | 300 | self._genh.preamble_add(mcgen(''' |
eb815e24 | 301 | #include "qapi/qapi-builtin-visit.h" |
9af23989 | 302 | #include "%(types)s.h" |
441cbac0 | 303 | |
71b3f045 | 304 | ''', |
9af23989 | 305 | types=types)) |
441cbac0 | 306 | |
013b4efc | 307 | def visit_enum_type(self, name, info, ifcond, features, members, prefix): |
9f88c662 MA |
308 | with ifcontext(ifcond, self._genh, self._genc): |
309 | self._genh.add(gen_visit_decl(name, scalar=True)) | |
310 | self._genc.add(gen_visit_enum(name)) | |
441cbac0 | 311 | |
fbf09a2f | 312 | def visit_array_type(self, name, info, ifcond, element_type): |
9f88c662 MA |
313 | with ifcontext(ifcond, self._genh, self._genc): |
314 | self._genh.add(gen_visit_decl(name)) | |
315 | self._genc.add(gen_visit_list(name, element_type)) | |
441cbac0 | 316 | |
7b3bc9e2 MA |
317 | def visit_object_type(self, name, info, ifcond, features, |
318 | base, members, variants): | |
7ce106a9 EB |
319 | # Nothing to do for the special empty builtin |
320 | if name == 'q_empty': | |
321 | return | |
9f88c662 MA |
322 | with ifcontext(ifcond, self._genh, self._genc): |
323 | self._genh.add(gen_visit_members_decl(name)) | |
324 | self._genc.add(gen_visit_object_members(name, base, | |
325 | members, variants)) | |
326 | # TODO Worth changing the visitor signature, so we could | |
327 | # directly use rather than repeat type.is_implicit()? | |
328 | if not name.startswith('q_'): | |
329 | # only explicit types need an allocating visit | |
330 | self._genh.add(gen_visit_decl(name)) | |
331 | self._genc.add(gen_visit_object(name, base, members, variants)) | |
441cbac0 | 332 | |
013b4efc | 333 | def visit_alternate_type(self, name, info, ifcond, features, variants): |
9f88c662 MA |
334 | with ifcontext(ifcond, self._genh, self._genc): |
335 | self._genh.add(gen_visit_decl(name)) | |
336 | self._genc.add(gen_visit_alternate(name, variants)) | |
441cbac0 | 337 | |
8d3bc517 | 338 | |
fb0bc835 | 339 | def gen_visit(schema, output_dir, prefix, opt_builtins): |
cdb6610a | 340 | vis = QAPISchemaGenVisitVisitor(prefix) |
26df4e7f | 341 | schema.visit(vis) |
cdb6610a | 342 | vis.write(output_dir, opt_builtins) |