blob: 2f6f59061f317a1d0fee11d357e4dc89774f38dd [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 {
Markus Armbruster7bc84012010-03-25 17:22:31 +0100104 .error_fmt = QERR_DUPLICATE_ID,
105 .desc = "Duplicate ID '%(id)' for %(object)",
106 },
107 {
Markus Armbrusterc7c338c2009-12-07 21:37:10 +0100108 .error_fmt = QERR_FD_NOT_FOUND,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100109 .desc = "File descriptor named '%(name)' not found",
Markus Armbrusterc7c338c2009-12-07 21:37:10 +0100110 },
111 {
Markus Armbruster41471a22009-12-07 21:37:12 +0100112 .error_fmt = QERR_FD_NOT_SUPPLIED,
113 .desc = "No file descriptor supplied via SCM_RIGHTS",
114 },
115 {
Markus Armbruster17901e72009-12-07 21:37:06 +0100116 .error_fmt = QERR_INVALID_BLOCK_FORMAT,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100117 .desc = "Invalid block format '%(name)'",
Markus Armbruster17901e72009-12-07 21:37:06 +0100118 },
119 {
Markus Armbruster7a046f52009-12-07 21:37:13 +0100120 .error_fmt = QERR_INVALID_PARAMETER,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100121 .desc = "Invalid parameter '%(name)'",
Markus Armbruster7a046f52009-12-07 21:37:13 +0100122 },
123 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100124 .error_fmt = QERR_INVALID_PARAMETER_TYPE,
125 .desc = "Invalid parameter type, expected: %(expected)",
126 },
127 {
Markus Armbruster985a3e52010-03-25 17:22:33 +0100128 .error_fmt = QERR_INVALID_PARAMETER_VALUE,
129 .desc = "Parameter '%(name)' expects %(expected)",
130 },
131 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100132 .error_fmt = QERR_INVALID_PASSWORD,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100133 .desc = "Password incorrect",
Markus Armbrustere16a1812009-12-07 21:37:02 +0100134 },
135 {
136 .error_fmt = QERR_JSON_PARSING,
137 .desc = "Invalid JSON syntax",
Luiz Capitulinof6d855c2009-12-04 15:24:08 -0200138 },
139 {
Luiz Capitulino82a60712009-11-18 23:05:35 -0200140 .error_fmt = QERR_KVM_MISSING_CAP,
141 .desc = "Using KVM without %(capability), %(feature) unavailable",
142 },
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200143 {
144 .error_fmt = QERR_MISSING_PARAMETER,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100145 .desc = "Parameter '%(name)' is missing",
146 },
147 {
Markus Armbrusterfab57672010-02-19 19:54:06 +0100148 .error_fmt = QERR_NO_BUS_FOR_DEVICE,
149 .desc = "No '%(bus)' bus found for device '%(device)'",
150 },
151 {
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100152 .error_fmt = QERR_OPEN_FILE_FAILED,
153 .desc = "Could not open '%(filename)'",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200154 },
155 {
Markus Armbrusterc58a35f2010-02-19 13:11:41 +0100156 .error_fmt = QERR_PROPERTY_NOT_FOUND,
157 .desc = "Property '%(device).%(property)' not found",
158 },
159 {
Markus Armbruster06b4a702010-02-19 13:17:58 +0100160 .error_fmt = QERR_PROPERTY_VALUE_BAD,
161 .desc = "Property '%(device).%(property)' doesn't take value '%(value)'",
162 },
163 {
Markus Armbruster9c5eff92010-03-16 17:40:48 +0100164 .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
165 .desc = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
166 },
167 {
Markus Armbruster84745d62010-03-16 17:44:38 +0100168 .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
169 .desc = "Property '%(device).%(property)' can't find value '%(value)'",
170 },
171 {
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200172 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
Luiz Capitulinoabaf2f52010-04-07 14:53:49 -0300173 .desc = "Expected '%(expected)' in QMP input",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200174 },
175 {
Luiz Capitulino7dfb6122010-04-07 14:46:33 -0300176 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
177 .desc = "QMP input object member '%(member)' expects '%(expected)'",
178 },
179 {
Luiz Capitulino60d76d72010-06-01 16:15:23 -0300180 .error_fmt = QERR_QMP_EXTRA_MEMBER,
181 .desc = "QMP input object member '%(member)' is unexpected",
182 },
183 {
Markus Armbruster7a84cb22009-12-07 21:37:07 +0100184 .error_fmt = QERR_SET_PASSWD_FAILED,
185 .desc = "Could not set password",
186 },
187 {
Markus Armbrustera488be22009-12-07 21:37:14 +0100188 .error_fmt = QERR_TOO_MANY_FILES,
189 .desc = "Too many open files",
190 },
191 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100192 .error_fmt = QERR_UNDEFINED_ERROR,
193 .desc = "An undefined error has ocurred",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200194 },
Markus Armbrustera6906e32009-12-07 21:37:08 +0100195 {
196 .error_fmt = QERR_VNC_SERVER_FAILED,
197 .desc = "Could not start VNC server on %(target)",
198 },
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200199 {}
200};
201
202/**
203 * qerror_new(): Create a new QError
204 *
205 * Return strong reference.
206 */
207QError *qerror_new(void)
208{
209 QError *qerr;
210
211 qerr = qemu_mallocz(sizeof(*qerr));
212 QOBJECT_INIT(qerr, &qerror_type);
213
214 return qerr;
215}
216
217static void qerror_abort(const QError *qerr, const char *fmt, ...)
218{
219 va_list ap;
220
221 fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
222 fprintf(stderr, "qerror: -> ");
223
224 va_start(ap, fmt);
225 vfprintf(stderr, fmt, ap);
226 va_end(ap);
227
228 fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
229 abort();
230}
231
232static void qerror_set_data(QError *qerr, const char *fmt, va_list *va)
233{
234 QObject *obj;
235
236 obj = qobject_from_jsonv(fmt, va);
237 if (!obj) {
238 qerror_abort(qerr, "invalid format '%s'", fmt);
239 }
240 if (qobject_type(obj) != QTYPE_QDICT) {
241 qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
242 }
243
244 qerr->error = qobject_to_qdict(obj);
245
246 obj = qdict_get(qerr->error, "class");
247 if (!obj) {
248 qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
249 }
250 if (qobject_type(obj) != QTYPE_QSTRING) {
251 qerror_abort(qerr, "'class' key value should be a QString");
252 }
253
254 obj = qdict_get(qerr->error, "data");
255 if (!obj) {
256 qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
257 }
258 if (qobject_type(obj) != QTYPE_QDICT) {
259 qerror_abort(qerr, "'data' key value should be a QDICT");
260 }
261}
262
263static void qerror_set_desc(QError *qerr, const char *fmt)
264{
265 int i;
266
267 // FIXME: inefficient loop
268
269 for (i = 0; qerror_table[i].error_fmt; i++) {
270 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
271 qerr->entry = &qerror_table[i];
272 return;
273 }
274 }
275
276 qerror_abort(qerr, "error format '%s' not found", fmt);
277}
278
279/**
280 * qerror_from_info(): Create a new QError from error information
281 *
282 * The information consists of:
283 *
284 * - file the file name of where the error occurred
285 * - linenr the line number of where the error occurred
286 * - func the function name of where the error occurred
287 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
288 * 'data'
289 * - va va_list of all arguments specified by fmt
290 *
291 * Return strong reference.
292 */
293QError *qerror_from_info(const char *file, int linenr, const char *func,
294 const char *fmt, va_list *va)
295{
296 QError *qerr;
297
298 qerr = qerror_new();
Markus Armbruster827b0812010-02-18 19:46:49 +0100299 loc_save(&qerr->loc);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200300 qerr->linenr = linenr;
301 qerr->file = file;
302 qerr->func = func;
303
304 if (!fmt) {
305 qerror_abort(qerr, "QDict not specified");
306 }
307
308 qerror_set_data(qerr, fmt, va);
309 qerror_set_desc(qerr, fmt);
310
311 return qerr;
312}
313
314static void parse_error(const QError *qerror, int c)
315{
316 qerror_abort(qerror, "expected '%c' in '%s'", c, qerror->entry->desc);
317}
318
319static const char *append_field(QString *outstr, const QError *qerror,
320 const char *start)
321{
322 QObject *obj;
323 QDict *qdict;
324 QString *key_qs;
325 const char *end, *key;
326
327 if (*start != '%')
328 parse_error(qerror, '%');
329 start++;
330 if (*start != '(')
331 parse_error(qerror, '(');
332 start++;
333
334 end = strchr(start, ')');
335 if (!end)
336 parse_error(qerror, ')');
337
338 key_qs = qstring_from_substr(start, 0, end - start - 1);
339 key = qstring_get_str(key_qs);
340
341 qdict = qobject_to_qdict(qdict_get(qerror->error, "data"));
342 obj = qdict_get(qdict, key);
343 if (!obj) {
344 qerror_abort(qerror, "key '%s' not found in QDict", key);
345 }
346
347 switch (qobject_type(obj)) {
348 case QTYPE_QSTRING:
349 qstring_append(outstr, qdict_get_str(qdict, key));
350 break;
351 case QTYPE_QINT:
352 qstring_append_int(outstr, qdict_get_int(qdict, key));
353 break;
354 default:
355 qerror_abort(qerror, "invalid type '%c'", qobject_type(obj));
356 }
357
358 QDECREF(key_qs);
359 return ++end;
360}
361
362/**
Markus Armbruster77e595e2009-12-07 21:37:16 +0100363 * qerror_human(): Format QError data into human-readable string.
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200364 *
Markus Armbruster77e595e2009-12-07 21:37:16 +0100365 * Formats according to member 'desc' of the specified QError object.
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200366 */
Markus Armbruster77e595e2009-12-07 21:37:16 +0100367QString *qerror_human(const QError *qerror)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200368{
369 const char *p;
370 QString *qstring;
371
372 assert(qerror->entry != NULL);
373
374 qstring = qstring_new();
375
376 for (p = qerror->entry->desc; *p != '\0';) {
377 if (*p != '%') {
378 qstring_append_chr(qstring, *p++);
379 } else if (*(p + 1) == '%') {
380 qstring_append_chr(qstring, '%');
381 p += 2;
382 } else {
383 p = append_field(qstring, qerror, p);
384 }
385 }
386
Markus Armbruster77e595e2009-12-07 21:37:16 +0100387 return qstring;
388}
389
390/**
391 * qerror_print(): Print QError data
392 *
393 * This function will print the member 'desc' of the specified QError object,
Markus Armbruster1ecda022010-02-18 17:25:24 +0100394 * it uses error_report() for this, so that the output is routed to the right
Markus Armbruster77e595e2009-12-07 21:37:16 +0100395 * place (ie. stderr or Monitor's device).
396 */
Markus Armbruster827b0812010-02-18 19:46:49 +0100397void qerror_print(QError *qerror)
Markus Armbruster77e595e2009-12-07 21:37:16 +0100398{
399 QString *qstring = qerror_human(qerror);
Markus Armbruster827b0812010-02-18 19:46:49 +0100400 loc_push_restore(&qerror->loc);
Markus Armbruster1ecda022010-02-18 17:25:24 +0100401 error_report("%s", qstring_get_str(qstring));
Markus Armbruster827b0812010-02-18 19:46:49 +0100402 loc_pop(&qerror->loc);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200403 QDECREF(qstring);
404}
405
Markus Armbruster0167f772010-03-22 10:29:05 +0100406void qerror_report_internal(const char *file, int linenr, const char *func,
407 const char *fmt, ...)
408{
409 va_list va;
410 QError *qerror;
411
412 va_start(va, fmt);
413 qerror = qerror_from_info(file, linenr, func, fmt, &va);
414 va_end(va);
415
416 if (monitor_cur_is_qmp()) {
417 monitor_set_error(cur_mon, qerror);
418 } else {
419 qerror_print(qerror);
420 QDECREF(qerror);
421 }
422}
423
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200424/**
425 * qobject_to_qerror(): Convert a QObject into a QError
426 */
427QError *qobject_to_qerror(const QObject *obj)
428{
429 if (qobject_type(obj) != QTYPE_QERROR) {
430 return NULL;
431 }
432
433 return container_of(obj, QError, base);
434}
435
436/**
437 * qerror_destroy_obj(): Free all memory allocated by a QError
438 */
439static void qerror_destroy_obj(QObject *obj)
440{
441 QError *qerr;
442
443 assert(obj != NULL);
444 qerr = qobject_to_qerror(obj);
445
446 QDECREF(qerr->error);
447 qemu_free(qerr);
448}