blob: f1f2c6970457d3b0eac909b493bdf5c87ec9778f [file] [log] [blame]
Anthony Liguorib4748b92009-11-11 10:42:41 -06001/*
2 * QObject JSON integration
3 *
4 * Copyright IBM, Corp. 2009
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
Peter Maydellf2ad72b2016-01-29 17:50:01 +000014#include "qemu/osdep.h"
Markus Armbruster99dbfd12017-02-28 22:26:54 +010015#include "qapi/error.h"
Markus Armbruster86cdf9e2018-08-23 18:40:20 +020016#include "qapi/qmp/json-parser.h"
Paolo Bonzini7b1b5d12012-12-17 18:19:43 +010017#include "qapi/qmp/qjson.h"
Markus Armbruster6b673952018-02-01 12:18:35 +010018#include "qapi/qmp/qbool.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010019#include "qapi/qmp/qdict.h"
Markus Armbruster47e6b292018-02-01 12:18:38 +010020#include "qapi/qmp/qlist.h"
Markus Armbruster15280c32018-02-01 12:18:36 +010021#include "qapi/qmp/qnum.h"
Markus Armbrusterfc81fa12018-02-01 12:18:40 +010022#include "qapi/qmp/qstring.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020023#include "qemu/unicode.h"
Anthony Liguorib4748b92009-11-11 10:42:41 -060024
25typedef struct JSONParsingState
26{
27 JSONMessageParser parser;
Anthony Liguorib4748b92009-11-11 10:42:41 -060028 QObject *result;
Markus Armbruster99dbfd12017-02-28 22:26:54 +010029 Error *err;
Anthony Liguorib4748b92009-11-11 10:42:41 -060030} JSONParsingState;
31
Markus Armbruster62815d82018-08-23 18:40:01 +020032static void consume_json(void *opaque, QObject *json, Error *err)
Anthony Liguorib4748b92009-11-11 10:42:41 -060033{
Markus Armbruster62815d82018-08-23 18:40:01 +020034 JSONParsingState *s = opaque;
Markus Armbruster99dbfd12017-02-28 22:26:54 +010035
Markus Armbruster2a4794b2018-08-23 18:40:10 +020036 assert(!json != !err);
37 assert(!s->result || !s->err);
38
39 if (s->result) {
40 qobject_unref(s->result);
41 s->result = NULL;
42 error_setg(&s->err, "Expecting at most one JSON value");
43 }
44 if (s->err) {
45 qobject_unref(json);
46 error_free(err);
47 return;
48 }
Markus Armbruster62815d82018-08-23 18:40:01 +020049 s->result = json;
Markus Armbruster2a4794b2018-08-23 18:40:10 +020050 s->err = err;
Anthony Liguorib4748b92009-11-11 10:42:41 -060051}
52
Markus Armbruster2d36e842018-08-06 08:53:31 +020053/*
54 * Parse @string as JSON value.
55 * If @ap is non-null, interpolate %-escapes.
56 * Takes ownership of %p arguments.
57 * On success, return the JSON value.
58 * On failure, store an error through @errp and return NULL.
59 * Ownership of %p arguments becomes indeterminate then. To avoid
60 * leaks, callers passing %p must terminate on error, e.g. by passing
61 * &error_abort.
62 */
63static QObject *qobject_from_jsonv(const char *string, va_list *ap,
64 Error **errp)
Anthony Liguorib4748b92009-11-11 10:42:41 -060065{
66 JSONParsingState state = {};
67
Markus Armbruster62815d82018-08-23 18:40:01 +020068 json_message_parser_init(&state.parser, consume_json, &state, ap);
Anthony Liguorib4748b92009-11-11 10:42:41 -060069 json_message_parser_feed(&state.parser, string, strlen(string));
70 json_message_parser_flush(&state.parser);
71 json_message_parser_destroy(&state.parser);
72
Markus Armbrusterdd98e842018-08-23 18:40:14 +020073 if (!state.result && !state.err) {
74 error_setg(&state.err, "Expecting a JSON value");
75 }
76
Markus Armbruster99dbfd12017-02-28 22:26:54 +010077 error_propagate(errp, state.err);
Anthony Liguorib4748b92009-11-11 10:42:41 -060078 return state.result;
79}
80
Markus Armbruster57348c22017-02-28 22:26:58 +010081QObject *qobject_from_json(const char *string, Error **errp)
Luiz Capitulino8ff5a7d2009-11-18 23:05:24 -020082{
Markus Armbruster57348c22017-02-28 22:26:58 +010083 return qobject_from_jsonv(string, NULL, errp);
Luiz Capitulino8ff5a7d2009-11-18 23:05:24 -020084}
85
Markus Armbruster6ce80fd2018-08-06 08:53:27 +020086/*
87 * Parse @string as JSON value with %-escapes interpolated.
88 * Abort on error. Do not use with untrusted @string.
89 * Return the resulting QObject. It is never null.
90 */
Markus Armbruster4ff18462018-08-06 08:53:28 +020091QObject *qobject_from_vjsonf_nofail(const char *string, va_list ap)
92{
93 va_list ap_copy;
94 QObject *obj;
95
96 /* va_copy() is needed when va_list is an array type */
97 va_copy(ap_copy, ap);
98 obj = qobject_from_jsonv(string, &ap_copy, &error_abort);
99 va_end(ap_copy);
100
101 assert(obj);
102 return obj;
103}
104
105/*
106 * Parse @string as JSON value with %-escapes interpolated.
107 * Abort on error. Do not use with untrusted @string.
108 * Return the resulting QObject. It is never null.
109 */
Markus Armbruster6ce80fd2018-08-06 08:53:27 +0200110QObject *qobject_from_jsonf_nofail(const char *string, ...)
Anthony Liguorib4748b92009-11-11 10:42:41 -0600111{
Luiz Capitulino8ff5a7d2009-11-18 23:05:24 -0200112 QObject *obj;
Anthony Liguorib4748b92009-11-11 10:42:41 -0600113 va_list ap;
114
115 va_start(ap, string);
Markus Armbruster4ff18462018-08-06 08:53:28 +0200116 obj = qobject_from_vjsonf_nofail(string, ap);
Anthony Liguorib4748b92009-11-11 10:42:41 -0600117 va_end(ap);
118
Luiz Capitulino8ff5a7d2009-11-18 23:05:24 -0200119 return obj;
Anthony Liguorib4748b92009-11-11 10:42:41 -0600120}
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600121
Markus Armbrustera1933522018-07-03 10:53:47 +0200122/*
123 * Parse @string as JSON object with %-escapes interpolated.
124 * Abort on error. Do not use with untrusted @string.
125 * Return the resulting QDict. It is never null.
126 */
Markus Armbruster4ff18462018-08-06 08:53:28 +0200127QDict *qdict_from_vjsonf_nofail(const char *string, va_list ap)
128{
129 QDict *qdict;
130
131 qdict = qobject_to(QDict, qobject_from_vjsonf_nofail(string, ap));
132 assert(qdict);
133 return qdict;
134}
135
136/*
137 * Parse @string as JSON object with %-escapes interpolated.
138 * Abort on error. Do not use with untrusted @string.
139 * Return the resulting QDict. It is never null.
140 */
Markus Armbrustera1933522018-07-03 10:53:47 +0200141QDict *qdict_from_jsonf_nofail(const char *string, ...)
142{
Markus Armbruster4ff18462018-08-06 08:53:28 +0200143 QDict *qdict;
Markus Armbrustera1933522018-07-03 10:53:47 +0200144 va_list ap;
145
146 va_start(ap, string);
Markus Armbruster4ff18462018-08-06 08:53:28 +0200147 qdict = qdict_from_vjsonf_nofail(string, ap);
Markus Armbrustera1933522018-07-03 10:53:47 +0200148 va_end(ap);
Markus Armbruster4ff18462018-08-06 08:53:28 +0200149 return qdict;
Markus Armbrustera1933522018-07-03 10:53:47 +0200150}
151
Daniel P. Berrange212b6002010-06-07 15:42:14 +0100152static void to_json(const QObject *obj, QString *str, int pretty, int indent);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600153
Markus Armbruster1cd77412020-04-15 10:30:45 +0200154static void json_pretty_newline(QString *str, bool pretty, int indent)
155{
156 int i;
157
158 if (pretty) {
159 qstring_append(str, "\n");
160 for (i = 0; i < indent; i++) {
161 qstring_append(str, " ");
162 }
163 }
164}
165
Daniel P. Berrange212b6002010-06-07 15:42:14 +0100166static void to_json(const QObject *obj, QString *str, int pretty, int indent)
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600167{
168 switch (qobject_type(obj)) {
Markus Armbruster481b0022015-04-29 15:35:05 -0600169 case QTYPE_QNULL:
170 qstring_append(str, "null");
171 break;
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400172 case QTYPE_QNUM: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100173 QNum *val = qobject_to(QNum, obj);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400174 char *buffer = qnum_to_string(val);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600175 qstring_append(str, buffer);
Marc-André Lureau01b2ffc2017-06-07 20:35:58 +0400176 g_free(buffer);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600177 break;
178 }
179 case QTYPE_QSTRING: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100180 QString *val = qobject_to(QString, obj);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600181 const char *ptr;
Markus Armbrustere2ec3f92013-04-11 18:07:21 +0200182 int cp;
183 char buf[16];
184 char *end;
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600185
186 ptr = qstring_get_str(val);
187 qstring_append(str, "\"");
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600188
Markus Armbrustere2ec3f92013-04-11 18:07:21 +0200189 for (; *ptr; ptr = end) {
190 cp = mod_utf8_codepoint(ptr, 6, &end);
191 switch (cp) {
192 case '\"':
193 qstring_append(str, "\\\"");
194 break;
195 case '\\':
196 qstring_append(str, "\\\\");
197 break;
198 case '\b':
199 qstring_append(str, "\\b");
200 break;
201 case '\f':
202 qstring_append(str, "\\f");
203 break;
204 case '\n':
205 qstring_append(str, "\\n");
206 break;
207 case '\r':
208 qstring_append(str, "\\r");
209 break;
210 case '\t':
211 qstring_append(str, "\\t");
212 break;
213 default:
214 if (cp < 0) {
215 cp = 0xFFFD; /* replacement character */
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600216 }
Markus Armbrustere2ec3f92013-04-11 18:07:21 +0200217 if (cp > 0xFFFF) {
218 /* beyond BMP; need a surrogate pair */
219 snprintf(buf, sizeof(buf), "\\u%04X\\u%04X",
220 0xD800 + ((cp - 0x10000) >> 10),
221 0xDC00 + ((cp - 0x10000) & 0x3FF));
222 } else if (cp < 0x20 || cp >= 0x7F) {
223 snprintf(buf, sizeof(buf), "\\u%04X", cp);
224 } else {
225 buf[0] = cp;
226 buf[1] = 0;
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600227 }
Markus Armbrustere2ec3f92013-04-11 18:07:21 +0200228 qstring_append(str, buf);
229 }
230 };
231
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600232 qstring_append(str, "\"");
233 break;
234 }
235 case QTYPE_QDICT: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100236 QDict *val = qobject_to(QDict, obj);
Markus Armbruster7b1cd1c2020-04-15 10:30:47 +0200237 const char *comma = pretty ? "," : ", ";
238 const char *sep = "";
239 const QDictEntry *entry;
240 QString *qkey;
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600241
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600242 qstring_append(str, "{");
Markus Armbruster7b1cd1c2020-04-15 10:30:47 +0200243
244 for (entry = qdict_first(val);
245 entry;
246 entry = qdict_next(val, entry)) {
247 qstring_append(str, sep);
248 json_pretty_newline(str, pretty, indent + 1);
249
250 qkey = qstring_from_str(qdict_entry_key(entry));
251 to_json(QOBJECT(qkey), str, pretty, indent + 1);
252 qobject_unref(qkey);
253
254 qstring_append(str, ": ");
255 to_json(qdict_entry_value(entry), str, pretty, indent + 1);
256 sep = comma;
257 }
258
Markus Armbruster1cd77412020-04-15 10:30:45 +0200259 json_pretty_newline(str, pretty, indent);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600260 qstring_append(str, "}");
261 break;
262 }
263 case QTYPE_QLIST: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100264 QList *val = qobject_to(QList, obj);
Markus Armbruster2f2ec112020-04-15 10:30:46 +0200265 const char *comma = pretty ? "," : ", ";
266 const char *sep = "";
267 QListEntry *entry;
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600268
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600269 qstring_append(str, "[");
Markus Armbruster2f2ec112020-04-15 10:30:46 +0200270
271 QLIST_FOREACH_ENTRY(val, entry) {
272 qstring_append(str, sep);
273 json_pretty_newline(str, pretty, indent + 1);
274 to_json(qlist_entry_obj(entry), str, pretty, indent + 1);
275 sep = comma;
276 }
277
Markus Armbruster1cd77412020-04-15 10:30:45 +0200278 json_pretty_newline(str, pretty, indent);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600279 qstring_append(str, "]");
280 break;
281 }
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600282 case QTYPE_QBOOL: {
Max Reitz7dc847e2018-02-24 16:40:29 +0100283 QBool *val = qobject_to(QBool, obj);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600284
Eric Blakefc48ffc2015-05-15 16:24:59 -0600285 if (qbool_get_bool(val)) {
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600286 qstring_append(str, "true");
287 } else {
288 qstring_append(str, "false");
289 }
290 break;
291 }
Markus Armbrustera7c31812015-04-29 15:35:04 -0600292 default:
Kevin Wolf69dd62d2013-07-08 16:14:21 +0200293 abort();
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600294 }
295}
296
297QString *qobject_to_json(const QObject *obj)
298{
299 QString *str = qstring_new();
300
Daniel P. Berrange212b6002010-06-07 15:42:14 +0100301 to_json(obj, str, 0, 0);
302
303 return str;
304}
305
306QString *qobject_to_json_pretty(const QObject *obj)
307{
308 QString *str = qstring_new();
309
310 to_json(obj, str, 1, 0);
Anthony Liguori1fd825f2009-11-11 12:01:22 -0600311
312 return str;
313}