blob: 9d0cdeb45cccea8f903d93f46d03dd7847ad427c [file] [log] [blame]
Luiz Capitulino9f9daf92009-11-18 23:05:30 -02001/*
Luiz Capitulino41836a92010-05-12 16:34:42 -03002 * QError Module
Luiz Capitulino9f9daf92009-11-18 23:05:30 -02003 *
4 * Copyright (C) 2009 Red Hat Inc.
5 *
6 * Authors:
7 * Luiz Capitulino <lcapitulino@redhat.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 */
Markus Armbruster0167f772010-03-22 10:29:05 +010012
13#include "monitor.h"
Luiz Capitulino9f9daf92009-11-18 23:05:30 -020014#include "qjson.h"
15#include "qerror.h"
Luiz Capitulino9f9daf92009-11-18 23:05:30 -020016#include "qemu-common.h"
17
18static void qerror_destroy_obj(QObject *obj);
19
20static const QType qerror_type = {
21 .code = QTYPE_QERROR,
22 .destroy = qerror_destroy_obj,
23};
24
25/**
26 * The 'desc' parameter is a printf-like string, the format of the format
27 * string is:
28 *
29 * %(KEY)
30 *
31 * Where KEY is a QDict key, which has to be passed to qerror_from_info().
32 *
33 * Example:
34 *
35 * "foo error on device: %(device) slot: %(slot_nr)"
36 *
37 * A single percent sign can be printed if followed by a second one,
38 * for example:
39 *
40 * "running out of foo: %(foo)%%"
Markus Armbruster9d494c42010-03-25 17:22:30 +010041 *
42 * Please keep the entries in alphabetical order.
43 * Use "sed -n '/^static.*qerror_table\[\]/,/^};/s/QERR_/&/gp' qerror.c | sort -c"
44 * to check.
Luiz Capitulino9f9daf92009-11-18 23:05:30 -020045 */
Blue Swirld05ac8f2009-12-04 20:44:44 +000046static const QErrorStringTable qerror_table[] = {
Luiz Capitulino357b6152009-11-18 23:05:32 -020047 {
Markus Armbruster56e9f562010-02-19 19:52:45 +010048 .error_fmt = QERR_BAD_BUS_FOR_DEVICE,
49 .desc = "Device '%(device)' can't go on a %(bad_bus_type) bus",
50 },
51 {
Markus Armbruster7bbd8232010-02-19 18:05:39 +010052 .error_fmt = QERR_BUS_NOT_FOUND,
53 .desc = "Bus '%(bus)' not found",
54 },
55 {
Markus Armbruster8eae73b2010-02-19 19:53:36 +010056 .error_fmt = QERR_BUS_NO_HOTPLUG,
57 .desc = "Bus '%(bus)' does not support hotplugging",
58 },
59 {
Markus Armbrustere16a1812009-12-07 21:37:02 +010060 .error_fmt = QERR_COMMAND_NOT_FOUND,
61 .desc = "The command %(name) has not been found",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -020062 },
63 {
Luiz Capitulino0df37c42009-12-07 21:36:59 +010064 .error_fmt = QERR_DEVICE_ENCRYPTED,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +010065 .desc = "Device '%(device)' is encrypted",
Luiz Capitulino0df37c42009-12-07 21:36:59 +010066 },
67 {
Markus Armbruster4d9a1a12010-02-19 19:53:54 +010068 .error_fmt = QERR_DEVICE_INIT_FAILED,
69 .desc = "Device '%(device)' could not be initialized",
70 },
71 {
Markus Armbruster5124eb52010-03-25 17:22:39 +010072 .error_fmt = QERR_DEVICE_IN_USE,
73 .desc = "Device '%(device)' is in use",
74 },
75 {
Markus Armbrusterb0868382009-12-07 21:37:03 +010076 .error_fmt = QERR_DEVICE_LOCKED,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +010077 .desc = "Device '%(device)' is locked",
Markus Armbrusterb0868382009-12-07 21:37:03 +010078 },
79 {
Markus Armbruster1ae78712010-02-19 18:05:59 +010080 .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
81 .desc = "Device '%(device)' has multiple child busses",
82 },
83 {
Luiz Capitulino055f6122009-11-18 23:05:34 -020084 .error_fmt = QERR_DEVICE_NOT_ACTIVE,
Luiz Capitulino8754c812010-06-23 12:37:47 -030085 .desc = "Device '%(device)' has not been activated",
Luiz Capitulino055f6122009-11-18 23:05:34 -020086 },
Luiz Capitulino82a60712009-11-18 23:05:35 -020087 {
Markus Armbruster9d494c42010-03-25 17:22:30 +010088 .error_fmt = QERR_DEVICE_NOT_ENCRYPTED,
89 .desc = "Device '%(device)' is not encrypted",
90 },
91 {
Markus Armbrustere16a1812009-12-07 21:37:02 +010092 .error_fmt = QERR_DEVICE_NOT_FOUND,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +010093 .desc = "Device '%(device)' not found",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -020094 },
95 {
Markus Armbruster5cfe0262009-12-07 21:37:04 +010096 .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +010097 .desc = "Device '%(device)' is not removable",
Markus Armbruster5cfe0262009-12-07 21:37:04 +010098 },
99 {
Markus Armbruster07574ba2010-02-19 18:06:18 +0100100 .error_fmt = QERR_DEVICE_NO_BUS,
101 .desc = "Device '%(device)' has no child bus",
102 },
103 {
Gerd Hoffmann180c22e2011-01-06 15:14:37 +0100104 .error_fmt = QERR_DEVICE_NO_HOTPLUG,
105 .desc = "Device '%(device)' does not support hotplugging",
106 },
107 {
Markus Armbruster7bc84012010-03-25 17:22:31 +0100108 .error_fmt = QERR_DUPLICATE_ID,
109 .desc = "Duplicate ID '%(id)' for %(object)",
110 },
111 {
Markus Armbrusterc7c338c2009-12-07 21:37:10 +0100112 .error_fmt = QERR_FD_NOT_FOUND,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100113 .desc = "File descriptor named '%(name)' not found",
Markus Armbrusterc7c338c2009-12-07 21:37:10 +0100114 },
115 {
Markus Armbruster41471a22009-12-07 21:37:12 +0100116 .error_fmt = QERR_FD_NOT_SUPPLIED,
117 .desc = "No file descriptor supplied via SCM_RIGHTS",
118 },
119 {
Markus Armbruster17901e72009-12-07 21:37:06 +0100120 .error_fmt = QERR_INVALID_BLOCK_FORMAT,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100121 .desc = "Invalid block format '%(name)'",
Markus Armbruster17901e72009-12-07 21:37:06 +0100122 },
123 {
Markus Armbruster7a046f52009-12-07 21:37:13 +0100124 .error_fmt = QERR_INVALID_PARAMETER,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100125 .desc = "Invalid parameter '%(name)'",
Markus Armbruster7a046f52009-12-07 21:37:13 +0100126 },
127 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100128 .error_fmt = QERR_INVALID_PARAMETER_TYPE,
129 .desc = "Invalid parameter type, expected: %(expected)",
130 },
131 {
Markus Armbruster985a3e52010-03-25 17:22:33 +0100132 .error_fmt = QERR_INVALID_PARAMETER_VALUE,
133 .desc = "Parameter '%(name)' expects %(expected)",
134 },
135 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100136 .error_fmt = QERR_INVALID_PASSWORD,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100137 .desc = "Password incorrect",
Markus Armbrustere16a1812009-12-07 21:37:02 +0100138 },
139 {
140 .error_fmt = QERR_JSON_PARSING,
141 .desc = "Invalid JSON syntax",
Luiz Capitulinof6d855c2009-12-04 15:24:08 -0200142 },
143 {
Luiz Capitulino82a60712009-11-18 23:05:35 -0200144 .error_fmt = QERR_KVM_MISSING_CAP,
145 .desc = "Using KVM without %(capability), %(feature) unavailable",
146 },
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200147 {
Amit Shah8e848652010-07-27 15:49:19 +0530148 .error_fmt = QERR_MIGRATION_EXPECTED,
149 .desc = "An incoming migration is expected before this command can be executed",
150 },
151 {
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200152 .error_fmt = QERR_MISSING_PARAMETER,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100153 .desc = "Parameter '%(name)' is missing",
154 },
155 {
Markus Armbrusterfab57672010-02-19 19:54:06 +0100156 .error_fmt = QERR_NO_BUS_FOR_DEVICE,
157 .desc = "No '%(bus)' bus found for device '%(device)'",
158 },
159 {
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100160 .error_fmt = QERR_OPEN_FILE_FAILED,
161 .desc = "Could not open '%(filename)'",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200162 },
163 {
Markus Armbrusterc58a35f2010-02-19 13:11:41 +0100164 .error_fmt = QERR_PROPERTY_NOT_FOUND,
165 .desc = "Property '%(device).%(property)' not found",
166 },
167 {
Markus Armbruster06b4a702010-02-19 13:17:58 +0100168 .error_fmt = QERR_PROPERTY_VALUE_BAD,
169 .desc = "Property '%(device).%(property)' doesn't take value '%(value)'",
170 },
171 {
Markus Armbruster9c5eff92010-03-16 17:40:48 +0100172 .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
173 .desc = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
174 },
175 {
Markus Armbruster84745d62010-03-16 17:44:38 +0100176 .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
177 .desc = "Property '%(device).%(property)' can't find value '%(value)'",
178 },
179 {
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200180 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
Luiz Capitulinoabaf2f52010-04-07 14:53:49 -0300181 .desc = "Expected '%(expected)' in QMP input",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200182 },
183 {
Luiz Capitulino7dfb6122010-04-07 14:46:33 -0300184 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
185 .desc = "QMP input object member '%(member)' expects '%(expected)'",
186 },
187 {
Luiz Capitulino60d76d72010-06-01 16:15:23 -0300188 .error_fmt = QERR_QMP_EXTRA_MEMBER,
189 .desc = "QMP input object member '%(member)' is unexpected",
190 },
191 {
Markus Armbruster7a84cb22009-12-07 21:37:07 +0100192 .error_fmt = QERR_SET_PASSWD_FAILED,
193 .desc = "Could not set password",
194 },
195 {
Markus Armbrustera488be22009-12-07 21:37:14 +0100196 .error_fmt = QERR_TOO_MANY_FILES,
197 .desc = "Too many open files",
198 },
199 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100200 .error_fmt = QERR_UNDEFINED_ERROR,
201 .desc = "An undefined error has ocurred",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200202 },
Markus Armbrustera6906e32009-12-07 21:37:08 +0100203 {
204 .error_fmt = QERR_VNC_SERVER_FAILED,
205 .desc = "Could not start VNC server on %(target)",
206 },
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200207 {}
208};
209
210/**
211 * qerror_new(): Create a new QError
212 *
213 * Return strong reference.
214 */
215QError *qerror_new(void)
216{
217 QError *qerr;
218
219 qerr = qemu_mallocz(sizeof(*qerr));
220 QOBJECT_INIT(qerr, &qerror_type);
221
222 return qerr;
223}
224
Stefan Weil8b7968f2010-09-23 21:28:05 +0200225static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr,
226 const char *fmt, ...)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200227{
228 va_list ap;
229
230 fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
231 fprintf(stderr, "qerror: -> ");
232
233 va_start(ap, fmt);
234 vfprintf(stderr, fmt, ap);
235 va_end(ap);
236
237 fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
238 abort();
239}
240
Stefan Weil8b7968f2010-09-23 21:28:05 +0200241static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr,
242 const char *fmt, va_list *va)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200243{
244 QObject *obj;
245
246 obj = qobject_from_jsonv(fmt, va);
247 if (!obj) {
248 qerror_abort(qerr, "invalid format '%s'", fmt);
249 }
250 if (qobject_type(obj) != QTYPE_QDICT) {
251 qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
252 }
253
254 qerr->error = qobject_to_qdict(obj);
255
256 obj = qdict_get(qerr->error, "class");
257 if (!obj) {
258 qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
259 }
260 if (qobject_type(obj) != QTYPE_QSTRING) {
261 qerror_abort(qerr, "'class' key value should be a QString");
262 }
263
264 obj = qdict_get(qerr->error, "data");
265 if (!obj) {
266 qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
267 }
268 if (qobject_type(obj) != QTYPE_QDICT) {
269 qerror_abort(qerr, "'data' key value should be a QDICT");
270 }
271}
272
273static void qerror_set_desc(QError *qerr, const char *fmt)
274{
275 int i;
276
277 // FIXME: inefficient loop
278
279 for (i = 0; qerror_table[i].error_fmt; i++) {
280 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
281 qerr->entry = &qerror_table[i];
282 return;
283 }
284 }
285
286 qerror_abort(qerr, "error format '%s' not found", fmt);
287}
288
289/**
290 * qerror_from_info(): Create a new QError from error information
291 *
292 * The information consists of:
293 *
294 * - file the file name of where the error occurred
295 * - linenr the line number of where the error occurred
296 * - func the function name of where the error occurred
297 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
298 * 'data'
299 * - va va_list of all arguments specified by fmt
300 *
301 * Return strong reference.
302 */
303QError *qerror_from_info(const char *file, int linenr, const char *func,
304 const char *fmt, va_list *va)
305{
306 QError *qerr;
307
308 qerr = qerror_new();
Markus Armbruster827b0812010-02-18 19:46:49 +0100309 loc_save(&qerr->loc);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200310 qerr->linenr = linenr;
311 qerr->file = file;
312 qerr->func = func;
313
314 if (!fmt) {
315 qerror_abort(qerr, "QDict not specified");
316 }
317
318 qerror_set_data(qerr, fmt, va);
319 qerror_set_desc(qerr, fmt);
320
321 return qerr;
322}
323
324static void parse_error(const QError *qerror, int c)
325{
326 qerror_abort(qerror, "expected '%c' in '%s'", c, qerror->entry->desc);
327}
328
329static const char *append_field(QString *outstr, const QError *qerror,
330 const char *start)
331{
332 QObject *obj;
333 QDict *qdict;
334 QString *key_qs;
335 const char *end, *key;
336
337 if (*start != '%')
338 parse_error(qerror, '%');
339 start++;
340 if (*start != '(')
341 parse_error(qerror, '(');
342 start++;
343
344 end = strchr(start, ')');
345 if (!end)
346 parse_error(qerror, ')');
347
348 key_qs = qstring_from_substr(start, 0, end - start - 1);
349 key = qstring_get_str(key_qs);
350
351 qdict = qobject_to_qdict(qdict_get(qerror->error, "data"));
352 obj = qdict_get(qdict, key);
353 if (!obj) {
354 qerror_abort(qerror, "key '%s' not found in QDict", key);
355 }
356
357 switch (qobject_type(obj)) {
358 case QTYPE_QSTRING:
359 qstring_append(outstr, qdict_get_str(qdict, key));
360 break;
361 case QTYPE_QINT:
362 qstring_append_int(outstr, qdict_get_int(qdict, key));
363 break;
364 default:
365 qerror_abort(qerror, "invalid type '%c'", qobject_type(obj));
366 }
367
368 QDECREF(key_qs);
369 return ++end;
370}
371
372/**
Markus Armbruster77e595e2009-12-07 21:37:16 +0100373 * qerror_human(): Format QError data into human-readable string.
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200374 *
Markus Armbruster77e595e2009-12-07 21:37:16 +0100375 * Formats according to member 'desc' of the specified QError object.
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200376 */
Markus Armbruster77e595e2009-12-07 21:37:16 +0100377QString *qerror_human(const QError *qerror)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200378{
379 const char *p;
380 QString *qstring;
381
382 assert(qerror->entry != NULL);
383
384 qstring = qstring_new();
385
386 for (p = qerror->entry->desc; *p != '\0';) {
387 if (*p != '%') {
388 qstring_append_chr(qstring, *p++);
389 } else if (*(p + 1) == '%') {
390 qstring_append_chr(qstring, '%');
391 p += 2;
392 } else {
393 p = append_field(qstring, qerror, p);
394 }
395 }
396
Markus Armbruster77e595e2009-12-07 21:37:16 +0100397 return qstring;
398}
399
400/**
401 * qerror_print(): Print QError data
402 *
403 * This function will print the member 'desc' of the specified QError object,
Markus Armbruster1ecda022010-02-18 17:25:24 +0100404 * it uses error_report() for this, so that the output is routed to the right
Markus Armbruster77e595e2009-12-07 21:37:16 +0100405 * place (ie. stderr or Monitor's device).
406 */
Markus Armbruster827b0812010-02-18 19:46:49 +0100407void qerror_print(QError *qerror)
Markus Armbruster77e595e2009-12-07 21:37:16 +0100408{
409 QString *qstring = qerror_human(qerror);
Markus Armbruster827b0812010-02-18 19:46:49 +0100410 loc_push_restore(&qerror->loc);
Markus Armbruster1ecda022010-02-18 17:25:24 +0100411 error_report("%s", qstring_get_str(qstring));
Markus Armbruster827b0812010-02-18 19:46:49 +0100412 loc_pop(&qerror->loc);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200413 QDECREF(qstring);
414}
415
Markus Armbruster0167f772010-03-22 10:29:05 +0100416void qerror_report_internal(const char *file, int linenr, const char *func,
417 const char *fmt, ...)
418{
419 va_list va;
420 QError *qerror;
421
422 va_start(va, fmt);
423 qerror = qerror_from_info(file, linenr, func, fmt, &va);
424 va_end(va);
425
426 if (monitor_cur_is_qmp()) {
427 monitor_set_error(cur_mon, qerror);
428 } else {
429 qerror_print(qerror);
430 QDECREF(qerror);
431 }
432}
433
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200434/**
435 * qobject_to_qerror(): Convert a QObject into a QError
436 */
437QError *qobject_to_qerror(const QObject *obj)
438{
439 if (qobject_type(obj) != QTYPE_QERROR) {
440 return NULL;
441 }
442
443 return container_of(obj, QError, base);
444}
445
446/**
447 * qerror_destroy_obj(): Free all memory allocated by a QError
448 */
449static void qerror_destroy_obj(QObject *obj)
450{
451 QError *qerr;
452
453 assert(obj != NULL);
454 qerr = qobject_to_qerror(obj);
455
456 QDECREF(qerr->error);
457 qemu_free(qerr);
458}