xref: /qemu/qapi/qapi-visit-core.c (revision 4f7ab0cd) 
1 /*
2  * Core Definitions for QAPI Visitor Classes
3  *
4  * Copyright (C) 2012-2016 Red Hat, Inc.
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 
15 #include "qemu/osdep.h"
16 #include "qemu-common.h"
17 #include "qapi/qmp/qobject.h"
18 #include "qapi/qmp/qerror.h"
19 #include "qapi/visitor.h"
20 #include "qapi/visitor-impl.h"
21 
22 void visit_start_struct(Visitor *v, const char *name, void **obj,
23                         size_t size, Error **errp)
24 {
25     v->start_struct(v, name, obj, size, errp);
26 }
27 
28 void visit_end_struct(Visitor *v, Error **errp)
29 {
30     v->end_struct(v, errp);
31 }
32 
33 void visit_start_list(Visitor *v, const char *name, Error **errp)
34 {
35     v->start_list(v, name, errp);
36 }
37 
38 GenericList *visit_next_list(Visitor *v, GenericList **list, size_t size)
39 {
40     assert(list && size >= sizeof(GenericList));
41     return v->next_list(v, list, size);
42 }
43 
44 void visit_end_list(Visitor *v)
45 {
46     v->end_list(v);
47 }
48 
49 void visit_start_alternate(Visitor *v, const char *name,
50                            GenericAlternate **obj, size_t size,
51                            bool promote_int, Error **errp)
52 {
53     assert(obj && size >= sizeof(GenericAlternate));
54     if (v->start_alternate) {
55         v->start_alternate(v, name, obj, size, promote_int, errp);
56     }
57 }
58 
59 void visit_end_alternate(Visitor *v)
60 {
61     if (v->end_alternate) {
62         v->end_alternate(v);
63     }
64 }
65 
66 bool visit_optional(Visitor *v, const char *name, bool *present)
67 {
68     if (v->optional) {
69         v->optional(v, name, present);
70     }
71     return *present;
72 }
73 
74 void visit_type_enum(Visitor *v, const char *name, int *obj,
75                      const char *const strings[], Error **errp)
76 {
77     v->type_enum(v, name, obj, strings, errp);
78 }
79 
80 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
81 {
82     v->type_int64(v, name, obj, errp);
83 }
84 
85 static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
86                              uint64_t max, const char *type, Error **errp)
87 {
88     Error *err = NULL;
89     uint64_t value = *obj;
90 
91     v->type_uint64(v, name, &value, &err);
92     if (err) {
93         error_propagate(errp, err);
94     } else if (value > max) {
95         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
96                    name ? name : "null", type);
97     } else {
98         *obj = value;
99     }
100 }
101 
102 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
103                       Error **errp)
104 {
105     uint64_t value = *obj;
106     visit_type_uintN(v, &value, name, UINT8_MAX, "uint8_t", errp);
107     *obj = value;
108 }
109 
110 void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
111                        Error **errp)
112 {
113     uint64_t value = *obj;
114     visit_type_uintN(v, &value, name, UINT16_MAX, "uint16_t", errp);
115     *obj = value;
116 }
117 
118 void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
119                        Error **errp)
120 {
121     uint64_t value = *obj;
122     visit_type_uintN(v, &value, name, UINT32_MAX, "uint32_t", errp);
123     *obj = value;
124 }
125 
126 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
127                        Error **errp)
128 {
129     v->type_uint64(v, name, obj, errp);
130 }
131 
132 static void visit_type_intN(Visitor *v, int64_t *obj, const char *name,
133                             int64_t min, int64_t max, const char *type,
134                             Error **errp)
135 {
136     Error *err = NULL;
137     int64_t value = *obj;
138 
139     v->type_int64(v, name, &value, &err);
140     if (err) {
141         error_propagate(errp, err);
142     } else if (value < min || value > max) {
143         error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
144                    name ? name : "null", type);
145     } else {
146         *obj = value;
147     }
148 }
149 
150 void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp)
151 {
152     int64_t value = *obj;
153     visit_type_intN(v, &value, name, INT8_MIN, INT8_MAX, "int8_t", errp);
154     *obj = value;
155 }
156 
157 void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
158                       Error **errp)
159 {
160     int64_t value = *obj;
161     visit_type_intN(v, &value, name, INT16_MIN, INT16_MAX, "int16_t", errp);
162     *obj = value;
163 }
164 
165 void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
166                       Error **errp)
167 {
168     int64_t value = *obj;
169     visit_type_intN(v, &value, name, INT32_MIN, INT32_MAX, "int32_t", errp);
170     *obj = value;
171 }
172 
173 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
174                       Error **errp)
175 {
176     v->type_int64(v, name, obj, errp);
177 }
178 
179 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
180                      Error **errp)
181 {
182     if (v->type_size) {
183         v->type_size(v, name, obj, errp);
184     } else {
185         v->type_uint64(v, name, obj, errp);
186     }
187 }
188 
189 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
190 {
191     v->type_bool(v, name, obj, errp);
192 }
193 
194 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
195 {
196     v->type_str(v, name, obj, errp);
197 }
198 
199 void visit_type_number(Visitor *v, const char *name, double *obj,
200                        Error **errp)
201 {
202     v->type_number(v, name, obj, errp);
203 }
204 
205 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
206 {
207     v->type_any(v, name, obj, errp);
208 }
209 
210 void output_type_enum(Visitor *v, const char *name, int *obj,
211                       const char *const strings[], Error **errp)
212 {
213     int i = 0;
214     int value = *obj;
215     char *enum_str;
216 
217     assert(strings);
218     while (strings[i++] != NULL);
219     if (value < 0 || value >= i - 1) {
220         error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null");
221         return;
222     }
223 
224     enum_str = (char *)strings[value];
225     visit_type_str(v, name, &enum_str, errp);
226 }
227 
228 void input_type_enum(Visitor *v, const char *name, int *obj,
229                      const char *const strings[], Error **errp)
230 {
231     Error *local_err = NULL;
232     int64_t value = 0;
233     char *enum_str;
234 
235     assert(strings);
236 
237     visit_type_str(v, name, &enum_str, &local_err);
238     if (local_err) {
239         error_propagate(errp, local_err);
240         return;
241     }
242 
243     while (strings[value] != NULL) {
244         if (strcmp(strings[value], enum_str) == 0) {
245             break;
246         }
247         value++;
248     }
249 
250     if (strings[value] == NULL) {
251         error_setg(errp, QERR_INVALID_PARAMETER, enum_str);
252         g_free(enum_str);
253         return;
254     }
255 
256     g_free(enum_str);
257     *obj = value;
258 }
259