]>
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 <aliguori@us.ibm.com> | |
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" |
69dd62df | 18 | #include "qapi/qmp/qobject.h" |
7b1b5d19 PB |
19 | #include "qapi/qmp/qerror.h" |
20 | #include "qapi/visitor.h" | |
21 | #include "qapi/visitor-impl.h" | |
2345c77c | 22 | |
2c0ef9f4 EB |
23 | void visit_free(Visitor *v) |
24 | { | |
25 | if (v) { | |
26 | v->free(v); | |
27 | } | |
28 | } | |
29 | ||
51e72bc1 | 30 | void visit_start_struct(Visitor *v, const char *name, void **obj, |
337283df | 31 | size_t size, Error **errp) |
2345c77c | 32 | { |
e58d695e EB |
33 | Error *err = NULL; |
34 | ||
adfb264c EB |
35 | if (obj) { |
36 | assert(size); | |
37 | assert(v->type != VISITOR_OUTPUT || *obj); | |
38 | } | |
e58d695e EB |
39 | v->start_struct(v, name, obj, size, &err); |
40 | if (obj && v->type == VISITOR_INPUT) { | |
41 | assert(!err != !*obj); | |
42 | } | |
43 | error_propagate(errp, err); | |
2345c77c MR |
44 | } |
45 | ||
15c2f669 | 46 | void visit_check_struct(Visitor *v, Error **errp) |
2345c77c | 47 | { |
15c2f669 EB |
48 | if (v->check_struct) { |
49 | v->check_struct(v, errp); | |
50 | } | |
51 | } | |
52 | ||
1158bb2a | 53 | void visit_end_struct(Visitor *v, void **obj) |
15c2f669 | 54 | { |
1158bb2a | 55 | v->end_struct(v, obj); |
2345c77c MR |
56 | } |
57 | ||
d9f62dde EB |
58 | void visit_start_list(Visitor *v, const char *name, GenericList **list, |
59 | size_t size, Error **errp) | |
2345c77c | 60 | { |
d9f62dde EB |
61 | Error *err = NULL; |
62 | ||
63 | assert(!list || size >= sizeof(GenericList)); | |
64 | v->start_list(v, name, list, size, &err); | |
65 | if (list && v->type == VISITOR_INPUT) { | |
66 | assert(!(err && *list)); | |
67 | } | |
68 | error_propagate(errp, err); | |
2345c77c MR |
69 | } |
70 | ||
d9f62dde | 71 | GenericList *visit_next_list(Visitor *v, GenericList *tail, size_t size) |
2345c77c | 72 | { |
d9f62dde EB |
73 | assert(tail && size >= sizeof(GenericList)); |
74 | return v->next_list(v, tail, size); | |
2345c77c MR |
75 | } |
76 | ||
1158bb2a | 77 | void visit_end_list(Visitor *v, void **obj) |
2345c77c | 78 | { |
1158bb2a | 79 | v->end_list(v, obj); |
2345c77c MR |
80 | } |
81 | ||
dbf11922 EB |
82 | void visit_start_alternate(Visitor *v, const char *name, |
83 | GenericAlternate **obj, size_t size, | |
84 | bool promote_int, Error **errp) | |
2345c77c | 85 | { |
e58d695e EB |
86 | Error *err = NULL; |
87 | ||
dbf11922 | 88 | assert(obj && size >= sizeof(GenericAlternate)); |
adfb264c | 89 | assert(v->type != VISITOR_OUTPUT || *obj); |
dbf11922 | 90 | if (v->start_alternate) { |
e58d695e EB |
91 | v->start_alternate(v, name, obj, size, promote_int, &err); |
92 | } | |
93 | if (v->type == VISITOR_INPUT) { | |
94 | assert(v->start_alternate && !err != !*obj); | |
dbf11922 | 95 | } |
e58d695e | 96 | error_propagate(errp, err); |
dbf11922 EB |
97 | } |
98 | ||
1158bb2a | 99 | void visit_end_alternate(Visitor *v, void **obj) |
dbf11922 EB |
100 | { |
101 | if (v->end_alternate) { | |
1158bb2a | 102 | v->end_alternate(v, obj); |
2345c77c MR |
103 | } |
104 | } | |
105 | ||
dbf11922 | 106 | bool visit_optional(Visitor *v, const char *name, bool *present) |
69dd62df | 107 | { |
dbf11922 EB |
108 | if (v->optional) { |
109 | v->optional(v, name, present); | |
69dd62df | 110 | } |
dbf11922 | 111 | return *present; |
69dd62df KW |
112 | } |
113 | ||
68ab47e4 EB |
114 | bool visit_is_input(Visitor *v) |
115 | { | |
116 | return v->type == VISITOR_INPUT; | |
117 | } | |
118 | ||
51e72bc1 | 119 | void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp) |
2345c77c | 120 | { |
adfb264c | 121 | assert(obj); |
0b2a0d6b | 122 | v->type_int64(v, name, obj, errp); |
2345c77c MR |
123 | } |
124 | ||
04e070d2 EB |
125 | static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name, |
126 | uint64_t max, const char *type, Error **errp) | |
127 | { | |
128 | Error *err = NULL; | |
129 | uint64_t value = *obj; | |
130 | ||
0b2a0d6b | 131 | v->type_uint64(v, name, &value, &err); |
04e070d2 EB |
132 | if (err) { |
133 | error_propagate(errp, err); | |
134 | } else if (value > max) { | |
135 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, | |
136 | name ? name : "null", type); | |
297a3646 | 137 | } else { |
297a3646 | 138 | *obj = value; |
4e27e819 MR |
139 | } |
140 | } | |
141 | ||
51e72bc1 EB |
142 | void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj, |
143 | Error **errp) | |
4e27e819 | 144 | { |
04e070d2 EB |
145 | uint64_t value = *obj; |
146 | visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp); | |
147 | *obj = value; | |
4e27e819 MR |
148 | } |
149 | ||
51e72bc1 | 150 | void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj, |
04e070d2 | 151 | Error **errp) |
4e27e819 | 152 | { |
04e070d2 EB |
153 | uint64_t value = *obj; |
154 | visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp); | |
155 | *obj = value; | |
156 | } | |
297a3646 | 157 | |
51e72bc1 | 158 | void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj, |
04e070d2 EB |
159 | Error **errp) |
160 | { | |
161 | uint64_t value = *obj; | |
162 | visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp); | |
163 | *obj = value; | |
4e27e819 MR |
164 | } |
165 | ||
51e72bc1 | 166 | void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj, |
04e070d2 | 167 | Error **errp) |
4e27e819 | 168 | { |
adfb264c | 169 | assert(obj); |
0b2a0d6b | 170 | v->type_uint64(v, name, obj, errp); |
4e27e819 MR |
171 | } |
172 | ||
04e070d2 EB |
173 | static void visit_type_intN(Visitor *v, int64_t *obj, const char *name, |
174 | int64_t min, int64_t max, const char *type, | |
175 | Error **errp) | |
4e27e819 | 176 | { |
04e070d2 EB |
177 | Error *err = NULL; |
178 | int64_t value = *obj; | |
297a3646 | 179 | |
0b2a0d6b | 180 | v->type_int64(v, name, &value, &err); |
04e070d2 EB |
181 | if (err) { |
182 | error_propagate(errp, err); | |
183 | } else if (value < min || value > max) { | |
184 | error_setg(errp, QERR_INVALID_PARAMETER_VALUE, | |
185 | name ? name : "null", type); | |
297a3646 | 186 | } else { |
297a3646 | 187 | *obj = value; |
4e27e819 MR |
188 | } |
189 | } | |
190 | ||
51e72bc1 | 191 | void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp) |
4e27e819 | 192 | { |
04e070d2 EB |
193 | int64_t value = *obj; |
194 | visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp); | |
195 | *obj = value; | |
196 | } | |
297a3646 | 197 | |
51e72bc1 EB |
198 | void visit_type_int16(Visitor *v, const char *name, int16_t *obj, |
199 | Error **errp) | |
04e070d2 EB |
200 | { |
201 | int64_t value = *obj; | |
202 | visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp); | |
203 | *obj = value; | |
4e27e819 MR |
204 | } |
205 | ||
51e72bc1 EB |
206 | void visit_type_int32(Visitor *v, const char *name, int32_t *obj, |
207 | Error **errp) | |
4e27e819 | 208 | { |
04e070d2 EB |
209 | int64_t value = *obj; |
210 | visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp); | |
211 | *obj = value; | |
4e27e819 MR |
212 | } |
213 | ||
51e72bc1 EB |
214 | void visit_type_int64(Visitor *v, const char *name, int64_t *obj, |
215 | Error **errp) | |
4e27e819 | 216 | { |
adfb264c | 217 | assert(obj); |
0b2a0d6b | 218 | v->type_int64(v, name, obj, errp); |
4e27e819 MR |
219 | } |
220 | ||
51e72bc1 EB |
221 | void visit_type_size(Visitor *v, const char *name, uint64_t *obj, |
222 | Error **errp) | |
092705d4 | 223 | { |
adfb264c | 224 | assert(obj); |
297a3646 | 225 | if (v->type_size) { |
0b2a0d6b | 226 | v->type_size(v, name, obj, errp); |
297a3646 | 227 | } else { |
0b2a0d6b | 228 | v->type_uint64(v, name, obj, errp); |
092705d4 LE |
229 | } |
230 | } | |
231 | ||
51e72bc1 | 232 | void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp) |
2345c77c | 233 | { |
adfb264c | 234 | assert(obj); |
0b2a0d6b | 235 | v->type_bool(v, name, obj, errp); |
2345c77c MR |
236 | } |
237 | ||
51e72bc1 | 238 | void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp) |
2345c77c | 239 | { |
e58d695e EB |
240 | Error *err = NULL; |
241 | ||
242 | assert(obj); | |
adfb264c EB |
243 | /* TODO: Fix callers to not pass NULL when they mean "", so that we |
244 | * can enable: | |
245 | assert(v->type != VISITOR_OUTPUT || *obj); | |
246 | */ | |
e58d695e EB |
247 | v->type_str(v, name, obj, &err); |
248 | if (v->type == VISITOR_INPUT) { | |
249 | assert(!err != !*obj); | |
250 | } | |
251 | error_propagate(errp, err); | |
2345c77c MR |
252 | } |
253 | ||
51e72bc1 EB |
254 | void visit_type_number(Visitor *v, const char *name, double *obj, |
255 | Error **errp) | |
2345c77c | 256 | { |
adfb264c | 257 | assert(obj); |
0b2a0d6b | 258 | v->type_number(v, name, obj, errp); |
2345c77c | 259 | } |
0f71a1e0 | 260 | |
51e72bc1 | 261 | void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp) |
28770e05 | 262 | { |
e58d695e EB |
263 | Error *err = NULL; |
264 | ||
265 | assert(obj); | |
adfb264c | 266 | assert(v->type != VISITOR_OUTPUT || *obj); |
e58d695e EB |
267 | v->type_any(v, name, obj, &err); |
268 | if (v->type == VISITOR_INPUT) { | |
269 | assert(!err != !*obj); | |
270 | } | |
271 | error_propagate(errp, err); | |
28770e05 MA |
272 | } |
273 | ||
3bc97fd5 EB |
274 | void visit_type_null(Visitor *v, const char *name, Error **errp) |
275 | { | |
276 | v->type_null(v, name, errp); | |
277 | } | |
278 | ||
983f52d4 EB |
279 | static void output_type_enum(Visitor *v, const char *name, int *obj, |
280 | const char *const strings[], Error **errp) | |
0f71a1e0 PB |
281 | { |
282 | int i = 0; | |
283 | int value = *obj; | |
284 | char *enum_str; | |
285 | ||
0f71a1e0 PB |
286 | while (strings[i++] != NULL); |
287 | if (value < 0 || value >= i - 1) { | |
c6bd8c70 | 288 | error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null"); |
0f71a1e0 PB |
289 | return; |
290 | } | |
291 | ||
292 | enum_str = (char *)strings[value]; | |
51e72bc1 | 293 | visit_type_str(v, name, &enum_str, errp); |
0f71a1e0 PB |
294 | } |
295 | ||
983f52d4 EB |
296 | static void input_type_enum(Visitor *v, const char *name, int *obj, |
297 | const char *const strings[], Error **errp) | |
0f71a1e0 | 298 | { |
297a3646 | 299 | Error *local_err = NULL; |
0f71a1e0 PB |
300 | int64_t value = 0; |
301 | char *enum_str; | |
302 | ||
51e72bc1 | 303 | visit_type_str(v, name, &enum_str, &local_err); |
297a3646 MA |
304 | if (local_err) { |
305 | error_propagate(errp, local_err); | |
0f71a1e0 PB |
306 | return; |
307 | } | |
308 | ||
309 | while (strings[value] != NULL) { | |
310 | if (strcmp(strings[value], enum_str) == 0) { | |
311 | break; | |
312 | } | |
313 | value++; | |
314 | } | |
315 | ||
316 | if (strings[value] == NULL) { | |
c6bd8c70 | 317 | error_setg(errp, QERR_INVALID_PARAMETER, enum_str); |
0f71a1e0 PB |
318 | g_free(enum_str); |
319 | return; | |
320 | } | |
321 | ||
322 | g_free(enum_str); | |
323 | *obj = value; | |
324 | } | |
983f52d4 EB |
325 | |
326 | void visit_type_enum(Visitor *v, const char *name, int *obj, | |
327 | const char *const strings[], Error **errp) | |
328 | { | |
adfb264c | 329 | assert(obj && strings); |
983f52d4 EB |
330 | if (v->type == VISITOR_INPUT) { |
331 | input_type_enum(v, name, obj, strings, errp); | |
332 | } else if (v->type == VISITOR_OUTPUT) { | |
333 | output_type_enum(v, name, obj, strings, errp); | |
334 | } | |
335 | } |