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