vmdk: vmdk_read_cid returns garbage if p_name is NULL
[qemu/ar7.git] / qerror.c
blob68998d4bab9b4b1c7a5063f79b0869805616e954
1 /*
2 * QError Module
4 * Copyright (C) 2009 Red Hat Inc.
6 * Authors:
7 * Luiz Capitulino <lcapitulino@redhat.com>
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.
13 #include "monitor.h"
14 #include "qjson.h"
15 #include "qerror.h"
16 #include "qemu-common.h"
18 static void qerror_destroy_obj(QObject *obj);
20 static const QType qerror_type = {
21 .code = QTYPE_QERROR,
22 .destroy = qerror_destroy_obj,
25 /**
26 * The 'desc' parameter is a printf-like string, the format of the format
27 * string is:
29 * %(KEY)
31 * Where KEY is a QDict key, which has to be passed to qerror_from_info().
33 * Example:
35 * "foo error on device: %(device) slot: %(slot_nr)"
37 * A single percent sign can be printed if followed by a second one,
38 * for example:
40 * "running out of foo: %(foo)%%"
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.
46 static const QErrorStringTable qerror_table[] = {
48 .error_fmt = QERR_BAD_BUS_FOR_DEVICE,
49 .desc = "Device '%(device)' can't go on a %(bad_bus_type) bus",
52 .error_fmt = QERR_BUS_NOT_FOUND,
53 .desc = "Bus '%(bus)' not found",
56 .error_fmt = QERR_BUS_NO_HOTPLUG,
57 .desc = "Bus '%(bus)' does not support hotplugging",
60 .error_fmt = QERR_COMMAND_NOT_FOUND,
61 .desc = "The command %(name) has not been found",
64 .error_fmt = QERR_DEVICE_ENCRYPTED,
65 .desc = "Device '%(device)' is encrypted",
68 .error_fmt = QERR_DEVICE_INIT_FAILED,
69 .desc = "Device '%(device)' could not be initialized",
72 .error_fmt = QERR_DEVICE_IN_USE,
73 .desc = "Device '%(device)' is in use",
76 .error_fmt = QERR_DEVICE_LOCKED,
77 .desc = "Device '%(device)' is locked",
80 .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
81 .desc = "Device '%(device)' has multiple child busses",
84 .error_fmt = QERR_DEVICE_NOT_ACTIVE,
85 .desc = "Device '%(device)' has not been activated",
88 .error_fmt = QERR_DEVICE_NOT_ENCRYPTED,
89 .desc = "Device '%(device)' is not encrypted",
92 .error_fmt = QERR_DEVICE_NOT_FOUND,
93 .desc = "Device '%(device)' not found",
96 .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
97 .desc = "Device '%(device)' is not removable",
100 .error_fmt = QERR_DEVICE_NO_BUS,
101 .desc = "Device '%(device)' has no child bus",
104 .error_fmt = QERR_DEVICE_NO_HOTPLUG,
105 .desc = "Device '%(device)' does not support hotplugging",
108 .error_fmt = QERR_DUPLICATE_ID,
109 .desc = "Duplicate ID '%(id)' for %(object)",
112 .error_fmt = QERR_FD_NOT_FOUND,
113 .desc = "File descriptor named '%(name)' not found",
116 .error_fmt = QERR_FD_NOT_SUPPLIED,
117 .desc = "No file descriptor supplied via SCM_RIGHTS",
120 .error_fmt = QERR_INVALID_BLOCK_FORMAT,
121 .desc = "Invalid block format '%(name)'",
124 .error_fmt = QERR_INVALID_PARAMETER,
125 .desc = "Invalid parameter '%(name)'",
128 .error_fmt = QERR_INVALID_PARAMETER_TYPE,
129 .desc = "Invalid parameter type, expected: %(expected)",
132 .error_fmt = QERR_INVALID_PARAMETER_VALUE,
133 .desc = "Parameter '%(name)' expects %(expected)",
136 .error_fmt = QERR_INVALID_PASSWORD,
137 .desc = "Password incorrect",
140 .error_fmt = QERR_JSON_PARSING,
141 .desc = "Invalid JSON syntax",
144 .error_fmt = QERR_JSON_PARSE_ERROR,
145 .desc = "JSON parse error, %(message)",
149 .error_fmt = QERR_KVM_MISSING_CAP,
150 .desc = "Using KVM without %(capability), %(feature) unavailable",
153 .error_fmt = QERR_MIGRATION_EXPECTED,
154 .desc = "An incoming migration is expected before this command can be executed",
157 .error_fmt = QERR_MISSING_PARAMETER,
158 .desc = "Parameter '%(name)' is missing",
161 .error_fmt = QERR_NO_BUS_FOR_DEVICE,
162 .desc = "No '%(bus)' bus found for device '%(device)'",
165 .error_fmt = QERR_OPEN_FILE_FAILED,
166 .desc = "Could not open '%(filename)'",
169 .error_fmt = QERR_PROPERTY_NOT_FOUND,
170 .desc = "Property '%(device).%(property)' not found",
173 .error_fmt = QERR_PROPERTY_VALUE_BAD,
174 .desc = "Property '%(device).%(property)' doesn't take value '%(value)'",
177 .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
178 .desc = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
181 .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
182 .desc = "Property '%(device).%(property)' can't find value '%(value)'",
185 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
186 .desc = "Expected '%(expected)' in QMP input",
189 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
190 .desc = "QMP input object member '%(member)' expects '%(expected)'",
193 .error_fmt = QERR_QMP_EXTRA_MEMBER,
194 .desc = "QMP input object member '%(member)' is unexpected",
197 .error_fmt = QERR_RESET_REQUIRED,
198 .desc = "Resetting the Virtual Machine is required",
201 .error_fmt = QERR_SET_PASSWD_FAILED,
202 .desc = "Could not set password",
205 .error_fmt = QERR_ADD_CLIENT_FAILED,
206 .desc = "Could not add client",
209 .error_fmt = QERR_TOO_MANY_FILES,
210 .desc = "Too many open files",
213 .error_fmt = QERR_UNDEFINED_ERROR,
214 .desc = "An undefined error has ocurred",
217 .error_fmt = QERR_UNSUPPORTED,
218 .desc = "this feature or command is not currently supported",
221 .error_fmt = QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
222 .desc = "'%(device)' uses a %(format) feature which is not "
223 "supported by this qemu version: %(feature)",
226 .error_fmt = QERR_VNC_SERVER_FAILED,
227 .desc = "Could not start VNC server on %(target)",
230 .error_fmt = QERR_QGA_LOGGING_FAILED,
231 .desc = "Guest agent failed to log non-optional log statement",
234 .error_fmt = QERR_QGA_COMMAND_FAILED,
235 .desc = "Guest agent command failed, error was '%(message)'",
241 * qerror_new(): Create a new QError
243 * Return strong reference.
245 QError *qerror_new(void)
247 QError *qerr;
249 qerr = g_malloc0(sizeof(*qerr));
250 QOBJECT_INIT(qerr, &qerror_type);
252 return qerr;
255 static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr,
256 const char *fmt, ...)
258 va_list ap;
260 fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
261 fprintf(stderr, "qerror: -> ");
263 va_start(ap, fmt);
264 vfprintf(stderr, fmt, ap);
265 va_end(ap);
267 fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
268 abort();
271 static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr,
272 const char *fmt, va_list *va)
274 QObject *obj;
276 obj = qobject_from_jsonv(fmt, va);
277 if (!obj) {
278 qerror_abort(qerr, "invalid format '%s'", fmt);
280 if (qobject_type(obj) != QTYPE_QDICT) {
281 qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
284 qerr->error = qobject_to_qdict(obj);
286 obj = qdict_get(qerr->error, "class");
287 if (!obj) {
288 qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
290 if (qobject_type(obj) != QTYPE_QSTRING) {
291 qerror_abort(qerr, "'class' key value should be a QString");
294 obj = qdict_get(qerr->error, "data");
295 if (!obj) {
296 qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
298 if (qobject_type(obj) != QTYPE_QDICT) {
299 qerror_abort(qerr, "'data' key value should be a QDICT");
303 static void qerror_set_desc(QError *qerr, const char *fmt)
305 int i;
307 // FIXME: inefficient loop
309 for (i = 0; qerror_table[i].error_fmt; i++) {
310 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
311 qerr->entry = &qerror_table[i];
312 return;
316 qerror_abort(qerr, "error format '%s' not found", fmt);
320 * qerror_from_info(): Create a new QError from error information
322 * The information consists of:
324 * - file the file name of where the error occurred
325 * - linenr the line number of where the error occurred
326 * - func the function name of where the error occurred
327 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
328 * 'data'
329 * - va va_list of all arguments specified by fmt
331 * Return strong reference.
333 QError *qerror_from_info(const char *file, int linenr, const char *func,
334 const char *fmt, va_list *va)
336 QError *qerr;
338 qerr = qerror_new();
339 loc_save(&qerr->loc);
340 qerr->linenr = linenr;
341 qerr->file = file;
342 qerr->func = func;
344 if (!fmt) {
345 qerror_abort(qerr, "QDict not specified");
348 qerror_set_data(qerr, fmt, va);
349 qerror_set_desc(qerr, fmt);
351 return qerr;
354 static void parse_error(const QErrorStringTable *entry, int c)
356 fprintf(stderr, "expected '%c' in '%s'", c, entry->desc);
357 abort();
360 static const char *append_field(QDict *error, QString *outstr,
361 const QErrorStringTable *entry,
362 const char *start)
364 QObject *obj;
365 QDict *qdict;
366 QString *key_qs;
367 const char *end, *key;
369 if (*start != '%')
370 parse_error(entry, '%');
371 start++;
372 if (*start != '(')
373 parse_error(entry, '(');
374 start++;
376 end = strchr(start, ')');
377 if (!end)
378 parse_error(entry, ')');
380 key_qs = qstring_from_substr(start, 0, end - start - 1);
381 key = qstring_get_str(key_qs);
383 qdict = qobject_to_qdict(qdict_get(error, "data"));
384 obj = qdict_get(qdict, key);
385 if (!obj) {
386 abort();
389 switch (qobject_type(obj)) {
390 case QTYPE_QSTRING:
391 qstring_append(outstr, qdict_get_str(qdict, key));
392 break;
393 case QTYPE_QINT:
394 qstring_append_int(outstr, qdict_get_int(qdict, key));
395 break;
396 default:
397 abort();
400 QDECREF(key_qs);
401 return ++end;
404 static QString *qerror_format_desc(QDict *error,
405 const QErrorStringTable *entry)
407 QString *qstring;
408 const char *p;
410 assert(entry != NULL);
412 qstring = qstring_new();
414 for (p = entry->desc; *p != '\0';) {
415 if (*p != '%') {
416 qstring_append_chr(qstring, *p++);
417 } else if (*(p + 1) == '%') {
418 qstring_append_chr(qstring, '%');
419 p += 2;
420 } else {
421 p = append_field(error, qstring, entry, p);
425 return qstring;
428 QString *qerror_format(const char *fmt, QDict *error)
430 const QErrorStringTable *entry = NULL;
431 int i;
433 for (i = 0; qerror_table[i].error_fmt; i++) {
434 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
435 entry = &qerror_table[i];
436 break;
440 return qerror_format_desc(error, entry);
444 * qerror_human(): Format QError data into human-readable string.
446 QString *qerror_human(const QError *qerror)
448 return qerror_format_desc(qerror->error, qerror->entry);
452 * qerror_print(): Print QError data
454 * This function will print the member 'desc' of the specified QError object,
455 * it uses error_report() for this, so that the output is routed to the right
456 * place (ie. stderr or Monitor's device).
458 void qerror_print(QError *qerror)
460 QString *qstring = qerror_human(qerror);
461 loc_push_restore(&qerror->loc);
462 error_report("%s", qstring_get_str(qstring));
463 loc_pop(&qerror->loc);
464 QDECREF(qstring);
467 void qerror_report_internal(const char *file, int linenr, const char *func,
468 const char *fmt, ...)
470 va_list va;
471 QError *qerror;
473 va_start(va, fmt);
474 qerror = qerror_from_info(file, linenr, func, fmt, &va);
475 va_end(va);
477 if (monitor_cur_is_qmp()) {
478 monitor_set_error(cur_mon, qerror);
479 } else {
480 qerror_print(qerror);
481 QDECREF(qerror);
485 /* Evil... */
486 struct Error
488 QDict *obj;
489 const char *fmt;
490 char *msg;
493 void qerror_report_err(Error *err)
495 QError *qerr;
496 int i;
498 qerr = qerror_new();
499 loc_save(&qerr->loc);
500 QINCREF(err->obj);
501 qerr->error = err->obj;
503 for (i = 0; qerror_table[i].error_fmt; i++) {
504 if (strcmp(qerror_table[i].error_fmt, err->fmt) == 0) {
505 qerr->entry = &qerror_table[i];
506 break;
510 if (monitor_cur_is_qmp()) {
511 monitor_set_error(cur_mon, qerr);
512 } else {
513 qerror_print(qerr);
514 QDECREF(qerr);
519 * qobject_to_qerror(): Convert a QObject into a QError
521 QError *qobject_to_qerror(const QObject *obj)
523 if (qobject_type(obj) != QTYPE_QERROR) {
524 return NULL;
527 return container_of(obj, QError, base);
531 * qerror_destroy_obj(): Free all memory allocated by a QError
533 static void qerror_destroy_obj(QObject *obj)
535 QError *qerr;
537 assert(obj != NULL);
538 qerr = qobject_to_qerror(obj);
540 QDECREF(qerr->error);
541 g_free(qerr);