blob: b66b93ae2b0113c8080dfddfbe9bebfb8028bda9 [file] [log] [blame]
Michael Roth2345c772011-07-19 14:50:32 -05001/*
2 * Core Definitions for QAPI Visitor Classes
3 *
4 * Copyright IBM, Corp. 2011
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
10 * See the COPYING.LIB file in the top-level directory.
11 *
12 */
13
Paolo Bonzini79ee7df2012-12-06 11:22:34 +010014#include "qemu-common.h"
Kevin Wolf69dd62d2013-07-08 16:14:21 +020015#include "qapi/qmp/qobject.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010016#include "qapi/qmp/qerror.h"
17#include "qapi/visitor.h"
18#include "qapi/visitor-impl.h"
Michael Roth2345c772011-07-19 14:50:32 -050019
Michael Roth2345c772011-07-19 14:50:32 -050020void visit_start_struct(Visitor *v, void **obj, const char *kind,
21 const char *name, size_t size, Error **errp)
22{
Markus Armbruster297a3642014-05-07 09:53:54 +020023 v->start_struct(v, obj, kind, name, size, errp);
Michael Roth2345c772011-07-19 14:50:32 -050024}
25
26void visit_end_struct(Visitor *v, Error **errp)
27{
Paolo Bonzinid1953252012-07-17 16:17:04 +020028 v->end_struct(v, errp);
Michael Roth2345c772011-07-19 14:50:32 -050029}
30
Kevin Wolf761d5242013-07-03 15:52:42 +020031void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
32 Error **errp)
33{
Markus Armbruster297a3642014-05-07 09:53:54 +020034 if (v->start_implicit_struct) {
Kevin Wolf761d5242013-07-03 15:52:42 +020035 v->start_implicit_struct(v, obj, size, errp);
36 }
37}
38
39void visit_end_implicit_struct(Visitor *v, Error **errp)
40{
Kevin Wolf761d5242013-07-03 15:52:42 +020041 if (v->end_implicit_struct) {
42 v->end_implicit_struct(v, errp);
43 }
44}
45
Michael Roth2345c772011-07-19 14:50:32 -050046void visit_start_list(Visitor *v, const char *name, Error **errp)
47{
Markus Armbruster297a3642014-05-07 09:53:54 +020048 v->start_list(v, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -050049}
50
51GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp)
52{
Markus Armbruster297a3642014-05-07 09:53:54 +020053 return v->next_list(v, list, errp);
Michael Roth2345c772011-07-19 14:50:32 -050054}
55
56void visit_end_list(Visitor *v, Error **errp)
57{
Paolo Bonzinid1953252012-07-17 16:17:04 +020058 v->end_list(v, errp);
Michael Roth2345c772011-07-19 14:50:32 -050059}
60
Michael Rothcee2ded2014-09-18 15:36:40 -050061bool visit_start_union(Visitor *v, bool data_present, Error **errp)
62{
63 if (v->start_union) {
64 return v->start_union(v, data_present, errp);
65 }
66 return true;
67}
68
69void visit_end_union(Visitor *v, bool data_present, Error **errp)
70{
71 if (v->end_union) {
72 v->end_union(v, data_present, errp);
73 }
74}
75
Markus Armbrustere2cd0f42014-05-07 09:53:46 +020076void visit_optional(Visitor *v, bool *present, const char *name,
77 Error **errp)
Michael Roth2345c772011-07-19 14:50:32 -050078{
Markus Armbruster297a3642014-05-07 09:53:54 +020079 if (v->optional) {
Markus Armbrustere2cd0f42014-05-07 09:53:46 +020080 v->optional(v, present, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -050081 }
82}
83
Kevin Wolf69dd62d2013-07-08 16:14:21 +020084void visit_get_next_type(Visitor *v, int *obj, const int *qtypes,
85 const char *name, Error **errp)
86{
Markus Armbruster297a3642014-05-07 09:53:54 +020087 if (v->get_next_type) {
Kevin Wolf69dd62d2013-07-08 16:14:21 +020088 v->get_next_type(v, obj, qtypes, name, errp);
89 }
90}
91
Michael Roth2345c772011-07-19 14:50:32 -050092void visit_type_enum(Visitor *v, int *obj, const char *strings[],
93 const char *kind, const char *name, Error **errp)
94{
Markus Armbruster297a3642014-05-07 09:53:54 +020095 v->type_enum(v, obj, strings, kind, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -050096}
97
98void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
99{
Markus Armbruster297a3642014-05-07 09:53:54 +0200100 v->type_int(v, obj, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500101}
102
Michael Roth4e27e812011-08-25 10:44:50 -0500103void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
104{
105 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200106
107 if (v->type_uint8) {
108 v->type_uint8(v, obj, name, errp);
109 } else {
110 value = *obj;
111 v->type_int(v, &value, name, errp);
112 if (value < 0 || value > UINT8_MAX) {
113 error_set(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
114 "uint8_t");
115 return;
Michael Roth4e27e812011-08-25 10:44:50 -0500116 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200117 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500118 }
119}
120
121void visit_type_uint16(Visitor *v, uint16_t *obj, const char *name, Error **errp)
122{
123 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200124
125 if (v->type_uint16) {
126 v->type_uint16(v, obj, name, errp);
127 } else {
128 value = *obj;
129 v->type_int(v, &value, name, errp);
130 if (value < 0 || value > UINT16_MAX) {
131 error_set(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
132 "uint16_t");
133 return;
Michael Roth4e27e812011-08-25 10:44:50 -0500134 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200135 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500136 }
137}
138
139void visit_type_uint32(Visitor *v, uint32_t *obj, const char *name, Error **errp)
140{
141 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200142
143 if (v->type_uint32) {
144 v->type_uint32(v, obj, name, errp);
145 } else {
146 value = *obj;
147 v->type_int(v, &value, name, errp);
148 if (value < 0 || value > UINT32_MAX) {
149 error_set(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
150 "uint32_t");
151 return;
Michael Roth4e27e812011-08-25 10:44:50 -0500152 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200153 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500154 }
155}
156
157void visit_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp)
158{
159 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200160
161 if (v->type_uint64) {
162 v->type_uint64(v, obj, name, errp);
163 } else {
164 value = *obj;
165 v->type_int(v, &value, name, errp);
166 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500167 }
168}
169
170void visit_type_int8(Visitor *v, int8_t *obj, const char *name, Error **errp)
171{
172 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200173
174 if (v->type_int8) {
175 v->type_int8(v, obj, name, errp);
176 } else {
177 value = *obj;
178 v->type_int(v, &value, name, errp);
179 if (value < INT8_MIN || value > INT8_MAX) {
180 error_set(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
181 "int8_t");
182 return;
Michael Roth4e27e812011-08-25 10:44:50 -0500183 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200184 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500185 }
186}
187
188void visit_type_int16(Visitor *v, int16_t *obj, const char *name, Error **errp)
189{
190 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200191
192 if (v->type_int16) {
193 v->type_int16(v, obj, name, errp);
194 } else {
195 value = *obj;
196 v->type_int(v, &value, name, errp);
197 if (value < INT16_MIN || value > INT16_MAX) {
198 error_set(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
199 "int16_t");
200 return;
Michael Roth4e27e812011-08-25 10:44:50 -0500201 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200202 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500203 }
204}
205
206void visit_type_int32(Visitor *v, int32_t *obj, const char *name, Error **errp)
207{
208 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200209
210 if (v->type_int32) {
211 v->type_int32(v, obj, name, errp);
212 } else {
213 value = *obj;
214 v->type_int(v, &value, name, errp);
215 if (value < INT32_MIN || value > INT32_MAX) {
216 error_set(errp, QERR_INVALID_PARAMETER_VALUE, name ? name : "null",
217 "int32_t");
218 return;
Michael Roth4e27e812011-08-25 10:44:50 -0500219 }
Markus Armbruster297a3642014-05-07 09:53:54 +0200220 *obj = value;
Michael Roth4e27e812011-08-25 10:44:50 -0500221 }
222}
223
224void visit_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp)
225{
Markus Armbruster297a3642014-05-07 09:53:54 +0200226 if (v->type_int64) {
227 v->type_int64(v, obj, name, errp);
228 } else {
229 v->type_int(v, obj, name, errp);
Michael Roth4e27e812011-08-25 10:44:50 -0500230 }
231}
232
Laszlo Ersek092705d2012-07-17 16:17:07 +0200233void visit_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
234{
Vasilis Liaskovitisb8877962013-07-29 16:47:55 +0200235 int64_t value;
Markus Armbruster297a3642014-05-07 09:53:54 +0200236
237 if (v->type_size) {
238 v->type_size(v, obj, name, errp);
239 } else if (v->type_uint64) {
240 v->type_uint64(v, obj, name, errp);
241 } else {
242 value = *obj;
243 v->type_int(v, &value, name, errp);
244 *obj = value;
Laszlo Ersek092705d2012-07-17 16:17:07 +0200245 }
246}
247
Michael Roth2345c772011-07-19 14:50:32 -0500248void visit_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
249{
Markus Armbruster297a3642014-05-07 09:53:54 +0200250 v->type_bool(v, obj, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500251}
252
253void visit_type_str(Visitor *v, char **obj, const char *name, Error **errp)
254{
Markus Armbruster297a3642014-05-07 09:53:54 +0200255 v->type_str(v, obj, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500256}
257
258void visit_type_number(Visitor *v, double *obj, const char *name, Error **errp)
259{
Markus Armbruster297a3642014-05-07 09:53:54 +0200260 v->type_number(v, obj, name, errp);
Michael Roth2345c772011-07-19 14:50:32 -0500261}
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100262
263void output_type_enum(Visitor *v, int *obj, const char *strings[],
264 const char *kind, const char *name,
265 Error **errp)
266{
267 int i = 0;
268 int value = *obj;
269 char *enum_str;
270
271 assert(strings);
272 while (strings[i++] != NULL);
273 if (value < 0 || value >= i - 1) {
274 error_set(errp, QERR_INVALID_PARAMETER, name ? name : "null");
275 return;
276 }
277
278 enum_str = (char *)strings[value];
279 visit_type_str(v, &enum_str, name, errp);
280}
281
282void input_type_enum(Visitor *v, int *obj, const char *strings[],
283 const char *kind, const char *name,
284 Error **errp)
285{
Markus Armbruster297a3642014-05-07 09:53:54 +0200286 Error *local_err = NULL;
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100287 int64_t value = 0;
288 char *enum_str;
289
290 assert(strings);
291
Markus Armbruster297a3642014-05-07 09:53:54 +0200292 visit_type_str(v, &enum_str, name, &local_err);
293 if (local_err) {
294 error_propagate(errp, local_err);
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100295 return;
296 }
297
298 while (strings[value] != NULL) {
299 if (strcmp(strings[value], enum_str) == 0) {
300 break;
301 }
302 value++;
303 }
304
305 if (strings[value] == NULL) {
Luiz Capitulino94c3db82012-06-29 14:25:01 -0300306 error_set(errp, QERR_INVALID_PARAMETER, enum_str);
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100307 g_free(enum_str);
308 return;
309 }
310
311 g_free(enum_str);
312 *obj = value;
313}