]>
Commit | Line | Data |
---|---|---|
2345c77c MR |
1 | /* |
2 | * Core Definitions for QAPI Visitor Classes | |
3 | * | |
7c91aabd | 4 | * Copyright (C) 2012-2016 Red Hat, Inc. |
2345c77c MR |
5 | * Copyright IBM, Corp. 2011 |
6 | * | |
7 | * Authors: | |
8 | * Anthony Liguori <[email protected]> | |
9 | * | |
10 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
11 | * See the COPYING.LIB file in the top-level directory. | |
12 | * | |
13 | */ | |
14 | ||
cbf21151 | 15 | #include "qemu/osdep.h" |
da34e65c | 16 | #include "qapi/error.h" |
79ee7df8 | 17 | #include "qemu-common.h" |
7b1b5d19 PB |
18 | #include "qapi/qmp/qerror.h" |
19 | #include "qapi/visitor.h" | |
20 | #include "qapi/visitor-impl.h" | |
ebfd93b6 | 21 | #include "trace.h" |
2345c77c | 22 | |
3b098d56 EB |
23 | void visit_complete(Visitor *v, void *opaque) |
24 | { | |
25 | assert(v->type != VISITOR_OUTPUT || v->complete); | |
ebfd93b6 | 26 | trace_visit_complete(v, opaque); |
3b098d56 EB |
27 | if (v->complete) { |
28 | v->complete(v, opaque); | |
29 | } | |
30 | } | |
31 | ||
2c0ef9f4 EB |
32 | void visit_free(Visitor *v) |
33 | { | |
ebfd93b6 | 34 | trace_visit_free(v); |
2c0ef9f4 EB |
35 | if (v) { |
36 | v->free(v); | |
37 | } | |
38 | } | |
39 | ||
51e72bc1 | 40 | void visit_start_struct(Visitor *v, const char *name, void **obj, |
337283df | 41 | size_t size, Error **errp) |
2345c77c | 42 | { |
e58d695e EB |
43 | Error *err = NULL; |
44 | ||
ebfd93b6 | 45 | trace_visit_start_struct(v, name, obj, size); |
adfb264c EB |
46 | if (obj) { |
47 | assert(size); | |
a15fcc3c | 48 | assert(!(v->type & VISITOR_OUTPUT) || *obj); |
adfb264c | 49 | } |
e58d695e | 50 | v->start_struct(v, name, obj, size, &err); |
a15fcc3c | 51 | if (obj && (v->type & VISITOR_INPUT)) { |
e58d695e EB |
52 | assert(!err != !*obj); |
53 | } | |
54 | error_propagate(errp, err); | |
2345c77c MR |
55 | } |
56 | ||
15c2f669 | 57 | void visit_check_struct(Visitor *v, Error **errp) |
2345c77c | 58 | { |
ebfd93b6 | 59 | trace_visit_check_struct(v); |
15c2f669 EB |
60 | if (v->check_struct) { |
61 | v->check_struct(v, errp); | |
62 | } | |
63 | } | |
64 | ||
1158bb2a | 65 | void visit_end_struct(Visitor *v, void **obj) |
15c2f669 | 66 | { |
ebfd93b6 | 67 | trace_visit_end_struct(v, obj); |
1158bb2a | 68 | v->end_struct(v, obj); |
2345c77c MR |
69 | } |
70 | ||
d9f62dde EB |
71 | void visit_start_list(Visitor *v, const char *name, GenericList **list, |
72 | size_t size, Error **errp) | |
2345c77c | 73 | { |
d9f62dde EB |
74 | Error *err = NULL; |
75 | ||
76 | assert(!list || size >= sizeof(GenericList)); | |
ebfd93b6 | 77 | trace_visit_start_list(v, name, list, size); |
d9f62dde | 78 | v->start_list(v, name, list, size, &err); |
a15fcc3c | 79 | if (list && (v->type & VISITOR_INPUT)) { |
d9f62dde EB |
80 | assert(!(err && *list)); |
81 | } | |
82 | error_propagate(errp, err); | |
2345c77c MR |
83 | } |
84 | ||
d9f62dde | 85 | GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size) |
2345c77c | 86 | { |
d9f62dde | 87 | assert(tail && size >= sizeof(GenericList)); |
ebfd93b6 | 88 | trace_visit_next_list(v, tail, size); |
d9f62dde | 89 | return v->next_list(v, tail, size); |
2345c77c MR |
90 | } |
91 | ||
a4a1c70d MA |
92 | void visit_check_list(Visitor *v, Error **errp) |
93 | { | |
94 | trace_visit_check_list(v); | |
95 | if (v->check_list) { | |
96 | v->check_list(v, errp); | |
97 | } | |
98 | } | |
99 | ||
1158bb2a | 100 | void visit_end_list(Visitor *v, void **obj) |
2345c77c | 101 | { |
ebfd93b6 | 102 | trace_visit_end_list(v, obj); |
1158bb2a | 103 | v->end_list(v, obj); |
2345c77c MR |
104 | } |
105 | ||
dbf11922 EB |
106 | void visit_start_alternate(Visitor *v, const char *name, |
107 | GenericAlternate **obj, size_t size, | |
60390d2d | 108 | Error **errp) |
2345c77c | 109 | { |
e58d695e EB |
110 | Error *err = NULL; |
111 | ||
dbf11922 | 112 | assert(obj && size >= sizeof(GenericAlternate)); |
a15fcc3c | 113 | assert(!(v->type & VISITOR_OUTPUT) || *obj); |
60390d2d | 114 | trace_visit_start_alternate(v, name, obj, size); |
dbf11922 | 115 | if (v->start_alternate) { |
60390d2d | 116 | v->start_alternate(v, name, obj, size, &err); |
e58d695e | 117 | } |
a15fcc3c | 118 | if (v->type & VISITOR_INPUT) { |
e58d695e | 119 | assert(v->start_alternate && !err != !*obj); |
dbf11922 | 120 | } |
e58d695e | 121 | error_propagate(errp, err); |
dbf11922 EB |
122 | } |
123 | ||
1158bb2a | 124 | void visit_end_alternate(Visitor *v, void **obj) |
dbf11922 | 125 | { |
ebfd93b6 | 126 | trace_visit_end_alternate(v, obj); |
dbf11922 | 127 | if (v->end_alternate) { |
1158bb2a | 128 | v->end_alternate(v, obj); |
2345c77c MR |
129 | } |
130 | } | |
131 | ||
dbf11922 | 132 | bool visit_optional(Visitor *v, const char *name, bool *present) |
69dd62df | 133 | { |
ebfd93b6 | 134 | trace_visit_optional(v, name, present); |
dbf11922 EB |
135 | if (v->optional) { |
136 | v->optional(v, name, present); | |
69dd62df | 137 | } |
dbf11922 | 138 | return *present; |
69dd62df KW |
139 | } |
140 | ||
68ab47e4 EB |
141 | bool visit_is_input(Visitor *v) |
142 | { | |
143 | return v->type == VISITOR_INPUT; | |
144 | } | |
145 | ||
51e72bc1 | 146 | void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp) |
2345c77c | 147 | { |
adfb264c | 148 | assert(obj); |
ebfd93b6 | 149 | trace_visit_type_int(v, name, obj); |
0b2a0d6b | 150 | v->type_int64(v, name, obj, errp); |
2345c77c MR |
151 | } |
152 | ||
04e070d2 EB |
153 | static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name, |
154 | uint64_t max, const char *type, Error **errp) | |
155 | { | |
156 | Error *err = NULL; | |
157 | uint64_t value = *obj; | |
158 | ||
0b2a0d6b | 159 | v->type_uint64(v, name, &value, &err); |
04e070d2 EB |
160 | if (err) { |
161 | error_propagate(errp, err); | |
162 | } else if (value > max) { | |
163 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, | |
164 | name ? name : "null", type); | |
297a3646 | 165 | } else { |
297a3646 | 166 | *obj = value; |
4e27e819 MR |
167 | } |
168 | } | |
169 | ||
51e72bc1 EB |
170 | void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj, |
171 | Error **errp) | |
4e27e819 | 172 | { |
ebfd93b6 DB |
173 | uint64_t value; |
174 | ||
175 | trace_visit_type_uint8(v, name, obj); | |
176 | value = *obj; | |
04e070d2 EB |
177 | visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp); |
178 | *obj = value; | |
4e27e819 MR |
179 | } |
180 | ||
51e72bc1 | 181 | void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj, |
04e070d2 | 182 | Error **errp) |
4e27e819 | 183 | { |
ebfd93b6 DB |
184 | uint64_t value; |
185 | ||
186 | trace_visit_type_uint16(v, name, obj); | |
187 | value = *obj; | |
04e070d2 EB |
188 | visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp); |
189 | *obj = value; | |
190 | } | |
297a3646 | 191 | |
51e72bc1 | 192 | void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj, |
04e070d2 EB |
193 | Error **errp) |
194 | { | |
ebfd93b6 DB |
195 | uint64_t value; |
196 | ||
197 | trace_visit_type_uint32(v, name, obj); | |
198 | value = *obj; | |
04e070d2 EB |
199 | visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp); |
200 | *obj = value; | |
4e27e819 MR |
201 | } |
202 | ||
51e72bc1 | 203 | void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj, |
04e070d2 | 204 | Error **errp) |
4e27e819 | 205 | { |
adfb264c | 206 | assert(obj); |
ebfd93b6 | 207 | trace_visit_type_uint64(v, name, obj); |
0b2a0d6b | 208 | v->type_uint64(v, name, obj, errp); |
4e27e819 MR |
209 | } |
210 | ||
04e070d2 EB |
211 | static void visit_type_intN(Visitor *v, int64_t *obj, const char *name, |
212 | int64_t min, int64_t max, const char *type, | |
213 | Error **errp) | |
4e27e819 | 214 | { |
04e070d2 EB |
215 | Error *err = NULL; |
216 | int64_t value = *obj; | |
297a3646 | 217 | |
0b2a0d6b | 218 | v->type_int64(v, name, &value, &err); |
04e070d2 EB |
219 | if (err) { |
220 | error_propagate(errp, err); | |
221 | } else if (value < min || value > max) { | |
222 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, | |
223 | name ? name : "null", type); | |
297a3646 | 224 | } else { |
297a3646 | 225 | *obj = value; |
4e27e819 MR |
226 | } |
227 | } | |
228 | ||
51e72bc1 | 229 | void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp) |
4e27e819 | 230 | { |
ebfd93b6 DB |
231 | int64_t value; |
232 | ||
233 | trace_visit_type_int8(v, name, obj); | |
234 | value = *obj; | |
04e070d2 EB |
235 | visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp); |
236 | *obj = value; | |
237 | } | |
297a3646 | 238 | |
51e72bc1 EB |
239 | void visit_type_int16(Visitor *v, const char *name, int16_t *obj, |
240 | Error **errp) | |
04e070d2 | 241 | { |
ebfd93b6 DB |
242 | int64_t value; |
243 | ||
244 | trace_visit_type_int16(v, name, obj); | |
245 | value = *obj; | |
04e070d2 EB |
246 | visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp); |
247 | *obj = value; | |
4e27e819 MR |
248 | } |
249 | ||
51e72bc1 EB |
250 | void visit_type_int32(Visitor *v, const char *name, int32_t *obj, |
251 | Error **errp) | |
4e27e819 | 252 | { |
ebfd93b6 DB |
253 | int64_t value; |
254 | ||
255 | trace_visit_type_int32(v, name, obj); | |
256 | value = *obj; | |
04e070d2 EB |
257 | visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp); |
258 | *obj = value; | |
4e27e819 MR |
259 | } |
260 | ||
51e72bc1 EB |
261 | void visit_type_int64(Visitor *v, const char *name, int64_t *obj, |
262 | Error **errp) | |
4e27e819 | 263 | { |
adfb264c | 264 | assert(obj); |
ebfd93b6 | 265 | trace_visit_type_int64(v, name, obj); |
0b2a0d6b | 266 | v->type_int64(v, name, obj, errp); |
4e27e819 MR |
267 | } |
268 | ||
51e72bc1 EB |
269 | void visit_type_size(Visitor *v, const char *name, uint64_t *obj, |
270 | Error **errp) | |
092705d4 | 271 | { |
adfb264c | 272 | assert(obj); |
ebfd93b6 | 273 | trace_visit_type_size(v, name, obj); |
297a3646 | 274 | if (v->type_size) { |
0b2a0d6b | 275 | v->type_size(v, name, obj, errp); |
297a3646 | 276 | } else { |
0b2a0d6b | 277 | v->type_uint64(v, name, obj, errp); |
092705d4 LE |
278 | } |
279 | } | |
280 | ||
51e72bc1 | 281 | void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp) |
2345c77c | 282 | { |
adfb264c | 283 | assert(obj); |
ebfd93b6 | 284 | trace_visit_type_bool(v, name, obj); |
0b2a0d6b | 285 | v->type_bool(v, name, obj, errp); |
2345c77c MR |
286 | } |
287 | ||
51e72bc1 | 288 | void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp) |
2345c77c | 289 | { |
e58d695e EB |
290 | Error *err = NULL; |
291 | ||
292 | assert(obj); | |
adfb264c EB |
293 | /* TODO: Fix callers to not pass NULL when they mean "", so that we |
294 | * can enable: | |
a15fcc3c | 295 | assert(!(v->type & VISITOR_OUTPUT) || *obj); |
adfb264c | 296 | */ |
ebfd93b6 | 297 | trace_visit_type_str(v, name, obj); |
e58d695e | 298 | v->type_str(v, name, obj, &err); |
a15fcc3c | 299 | if (v->type & VISITOR_INPUT) { |
e58d695e EB |
300 | assert(!err != !*obj); |
301 | } | |
302 | error_propagate(errp, err); | |
2345c77c MR |
303 | } |
304 | ||
51e72bc1 EB |
305 | void visit_type_number(Visitor *v, const char *name, double *obj, |
306 | Error **errp) | |
2345c77c | 307 | { |
adfb264c | 308 | assert(obj); |
ebfd93b6 | 309 | trace_visit_type_number(v, name, obj); |
0b2a0d6b | 310 | v->type_number(v, name, obj, errp); |
2345c77c | 311 | } |
0f71a1e0 | 312 | |
51e72bc1 | 313 | void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp) |
28770e05 | 314 | { |
e58d695e EB |
315 | Error *err = NULL; |
316 | ||
317 | assert(obj); | |
adfb264c | 318 | assert(v->type != VISITOR_OUTPUT || *obj); |
ebfd93b6 | 319 | trace_visit_type_any(v, name, obj); |
e58d695e EB |
320 | v->type_any(v, name, obj, &err); |
321 | if (v->type == VISITOR_INPUT) { | |
322 | assert(!err != !*obj); | |
323 | } | |
324 | error_propagate(errp, err); | |
28770e05 MA |
325 | } |
326 | ||
d2f95f4d MA |
327 | void visit_type_null(Visitor *v, const char *name, QNull **obj, |
328 | Error **errp) | |
3bc97fd5 | 329 | { |
d2f95f4d MA |
330 | trace_visit_type_null(v, name, obj); |
331 | v->type_null(v, name, obj, errp); | |
3bc97fd5 EB |
332 | } |
333 | ||
983f52d4 | 334 | static void output_type_enum(Visitor *v, const char *name, int *obj, |
f7abe0ec | 335 | const QEnumLookup *lookup, Error **errp) |
0f71a1e0 | 336 | { |
0f71a1e0 PB |
337 | int value = *obj; |
338 | char *enum_str; | |
339 | ||
f7abe0ec MAL |
340 | /* |
341 | * TODO why is this an error, not an assertion? If assertion: | |
342 | * delete, and rely on qapi_enum_lookup() | |
343 | */ | |
344 | if (value < 0 || value >= lookup->size) { | |
c6bd8c70 | 345 | error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null"); |
0f71a1e0 PB |
346 | return; |
347 | } | |
348 | ||
f7abe0ec | 349 | enum_str = (char *)qapi_enum_lookup(lookup, value); |
51e72bc1 | 350 | visit_type_str(v, name, &enum_str, errp); |
0f71a1e0 PB |
351 | } |
352 | ||
983f52d4 | 353 | static void input_type_enum(Visitor *v, const char *name, int *obj, |
f7abe0ec | 354 | const QEnumLookup *lookup, Error **errp) |
0f71a1e0 | 355 | { |
297a3646 | 356 | Error *local_err = NULL; |
113e47ae | 357 | int64_t value; |
0f71a1e0 PB |
358 | char *enum_str; |
359 | ||
51e72bc1 | 360 | visit_type_str(v, name, &enum_str, &local_err); |
297a3646 MA |
361 | if (local_err) { |
362 | error_propagate(errp, local_err); | |
0f71a1e0 PB |
363 | return; |
364 | } | |
365 | ||
f7abe0ec | 366 | value = qapi_enum_parse(lookup, enum_str, -1, NULL); |
113e47ae | 367 | if (value < 0) { |
c6bd8c70 | 368 | error_setg(errp, QERR_INVALID_PARAMETER, enum_str); |
0f71a1e0 PB |
369 | g_free(enum_str); |
370 | return; | |
371 | } | |
372 | ||
373 | g_free(enum_str); | |
374 | *obj = value; | |
375 | } | |
983f52d4 EB |
376 | |
377 | void visit_type_enum(Visitor *v, const char *name, int *obj, | |
f7abe0ec | 378 | const QEnumLookup *lookup, Error **errp) |
983f52d4 | 379 | { |
f7abe0ec | 380 | assert(obj && lookup); |
6514532f | 381 | trace_visit_type_enum(v, name, obj); |
a15fcc3c EB |
382 | switch (v->type) { |
383 | case VISITOR_INPUT: | |
f7abe0ec | 384 | input_type_enum(v, name, obj, lookup, errp); |
a15fcc3c EB |
385 | break; |
386 | case VISITOR_OUTPUT: | |
f7abe0ec | 387 | output_type_enum(v, name, obj, lookup, errp); |
a15fcc3c EB |
388 | break; |
389 | case VISITOR_CLONE: | |
390 | /* nothing further to do, scalar value was already copied by | |
391 | * g_memdup() during visit_start_*() */ | |
392 | break; | |
393 | case VISITOR_DEALLOC: | |
394 | /* nothing to deallocate for a scalar */ | |
395 | break; | |
983f52d4 EB |
396 | } |
397 | } |