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