blob: d8612062f1e31a7b1e417f87b677d01ad06d6ceb [file] [log] [blame]
Michael Rothc40cc0a2011-07-19 14:50:33 -05001/*
2 * Input Visitor
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 Bonzini7b1b5d12012-12-17 18:19:43 +010014#include "qapi/qmp-input-visitor.h"
15#include "qapi/visitor-impl.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010016#include "qemu/queue.h"
Michael Rothc40cc0a2011-07-19 14:50:33 -050017#include "qemu-common.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010018#include "qapi/qmp/types.h"
19#include "qapi/qmp/qerror.h"
Michael Rothc40cc0a2011-07-19 14:50:33 -050020
21#define QIV_STACK_SIZE 1024
22
23typedef struct StackObject
24{
Paolo Bonzini4faaec62012-03-22 12:51:09 +010025 QObject *obj;
26 const QListEntry *entry;
Paolo Bonzinie38ac962012-03-22 12:51:10 +010027 GHashTable *h;
Michael Rothc40cc0a2011-07-19 14:50:33 -050028} StackObject;
29
30struct QmpInputVisitor
31{
32 Visitor visitor;
Michael Rothc40cc0a2011-07-19 14:50:33 -050033 StackObject stack[QIV_STACK_SIZE];
34 int nb_stack;
Paolo Bonzinie38ac962012-03-22 12:51:10 +010035 bool strict;
Michael Rothc40cc0a2011-07-19 14:50:33 -050036};
37
38static QmpInputVisitor *to_qiv(Visitor *v)
39{
40 return container_of(v, QmpInputVisitor, visitor);
41}
42
Paolo Bonzini4faaec62012-03-22 12:51:09 +010043static QObject *qmp_input_get_object(QmpInputVisitor *qiv,
Kevin Wolfe8316d72013-07-08 11:33:07 +020044 const char *name,
45 bool consume)
Michael Rothc40cc0a2011-07-19 14:50:33 -050046{
Paolo Bonzini4faaec62012-03-22 12:51:09 +010047 QObject *qobj = qiv->stack[qiv->nb_stack - 1].obj;
Michael Rothc40cc0a2011-07-19 14:50:33 -050048
Paolo Bonzini47c6d3e2011-12-18 17:05:04 +010049 if (qobj) {
50 if (name && qobject_type(qobj) == QTYPE_QDICT) {
Kevin Wolfe8316d72013-07-08 11:33:07 +020051 if (qiv->stack[qiv->nb_stack - 1].h && consume) {
Paolo Bonzinie38ac962012-03-22 12:51:10 +010052 g_hash_table_remove(qiv->stack[qiv->nb_stack - 1].h, name);
53 }
Paolo Bonzini47c6d3e2011-12-18 17:05:04 +010054 return qdict_get(qobject_to_qdict(qobj), name);
Paolo Bonzini4faaec62012-03-22 12:51:09 +010055 } else if (qiv->stack[qiv->nb_stack - 1].entry) {
Paolo Bonzini47c6d3e2011-12-18 17:05:04 +010056 return qlist_entry_obj(qiv->stack[qiv->nb_stack - 1].entry);
57 }
Michael Rothc40cc0a2011-07-19 14:50:33 -050058 }
59
60 return qobj;
61}
62
Paolo Bonzinie38ac962012-03-22 12:51:10 +010063static void qdict_add_key(const char *key, QObject *obj, void *opaque)
64{
65 GHashTable *h = opaque;
66 g_hash_table_insert(h, (gpointer) key, NULL);
67}
68
Paolo Bonzini4faaec62012-03-22 12:51:09 +010069static void qmp_input_push(QmpInputVisitor *qiv, QObject *obj, Error **errp)
Michael Rothc40cc0a2011-07-19 14:50:33 -050070{
Paolo Bonzinie38ac962012-03-22 12:51:10 +010071 GHashTable *h;
Michael Rothc40cc0a2011-07-19 14:50:33 -050072
73 if (qiv->nb_stack >= QIV_STACK_SIZE) {
Cole Robinsonf231b882014-03-21 19:42:26 -040074 error_setg(errp, "An internal buffer overran");
Michael Rothc40cc0a2011-07-19 14:50:33 -050075 return;
76 }
Paolo Bonzinie38ac962012-03-22 12:51:10 +010077
78 qiv->stack[qiv->nb_stack].obj = obj;
79 qiv->stack[qiv->nb_stack].entry = NULL;
80 qiv->stack[qiv->nb_stack].h = NULL;
81
82 if (qiv->strict && qobject_type(obj) == QTYPE_QDICT) {
83 h = g_hash_table_new(g_str_hash, g_str_equal);
84 qdict_iter(qobject_to_qdict(obj), qdict_add_key, h);
85 qiv->stack[qiv->nb_stack].h = h;
86 }
87
88 qiv->nb_stack++;
Michael Rothc40cc0a2011-07-19 14:50:33 -050089}
90
NODA, Kai57a33d82012-04-21 22:41:27 +090091/** Only for qmp_input_pop. */
92static gboolean always_true(gpointer key, gpointer val, gpointer user_pkey)
93{
94 *(const char **)user_pkey = (const char *)key;
95 return TRUE;
96}
97
Michael Rothc40cc0a2011-07-19 14:50:33 -050098static void qmp_input_pop(QmpInputVisitor *qiv, Error **errp)
99{
NODA, Kai57a33d82012-04-21 22:41:27 +0900100 assert(qiv->nb_stack > 0);
Paolo Bonzinie38ac962012-03-22 12:51:10 +0100101
NODA, Kai57a33d82012-04-21 22:41:27 +0900102 if (qiv->strict) {
103 GHashTable * const top_ht = qiv->stack[qiv->nb_stack - 1].h;
104 if (top_ht) {
105 if (g_hash_table_size(top_ht)) {
106 const char *key;
107 g_hash_table_find(top_ht, always_true, &key);
108 error_set(errp, QERR_QMP_EXTRA_MEMBER, key);
109 }
110 g_hash_table_unref(top_ht);
Paolo Bonzinie38ac962012-03-22 12:51:10 +0100111 }
Paolo Bonzinie38ac962012-03-22 12:51:10 +0100112 }
113
Michael Rothc40cc0a2011-07-19 14:50:33 -0500114 qiv->nb_stack--;
Michael Rothc40cc0a2011-07-19 14:50:33 -0500115}
116
117static void qmp_input_start_struct(Visitor *v, void **obj, const char *kind,
118 const char *name, size_t size, Error **errp)
119{
120 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200121 QObject *qobj = qmp_input_get_object(qiv, name, true);
Paolo Bonzini8b714d32012-03-22 12:51:05 +0100122 Error *err = NULL;
Michael Rothc40cc0a2011-07-19 14:50:33 -0500123
124 if (!qobj || qobject_type(qobj) != QTYPE_QDICT) {
125 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
126 "QDict");
127 return;
128 }
129
Paolo Bonzini8b714d32012-03-22 12:51:05 +0100130 qmp_input_push(qiv, qobj, &err);
131 if (err) {
132 error_propagate(errp, err);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500133 return;
134 }
135
136 if (obj) {
Anthony Liguori7267c092011-08-20 22:09:37 -0500137 *obj = g_malloc0(size);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500138 }
139}
140
141static void qmp_input_end_struct(Visitor *v, Error **errp)
142{
143 QmpInputVisitor *qiv = to_qiv(v);
144
145 qmp_input_pop(qiv, errp);
146}
147
Kevin Wolf761d5242013-07-03 15:52:42 +0200148static void qmp_input_start_implicit_struct(Visitor *v, void **obj,
149 size_t size, Error **errp)
150{
151 if (obj) {
152 *obj = g_malloc0(size);
153 }
154}
155
156static void qmp_input_end_implicit_struct(Visitor *v, Error **errp)
157{
158}
159
Michael Rothc40cc0a2011-07-19 14:50:33 -0500160static void qmp_input_start_list(Visitor *v, const char *name, Error **errp)
161{
162 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200163 QObject *qobj = qmp_input_get_object(qiv, name, true);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500164
165 if (!qobj || qobject_type(qobj) != QTYPE_QLIST) {
166 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
167 "list");
168 return;
169 }
170
171 qmp_input_push(qiv, qobj, errp);
172}
173
174static GenericList *qmp_input_next_list(Visitor *v, GenericList **list,
175 Error **errp)
176{
177 QmpInputVisitor *qiv = to_qiv(v);
178 GenericList *entry;
179 StackObject *so = &qiv->stack[qiv->nb_stack - 1];
Paolo Bonzini3a86a0f2012-03-22 22:38:40 +0100180 bool first;
181
182 if (so->entry == NULL) {
183 so->entry = qlist_first(qobject_to_qlist(so->obj));
184 first = true;
185 } else {
186 so->entry = qlist_next(so->entry);
187 first = false;
188 }
Michael Rothc40cc0a2011-07-19 14:50:33 -0500189
190 if (so->entry == NULL) {
191 return NULL;
192 }
193
Anthony Liguori7267c092011-08-20 22:09:37 -0500194 entry = g_malloc0(sizeof(*entry));
Paolo Bonzini3a86a0f2012-03-22 22:38:40 +0100195 if (first) {
196 *list = entry;
197 } else {
Michael Rothc40cc0a2011-07-19 14:50:33 -0500198 (*list)->next = entry;
199 }
Michael Rothc40cc0a2011-07-19 14:50:33 -0500200
201 return entry;
202}
203
204static void qmp_input_end_list(Visitor *v, Error **errp)
205{
206 QmpInputVisitor *qiv = to_qiv(v);
207
208 qmp_input_pop(qiv, errp);
209}
210
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200211static void qmp_input_get_next_type(Visitor *v, int *kind, const int *qobjects,
212 const char *name, Error **errp)
213{
214 QmpInputVisitor *qiv = to_qiv(v);
215 QObject *qobj = qmp_input_get_object(qiv, name, false);
216
217 if (!qobj) {
218 error_set(errp, QERR_MISSING_PARAMETER, name ? name : "null");
219 return;
220 }
221 *kind = qobjects[qobject_type(qobj)];
222}
223
Michael Rothc40cc0a2011-07-19 14:50:33 -0500224static void qmp_input_type_int(Visitor *v, int64_t *obj, const char *name,
225 Error **errp)
226{
227 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200228 QObject *qobj = qmp_input_get_object(qiv, name, true);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500229
230 if (!qobj || qobject_type(qobj) != QTYPE_QINT) {
231 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
232 "integer");
233 return;
234 }
235
236 *obj = qint_get_int(qobject_to_qint(qobj));
237}
238
239static void qmp_input_type_bool(Visitor *v, bool *obj, const char *name,
240 Error **errp)
241{
242 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200243 QObject *qobj = qmp_input_get_object(qiv, name, true);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500244
245 if (!qobj || qobject_type(qobj) != QTYPE_QBOOL) {
246 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
247 "boolean");
248 return;
249 }
250
251 *obj = qbool_get_int(qobject_to_qbool(qobj));
252}
253
254static void qmp_input_type_str(Visitor *v, char **obj, const char *name,
255 Error **errp)
256{
257 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200258 QObject *qobj = qmp_input_get_object(qiv, name, true);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500259
260 if (!qobj || qobject_type(qobj) != QTYPE_QSTRING) {
261 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
262 "string");
263 return;
264 }
265
Anthony Liguori7267c092011-08-20 22:09:37 -0500266 *obj = g_strdup(qstring_get_str(qobject_to_qstring(qobj)));
Michael Rothc40cc0a2011-07-19 14:50:33 -0500267}
268
269static void qmp_input_type_number(Visitor *v, double *obj, const char *name,
270 Error **errp)
271{
272 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200273 QObject *qobj = qmp_input_get_object(qiv, name, true);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500274
Michael Roth1ee51872012-05-11 12:43:24 -0500275 if (!qobj || (qobject_type(qobj) != QTYPE_QFLOAT &&
276 qobject_type(qobj) != QTYPE_QINT)) {
Michael Rothc40cc0a2011-07-19 14:50:33 -0500277 error_set(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
Michael Roth1ee51872012-05-11 12:43:24 -0500278 "number");
Michael Rothc40cc0a2011-07-19 14:50:33 -0500279 return;
280 }
281
Michael Roth1ee51872012-05-11 12:43:24 -0500282 if (qobject_type(qobj) == QTYPE_QINT) {
283 *obj = qint_get_int(qobject_to_qint(qobj));
284 } else {
285 *obj = qfloat_get_double(qobject_to_qfloat(qobj));
286 }
Michael Rothc40cc0a2011-07-19 14:50:33 -0500287}
288
Markus Armbrustere2cd0f42014-05-07 09:53:46 +0200289static void qmp_input_optional(Visitor *v, bool *present, const char *name,
290 Error **errp)
Michael Rothc40cc0a2011-07-19 14:50:33 -0500291{
292 QmpInputVisitor *qiv = to_qiv(v);
Kevin Wolfe8316d72013-07-08 11:33:07 +0200293 QObject *qobj = qmp_input_get_object(qiv, name, true);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500294
295 if (!qobj) {
296 *present = false;
297 return;
298 }
299
300 *present = true;
301}
302
Michael Rothc40cc0a2011-07-19 14:50:33 -0500303Visitor *qmp_input_get_visitor(QmpInputVisitor *v)
304{
305 return &v->visitor;
306}
307
308void qmp_input_visitor_cleanup(QmpInputVisitor *v)
309{
Paolo Bonzini4faaec62012-03-22 12:51:09 +0100310 qobject_decref(v->stack[0].obj);
Anthony Liguori7267c092011-08-20 22:09:37 -0500311 g_free(v);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500312}
313
314QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
315{
316 QmpInputVisitor *v;
317
Anthony Liguori7267c092011-08-20 22:09:37 -0500318 v = g_malloc0(sizeof(*v));
Michael Rothc40cc0a2011-07-19 14:50:33 -0500319
320 v->visitor.start_struct = qmp_input_start_struct;
321 v->visitor.end_struct = qmp_input_end_struct;
Kevin Wolf761d5242013-07-03 15:52:42 +0200322 v->visitor.start_implicit_struct = qmp_input_start_implicit_struct;
323 v->visitor.end_implicit_struct = qmp_input_end_implicit_struct;
Michael Rothc40cc0a2011-07-19 14:50:33 -0500324 v->visitor.start_list = qmp_input_start_list;
325 v->visitor.next_list = qmp_input_next_list;
326 v->visitor.end_list = qmp_input_end_list;
Paolo Bonzini0f71a1e2012-02-09 09:11:52 +0100327 v->visitor.type_enum = input_type_enum;
Michael Rothc40cc0a2011-07-19 14:50:33 -0500328 v->visitor.type_int = qmp_input_type_int;
329 v->visitor.type_bool = qmp_input_type_bool;
330 v->visitor.type_str = qmp_input_type_str;
331 v->visitor.type_number = qmp_input_type_number;
Markus Armbrustere2cd0f42014-05-07 09:53:46 +0200332 v->visitor.optional = qmp_input_optional;
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200333 v->visitor.get_next_type = qmp_input_get_next_type;
Michael Rothc40cc0a2011-07-19 14:50:33 -0500334
Paolo Bonzini4faaec62012-03-22 12:51:09 +0100335 qmp_input_push(v, obj, NULL);
336 qobject_incref(obj);
Michael Rothc40cc0a2011-07-19 14:50:33 -0500337
338 return v;
339}
Paolo Bonzinie38ac962012-03-22 12:51:10 +0100340
341QmpInputVisitor *qmp_input_visitor_new_strict(QObject *obj)
342{
343 QmpInputVisitor *v;
344
345 v = qmp_input_visitor_new(obj);
346 v->strict = true;
347
348 return v;
349}