Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 1 | /* |
| 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 Maydell | f2ad72b | 2016-01-29 17:50:01 +0000 | [diff] [blame] | 14 | #include "qemu/osdep.h" |
Markus Armbruster | 99dbfd1 | 2017-02-28 22:26:54 +0100 | [diff] [blame] | 15 | #include "qapi/error.h" |
Markus Armbruster | 86cdf9e | 2018-08-23 18:40:20 +0200 | [diff] [blame] | 16 | #include "qapi/qmp/json-parser.h" |
Paolo Bonzini | 7b1b5d1 | 2012-12-17 18:19:43 +0100 | [diff] [blame] | 17 | #include "qapi/qmp/qjson.h" |
Markus Armbruster | 6b67395 | 2018-02-01 12:18:35 +0100 | [diff] [blame] | 18 | #include "qapi/qmp/qbool.h" |
Markus Armbruster | 452fcdb | 2018-02-01 12:18:39 +0100 | [diff] [blame] | 19 | #include "qapi/qmp/qdict.h" |
Markus Armbruster | 47e6b29 | 2018-02-01 12:18:38 +0100 | [diff] [blame] | 20 | #include "qapi/qmp/qlist.h" |
Markus Armbruster | 15280c3 | 2018-02-01 12:18:36 +0100 | [diff] [blame] | 21 | #include "qapi/qmp/qnum.h" |
Markus Armbruster | fc81fa1 | 2018-02-01 12:18:40 +0100 | [diff] [blame] | 22 | #include "qapi/qmp/qstring.h" |
Veronia Bahaa | f348b6d | 2016-03-20 19:16:19 +0200 | [diff] [blame] | 23 | #include "qemu/unicode.h" |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 24 | |
| 25 | typedef struct JSONParsingState |
| 26 | { |
| 27 | JSONMessageParser parser; |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 28 | QObject *result; |
Markus Armbruster | 99dbfd1 | 2017-02-28 22:26:54 +0100 | [diff] [blame] | 29 | Error *err; |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 30 | } JSONParsingState; |
| 31 | |
Markus Armbruster | 62815d8 | 2018-08-23 18:40:01 +0200 | [diff] [blame] | 32 | static void consume_json(void *opaque, QObject *json, Error *err) |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 33 | { |
Markus Armbruster | 62815d8 | 2018-08-23 18:40:01 +0200 | [diff] [blame] | 34 | JSONParsingState *s = opaque; |
Markus Armbruster | 99dbfd1 | 2017-02-28 22:26:54 +0100 | [diff] [blame] | 35 | |
Markus Armbruster | 2a4794b | 2018-08-23 18:40:10 +0200 | [diff] [blame] | 36 | 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 Armbruster | 62815d8 | 2018-08-23 18:40:01 +0200 | [diff] [blame] | 49 | s->result = json; |
Markus Armbruster | 2a4794b | 2018-08-23 18:40:10 +0200 | [diff] [blame] | 50 | s->err = err; |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 51 | } |
| 52 | |
Markus Armbruster | 2d36e84 | 2018-08-06 08:53:31 +0200 | [diff] [blame] | 53 | /* |
| 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 | */ |
| 63 | static QObject *qobject_from_jsonv(const char *string, va_list *ap, |
| 64 | Error **errp) |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 65 | { |
| 66 | JSONParsingState state = {}; |
| 67 | |
Markus Armbruster | 62815d8 | 2018-08-23 18:40:01 +0200 | [diff] [blame] | 68 | json_message_parser_init(&state.parser, consume_json, &state, ap); |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 69 | 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 Armbruster | dd98e84 | 2018-08-23 18:40:14 +0200 | [diff] [blame] | 73 | if (!state.result && !state.err) { |
| 74 | error_setg(&state.err, "Expecting a JSON value"); |
| 75 | } |
| 76 | |
Markus Armbruster | 99dbfd1 | 2017-02-28 22:26:54 +0100 | [diff] [blame] | 77 | error_propagate(errp, state.err); |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 78 | return state.result; |
| 79 | } |
| 80 | |
Markus Armbruster | 57348c2 | 2017-02-28 22:26:58 +0100 | [diff] [blame] | 81 | QObject *qobject_from_json(const char *string, Error **errp) |
Luiz Capitulino | 8ff5a7d | 2009-11-18 23:05:24 -0200 | [diff] [blame] | 82 | { |
Markus Armbruster | 57348c2 | 2017-02-28 22:26:58 +0100 | [diff] [blame] | 83 | return qobject_from_jsonv(string, NULL, errp); |
Luiz Capitulino | 8ff5a7d | 2009-11-18 23:05:24 -0200 | [diff] [blame] | 84 | } |
| 85 | |
Markus Armbruster | 6ce80fd | 2018-08-06 08:53:27 +0200 | [diff] [blame] | 86 | /* |
| 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 Armbruster | 4ff1846 | 2018-08-06 08:53:28 +0200 | [diff] [blame] | 91 | QObject *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 Armbruster | 6ce80fd | 2018-08-06 08:53:27 +0200 | [diff] [blame] | 110 | QObject *qobject_from_jsonf_nofail(const char *string, ...) |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 111 | { |
Luiz Capitulino | 8ff5a7d | 2009-11-18 23:05:24 -0200 | [diff] [blame] | 112 | QObject *obj; |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 113 | va_list ap; |
| 114 | |
| 115 | va_start(ap, string); |
Markus Armbruster | 4ff1846 | 2018-08-06 08:53:28 +0200 | [diff] [blame] | 116 | obj = qobject_from_vjsonf_nofail(string, ap); |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 117 | va_end(ap); |
| 118 | |
Luiz Capitulino | 8ff5a7d | 2009-11-18 23:05:24 -0200 | [diff] [blame] | 119 | return obj; |
Anthony Liguori | b4748b9 | 2009-11-11 10:42:41 -0600 | [diff] [blame] | 120 | } |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 121 | |
Markus Armbruster | a193352 | 2018-07-03 10:53:47 +0200 | [diff] [blame] | 122 | /* |
| 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 Armbruster | 4ff1846 | 2018-08-06 08:53:28 +0200 | [diff] [blame] | 127 | QDict *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 Armbruster | a193352 | 2018-07-03 10:53:47 +0200 | [diff] [blame] | 141 | QDict *qdict_from_jsonf_nofail(const char *string, ...) |
| 142 | { |
Markus Armbruster | 4ff1846 | 2018-08-06 08:53:28 +0200 | [diff] [blame] | 143 | QDict *qdict; |
Markus Armbruster | a193352 | 2018-07-03 10:53:47 +0200 | [diff] [blame] | 144 | va_list ap; |
| 145 | |
| 146 | va_start(ap, string); |
Markus Armbruster | 4ff1846 | 2018-08-06 08:53:28 +0200 | [diff] [blame] | 147 | qdict = qdict_from_vjsonf_nofail(string, ap); |
Markus Armbruster | a193352 | 2018-07-03 10:53:47 +0200 | [diff] [blame] | 148 | va_end(ap); |
Markus Armbruster | 4ff1846 | 2018-08-06 08:53:28 +0200 | [diff] [blame] | 149 | return qdict; |
Markus Armbruster | a193352 | 2018-07-03 10:53:47 +0200 | [diff] [blame] | 150 | } |
| 151 | |
Daniel P. Berrange | 212b600 | 2010-06-07 15:42:14 +0100 | [diff] [blame] | 152 | static void to_json(const QObject *obj, QString *str, int pretty, int indent); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 153 | |
Markus Armbruster | 1cd7741 | 2020-04-15 10:30:45 +0200 | [diff] [blame] | 154 | static 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. Berrange | 212b600 | 2010-06-07 15:42:14 +0100 | [diff] [blame] | 166 | static void to_json(const QObject *obj, QString *str, int pretty, int indent) |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 167 | { |
| 168 | switch (qobject_type(obj)) { |
Markus Armbruster | 481b002 | 2015-04-29 15:35:05 -0600 | [diff] [blame] | 169 | case QTYPE_QNULL: |
| 170 | qstring_append(str, "null"); |
| 171 | break; |
Marc-André Lureau | 01b2ffc | 2017-06-07 20:35:58 +0400 | [diff] [blame] | 172 | case QTYPE_QNUM: { |
Max Reitz | 7dc847e | 2018-02-24 16:40:29 +0100 | [diff] [blame] | 173 | QNum *val = qobject_to(QNum, obj); |
Marc-André Lureau | 01b2ffc | 2017-06-07 20:35:58 +0400 | [diff] [blame] | 174 | char *buffer = qnum_to_string(val); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 175 | qstring_append(str, buffer); |
Marc-André Lureau | 01b2ffc | 2017-06-07 20:35:58 +0400 | [diff] [blame] | 176 | g_free(buffer); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 177 | break; |
| 178 | } |
| 179 | case QTYPE_QSTRING: { |
Max Reitz | 7dc847e | 2018-02-24 16:40:29 +0100 | [diff] [blame] | 180 | QString *val = qobject_to(QString, obj); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 181 | const char *ptr; |
Markus Armbruster | e2ec3f9 | 2013-04-11 18:07:21 +0200 | [diff] [blame] | 182 | int cp; |
| 183 | char buf[16]; |
| 184 | char *end; |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 185 | |
| 186 | ptr = qstring_get_str(val); |
| 187 | qstring_append(str, "\""); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 188 | |
Markus Armbruster | e2ec3f9 | 2013-04-11 18:07:21 +0200 | [diff] [blame] | 189 | 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 Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 216 | } |
Markus Armbruster | e2ec3f9 | 2013-04-11 18:07:21 +0200 | [diff] [blame] | 217 | 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 Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 227 | } |
Markus Armbruster | e2ec3f9 | 2013-04-11 18:07:21 +0200 | [diff] [blame] | 228 | qstring_append(str, buf); |
| 229 | } |
| 230 | }; |
| 231 | |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 232 | qstring_append(str, "\""); |
| 233 | break; |
| 234 | } |
| 235 | case QTYPE_QDICT: { |
Max Reitz | 7dc847e | 2018-02-24 16:40:29 +0100 | [diff] [blame] | 236 | QDict *val = qobject_to(QDict, obj); |
Markus Armbruster | 7b1cd1c | 2020-04-15 10:30:47 +0200 | [diff] [blame] | 237 | const char *comma = pretty ? "," : ", "; |
| 238 | const char *sep = ""; |
| 239 | const QDictEntry *entry; |
| 240 | QString *qkey; |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 241 | |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 242 | qstring_append(str, "{"); |
Markus Armbruster | 7b1cd1c | 2020-04-15 10:30:47 +0200 | [diff] [blame] | 243 | |
| 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 Armbruster | 1cd7741 | 2020-04-15 10:30:45 +0200 | [diff] [blame] | 259 | json_pretty_newline(str, pretty, indent); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 260 | qstring_append(str, "}"); |
| 261 | break; |
| 262 | } |
| 263 | case QTYPE_QLIST: { |
Max Reitz | 7dc847e | 2018-02-24 16:40:29 +0100 | [diff] [blame] | 264 | QList *val = qobject_to(QList, obj); |
Markus Armbruster | 2f2ec11 | 2020-04-15 10:30:46 +0200 | [diff] [blame] | 265 | const char *comma = pretty ? "," : ", "; |
| 266 | const char *sep = ""; |
| 267 | QListEntry *entry; |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 268 | |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 269 | qstring_append(str, "["); |
Markus Armbruster | 2f2ec11 | 2020-04-15 10:30:46 +0200 | [diff] [blame] | 270 | |
| 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 Armbruster | 1cd7741 | 2020-04-15 10:30:45 +0200 | [diff] [blame] | 278 | json_pretty_newline(str, pretty, indent); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 279 | qstring_append(str, "]"); |
| 280 | break; |
| 281 | } |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 282 | case QTYPE_QBOOL: { |
Max Reitz | 7dc847e | 2018-02-24 16:40:29 +0100 | [diff] [blame] | 283 | QBool *val = qobject_to(QBool, obj); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 284 | |
Eric Blake | fc48ffc | 2015-05-15 16:24:59 -0600 | [diff] [blame] | 285 | if (qbool_get_bool(val)) { |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 286 | qstring_append(str, "true"); |
| 287 | } else { |
| 288 | qstring_append(str, "false"); |
| 289 | } |
| 290 | break; |
| 291 | } |
Markus Armbruster | a7c3181 | 2015-04-29 15:35:04 -0600 | [diff] [blame] | 292 | default: |
Kevin Wolf | 69dd62d | 2013-07-08 16:14:21 +0200 | [diff] [blame] | 293 | abort(); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 294 | } |
| 295 | } |
| 296 | |
| 297 | QString *qobject_to_json(const QObject *obj) |
| 298 | { |
| 299 | QString *str = qstring_new(); |
| 300 | |
Daniel P. Berrange | 212b600 | 2010-06-07 15:42:14 +0100 | [diff] [blame] | 301 | to_json(obj, str, 0, 0); |
| 302 | |
| 303 | return str; |
| 304 | } |
| 305 | |
| 306 | QString *qobject_to_json_pretty(const QObject *obj) |
| 307 | { |
| 308 | QString *str = qstring_new(); |
| 309 | |
| 310 | to_json(obj, str, 1, 0); |
Anthony Liguori | 1fd825f | 2009-11-11 12:01:22 -0600 | [diff] [blame] | 311 | |
| 312 | return str; |
| 313 | } |