]>
Commit | Line | Data |
---|---|---|
e4e6aa14 MR |
1 | /* |
2 | * Core Definitions for QAPI/QMP Command Registry | |
3 | * | |
08f9541d | 4 | * Copyright (C) 2012-2016 Red Hat, Inc. |
e4e6aa14 MR |
5 | * Copyright IBM, Corp. 2011 |
6 | * | |
7 | * Authors: | |
8 | * Anthony Liguori <[email protected]> | |
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" |
91fa93e5 | 16 | #include "qapi/compat-policy.h" |
b3db211f | 17 | #include "qapi/qobject-output-visitor.h" |
7b1b5d19 | 18 | #include "qapi/visitor-impl.h" |
1de7afc9 | 19 | #include "qemu/queue.h" |
6b673957 | 20 | #include "qapi/qmp/qbool.h" |
452fcdbc | 21 | #include "qapi/qmp/qdict.h" |
47e6b297 | 22 | #include "qapi/qmp/qlist.h" |
15280c36 MA |
23 | #include "qapi/qmp/qnull.h" |
24 | #include "qapi/qmp/qnum.h" | |
6b673957 | 25 | #include "qapi/qmp/qstring.h" |
e4e6aa14 | 26 | |
7d5e199a | 27 | typedef struct QStackEntry { |
e4e6aa14 | 28 | QObject *value; |
1158bb2a | 29 | void *qapi; /* sanity check that caller uses same pointer */ |
fc76ae8b | 30 | QSLIST_ENTRY(QStackEntry) node; |
e4e6aa14 MR |
31 | } QStackEntry; |
32 | ||
7d5e199a | 33 | struct QObjectOutputVisitor { |
e4e6aa14 | 34 | Visitor visitor; |
91fa93e5 MA |
35 | CompatPolicyOutput deprecated_policy; |
36 | ||
fc76ae8b | 37 | QSLIST_HEAD(, QStackEntry) stack; /* Stack of unfinished containers */ |
455ba08a | 38 | QObject *root; /* Root of the output visit */ |
3b098d56 | 39 | QObject **result; /* User's storage location for result */ |
e4e6aa14 MR |
40 | }; |
41 | ||
7d5e199a DB |
42 | #define qobject_output_add(qov, name, value) \ |
43 | qobject_output_add_obj(qov, name, QOBJECT(value)) | |
44 | #define qobject_output_push(qov, value, qapi) \ | |
45 | qobject_output_push_obj(qov, QOBJECT(value), qapi) | |
e4e6aa14 | 46 | |
7d5e199a | 47 | static QObjectOutputVisitor *to_qov(Visitor *v) |
e4e6aa14 | 48 | { |
7d5e199a | 49 | return container_of(v, QObjectOutputVisitor, visitor); |
e4e6aa14 MR |
50 | } |
51 | ||
a8615640 | 52 | /* Push @value onto the stack of current QObjects being built */ |
7d5e199a DB |
53 | static void qobject_output_push_obj(QObjectOutputVisitor *qov, QObject *value, |
54 | void *qapi) | |
e4e6aa14 | 55 | { |
7267c094 | 56 | QStackEntry *e = g_malloc0(sizeof(*e)); |
e4e6aa14 | 57 | |
455ba08a | 58 | assert(qov->root); |
a8615640 | 59 | assert(value); |
e4e6aa14 | 60 | e->value = value; |
1158bb2a | 61 | e->qapi = qapi; |
fc76ae8b | 62 | QSLIST_INSERT_HEAD(&qov->stack, e, node); |
e4e6aa14 MR |
63 | } |
64 | ||
a8615640 | 65 | /* Pop a value off the stack of QObjects being built, and return it. */ |
7d5e199a | 66 | static QObject *qobject_output_pop(QObjectOutputVisitor *qov, void *qapi) |
e4e6aa14 | 67 | { |
fc76ae8b | 68 | QStackEntry *e = QSLIST_FIRST(&qov->stack); |
e4e6aa14 | 69 | QObject *value; |
a8615640 EB |
70 | |
71 | assert(e); | |
1158bb2a | 72 | assert(e->qapi == qapi); |
fc76ae8b | 73 | QSLIST_REMOVE_HEAD(&qov->stack, node); |
e4e6aa14 | 74 | value = e->value; |
a8615640 | 75 | assert(value); |
7267c094 | 76 | g_free(e); |
e4e6aa14 MR |
77 | return value; |
78 | } | |
79 | ||
a8615640 EB |
80 | /* Add @value to the current QObject being built. |
81 | * If the stack is visiting a dictionary or list, @value is now owned | |
82 | * by that container. Otherwise, @value is now the root. */ | |
7d5e199a DB |
83 | static void qobject_output_add_obj(QObjectOutputVisitor *qov, const char *name, |
84 | QObject *value) | |
e4e6aa14 | 85 | { |
fc76ae8b | 86 | QStackEntry *e = QSLIST_FIRST(&qov->stack); |
455ba08a | 87 | QObject *cur = e ? e->value : NULL; |
e4e6aa14 | 88 | |
455ba08a | 89 | if (!cur) { |
56a6f02b EB |
90 | /* Don't allow reuse of visitor on more than one root */ |
91 | assert(!qov->root); | |
455ba08a EB |
92 | qov->root = value; |
93 | } else { | |
94 | switch (qobject_type(cur)) { | |
95 | case QTYPE_QDICT: | |
96 | assert(name); | |
7dc847eb | 97 | qdict_put_obj(qobject_to(QDict, cur), name, value); |
455ba08a EB |
98 | break; |
99 | case QTYPE_QLIST: | |
56a6f02b | 100 | assert(!name); |
7dc847eb | 101 | qlist_append_obj(qobject_to(QList, cur), value); |
455ba08a EB |
102 | break; |
103 | default: | |
104 | g_assert_not_reached(); | |
105 | } | |
e4e6aa14 MR |
106 | } |
107 | } | |
108 | ||
012d4c96 | 109 | static bool qobject_output_start_struct(Visitor *v, const char *name, |
7d5e199a | 110 | void **obj, size_t unused, Error **errp) |
e4e6aa14 | 111 | { |
7d5e199a | 112 | QObjectOutputVisitor *qov = to_qov(v); |
e4e6aa14 MR |
113 | QDict *dict = qdict_new(); |
114 | ||
7d5e199a DB |
115 | qobject_output_add(qov, name, dict); |
116 | qobject_output_push(qov, dict, obj); | |
012d4c96 | 117 | return true; |
e4e6aa14 MR |
118 | } |
119 | ||
7d5e199a | 120 | static void qobject_output_end_struct(Visitor *v, void **obj) |
e4e6aa14 | 121 | { |
7d5e199a DB |
122 | QObjectOutputVisitor *qov = to_qov(v); |
123 | QObject *value = qobject_output_pop(qov, obj); | |
56a6f02b | 124 | assert(qobject_type(value) == QTYPE_QDICT); |
e4e6aa14 MR |
125 | } |
126 | ||
012d4c96 | 127 | static bool qobject_output_start_list(Visitor *v, const char *name, |
7d5e199a DB |
128 | GenericList **listp, size_t size, |
129 | Error **errp) | |
e4e6aa14 | 130 | { |
7d5e199a | 131 | QObjectOutputVisitor *qov = to_qov(v); |
e4e6aa14 MR |
132 | QList *list = qlist_new(); |
133 | ||
7d5e199a DB |
134 | qobject_output_add(qov, name, list); |
135 | qobject_output_push(qov, list, listp); | |
012d4c96 | 136 | return true; |
e4e6aa14 MR |
137 | } |
138 | ||
7d5e199a DB |
139 | static GenericList *qobject_output_next_list(Visitor *v, GenericList *tail, |
140 | size_t size) | |
e4e6aa14 | 141 | { |
d9f62dde | 142 | return tail->next; |
e4e6aa14 MR |
143 | } |
144 | ||
7d5e199a | 145 | static void qobject_output_end_list(Visitor *v, void **obj) |
e4e6aa14 | 146 | { |
7d5e199a DB |
147 | QObjectOutputVisitor *qov = to_qov(v); |
148 | QObject *value = qobject_output_pop(qov, obj); | |
56a6f02b | 149 | assert(qobject_type(value) == QTYPE_QLIST); |
e4e6aa14 MR |
150 | } |
151 | ||
012d4c96 | 152 | static bool qobject_output_type_int64(Visitor *v, const char *name, |
7d5e199a | 153 | int64_t *obj, Error **errp) |
e4e6aa14 | 154 | { |
7d5e199a | 155 | QObjectOutputVisitor *qov = to_qov(v); |
01b2ffce | 156 | qobject_output_add(qov, name, qnum_from_int(*obj)); |
012d4c96 | 157 | return true; |
e4e6aa14 MR |
158 | } |
159 | ||
012d4c96 | 160 | static bool qobject_output_type_uint64(Visitor *v, const char *name, |
7d5e199a | 161 | uint64_t *obj, Error **errp) |
f755dea7 | 162 | { |
7d5e199a | 163 | QObjectOutputVisitor *qov = to_qov(v); |
5923f85f | 164 | qobject_output_add(qov, name, qnum_from_uint(*obj)); |
012d4c96 | 165 | return true; |
f755dea7 EB |
166 | } |
167 | ||
012d4c96 | 168 | static bool qobject_output_type_bool(Visitor *v, const char *name, bool *obj, |
7d5e199a | 169 | Error **errp) |
e4e6aa14 | 170 | { |
7d5e199a DB |
171 | QObjectOutputVisitor *qov = to_qov(v); |
172 | qobject_output_add(qov, name, qbool_from_bool(*obj)); | |
012d4c96 | 173 | return true; |
e4e6aa14 MR |
174 | } |
175 | ||
012d4c96 | 176 | static bool qobject_output_type_str(Visitor *v, const char *name, char **obj, |
7d5e199a | 177 | Error **errp) |
e4e6aa14 | 178 | { |
7d5e199a | 179 | QObjectOutputVisitor *qov = to_qov(v); |
e4e6aa14 | 180 | if (*obj) { |
7d5e199a | 181 | qobject_output_add(qov, name, qstring_from_str(*obj)); |
e4e6aa14 | 182 | } else { |
7d5e199a | 183 | qobject_output_add(qov, name, qstring_from_str("")); |
e4e6aa14 | 184 | } |
012d4c96 | 185 | return true; |
e4e6aa14 MR |
186 | } |
187 | ||
012d4c96 | 188 | static bool qobject_output_type_number(Visitor *v, const char *name, |
7d5e199a | 189 | double *obj, Error **errp) |
e4e6aa14 | 190 | { |
7d5e199a | 191 | QObjectOutputVisitor *qov = to_qov(v); |
01b2ffce | 192 | qobject_output_add(qov, name, qnum_from_double(*obj)); |
012d4c96 | 193 | return true; |
e4e6aa14 MR |
194 | } |
195 | ||
012d4c96 | 196 | static bool qobject_output_type_any(Visitor *v, const char *name, |
7d5e199a | 197 | QObject **obj, Error **errp) |
28770e05 | 198 | { |
7d5e199a | 199 | QObjectOutputVisitor *qov = to_qov(v); |
f5a74a5a MAL |
200 | |
201 | qobject_output_add_obj(qov, name, qobject_ref(*obj)); | |
012d4c96 | 202 | return true; |
28770e05 MA |
203 | } |
204 | ||
012d4c96 | 205 | static bool qobject_output_type_null(Visitor *v, const char *name, |
d2f95f4d | 206 | QNull **obj, Error **errp) |
3bc97fd5 | 207 | { |
7d5e199a | 208 | QObjectOutputVisitor *qov = to_qov(v); |
006ca09f | 209 | qobject_output_add(qov, name, qnull()); |
012d4c96 | 210 | return true; |
3bc97fd5 EB |
211 | } |
212 | ||
91fa93e5 MA |
213 | static bool qobject_output_deprecated(Visitor *v, const char *name) |
214 | { | |
215 | QObjectOutputVisitor *qov = to_qov(v); | |
216 | ||
217 | return qov->deprecated_policy != COMPAT_POLICY_OUTPUT_HIDE; | |
218 | } | |
219 | ||
56a6f02b EB |
220 | /* Finish building, and return the root object. |
221 | * The root object is never null. The caller becomes the object's | |
cb3e7f08 | 222 | * owner, and should use qobject_unref() when done with it. */ |
7d5e199a | 223 | static void qobject_output_complete(Visitor *v, void *opaque) |
e4e6aa14 | 224 | { |
7d5e199a | 225 | QObjectOutputVisitor *qov = to_qov(v); |
3b098d56 | 226 | |
56a6f02b | 227 | /* A visit must have occurred, with each start paired with end. */ |
fc76ae8b | 228 | assert(qov->root && QSLIST_EMPTY(&qov->stack)); |
3b098d56 | 229 | assert(opaque == qov->result); |
56a6f02b | 230 | |
f5a74a5a | 231 | *qov->result = qobject_ref(qov->root); |
3b098d56 | 232 | qov->result = NULL; |
e4e6aa14 MR |
233 | } |
234 | ||
7d5e199a | 235 | static void qobject_output_free(Visitor *v) |
2c0ef9f4 | 236 | { |
7d5e199a | 237 | QObjectOutputVisitor *qov = to_qov(v); |
fc76ae8b | 238 | QStackEntry *e; |
e4e6aa14 | 239 | |
fc76ae8b PB |
240 | while (!QSLIST_EMPTY(&qov->stack)) { |
241 | e = QSLIST_FIRST(&qov->stack); | |
242 | QSLIST_REMOVE_HEAD(&qov->stack, node); | |
7267c094 | 243 | g_free(e); |
e4e6aa14 MR |
244 | } |
245 | ||
cb3e7f08 | 246 | qobject_unref(qov->root); |
1830f22a | 247 | g_free(qov); |
e4e6aa14 MR |
248 | } |
249 | ||
7d5e199a | 250 | Visitor *qobject_output_visitor_new(QObject **result) |
e4e6aa14 | 251 | { |
7d5e199a | 252 | QObjectOutputVisitor *v; |
e4e6aa14 | 253 | |
7267c094 | 254 | v = g_malloc0(sizeof(*v)); |
e4e6aa14 | 255 | |
983f52d4 | 256 | v->visitor.type = VISITOR_OUTPUT; |
7d5e199a DB |
257 | v->visitor.start_struct = qobject_output_start_struct; |
258 | v->visitor.end_struct = qobject_output_end_struct; | |
259 | v->visitor.start_list = qobject_output_start_list; | |
260 | v->visitor.next_list = qobject_output_next_list; | |
261 | v->visitor.end_list = qobject_output_end_list; | |
262 | v->visitor.type_int64 = qobject_output_type_int64; | |
263 | v->visitor.type_uint64 = qobject_output_type_uint64; | |
264 | v->visitor.type_bool = qobject_output_type_bool; | |
265 | v->visitor.type_str = qobject_output_type_str; | |
266 | v->visitor.type_number = qobject_output_type_number; | |
267 | v->visitor.type_any = qobject_output_type_any; | |
268 | v->visitor.type_null = qobject_output_type_null; | |
91fa93e5 | 269 | v->visitor.deprecated = qobject_output_deprecated; |
7d5e199a DB |
270 | v->visitor.complete = qobject_output_complete; |
271 | v->visitor.free = qobject_output_free; | |
e4e6aa14 | 272 | |
3b098d56 EB |
273 | *result = NULL; |
274 | v->result = result; | |
e4e6aa14 | 275 | |
3b098d56 | 276 | return &v->visitor; |
e4e6aa14 | 277 | } |
91fa93e5 MA |
278 | |
279 | void qobject_output_visitor_set_policy(Visitor *v, | |
280 | CompatPolicyOutput deprecated) | |
281 | { | |
282 | QObjectOutputVisitor *qov = to_qov(v); | |
283 | ||
284 | qov->deprecated_policy = deprecated; | |
285 | } |