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