4 * Copyright (C) 2009 Red Hat Inc.
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.
16 #include "qemu-common.h"
18 static void qerror_destroy_obj(QObject
*obj
);
20 static const QType qerror_type
= {
22 .destroy
= qerror_destroy_obj
,
26 * The 'desc' parameter is a printf-like string, the format of the format
31 * Where KEY is a QDict key, which has to be passed to qerror_from_info().
35 * "foo error on device: %(device) slot: %(slot_nr)"
37 * A single percent sign can be printed if followed by a second one,
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"
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_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
53 .desc
= "Block format '%(format)' used by device '%(name)' does not support feature '%(feature)'",
56 .error_fmt
= QERR_BUS_NOT_FOUND
,
57 .desc
= "Bus '%(bus)' not found",
60 .error_fmt
= QERR_BUS_NO_HOTPLUG
,
61 .desc
= "Bus '%(bus)' does not support hotplugging",
64 .error_fmt
= QERR_COMMAND_NOT_FOUND
,
65 .desc
= "The command %(name) has not been found",
68 .error_fmt
= QERR_COMMAND_DISABLED
,
69 .desc
= "The command %(name) has been disabled for this instance",
72 .error_fmt
= QERR_DEVICE_ENCRYPTED
,
73 .desc
= "Device '%(device)' is encrypted",
76 .error_fmt
= QERR_DEVICE_INIT_FAILED
,
77 .desc
= "Device '%(device)' could not be initialized",
80 .error_fmt
= QERR_DEVICE_IN_USE
,
81 .desc
= "Device '%(device)' is in use",
84 .error_fmt
= QERR_DEVICE_FEATURE_BLOCKS_MIGRATION
,
85 .desc
= "Migration is disabled when using feature '%(feature)' in device '%(device)'",
88 .error_fmt
= QERR_DEVICE_LOCKED
,
89 .desc
= "Device '%(device)' is locked",
92 .error_fmt
= QERR_DEVICE_MULTIPLE_BUSSES
,
93 .desc
= "Device '%(device)' has multiple child busses",
96 .error_fmt
= QERR_DEVICE_NOT_ACTIVE
,
97 .desc
= "Device '%(device)' has not been activated",
100 .error_fmt
= QERR_DEVICE_NOT_ENCRYPTED
,
101 .desc
= "Device '%(device)' is not encrypted",
104 .error_fmt
= QERR_DEVICE_NOT_FOUND
,
105 .desc
= "Device '%(device)' not found",
108 .error_fmt
= QERR_DEVICE_NOT_REMOVABLE
,
109 .desc
= "Device '%(device)' is not removable",
112 .error_fmt
= QERR_DEVICE_NO_BUS
,
113 .desc
= "Device '%(device)' has no child bus",
116 .error_fmt
= QERR_DEVICE_NO_HOTPLUG
,
117 .desc
= "Device '%(device)' does not support hotplugging",
120 .error_fmt
= QERR_DUPLICATE_ID
,
121 .desc
= "Duplicate ID '%(id)' for %(object)",
124 .error_fmt
= QERR_FD_NOT_FOUND
,
125 .desc
= "File descriptor named '%(name)' not found",
128 .error_fmt
= QERR_FD_NOT_SUPPLIED
,
129 .desc
= "No file descriptor supplied via SCM_RIGHTS",
132 .error_fmt
= QERR_FEATURE_DISABLED
,
133 .desc
= "The feature '%(name)' is not enabled",
136 .error_fmt
= QERR_INVALID_BLOCK_FORMAT
,
137 .desc
= "Invalid block format '%(name)'",
140 .error_fmt
= QERR_INVALID_PARAMETER
,
141 .desc
= "Invalid parameter '%(name)'",
144 .error_fmt
= QERR_INVALID_PARAMETER_TYPE
,
145 .desc
= "Invalid parameter type, expected: %(expected)",
148 .error_fmt
= QERR_INVALID_PARAMETER_VALUE
,
149 .desc
= "Parameter '%(name)' expects %(expected)",
152 .error_fmt
= QERR_INVALID_PASSWORD
,
153 .desc
= "Password incorrect",
156 .error_fmt
= QERR_IO_ERROR
,
157 .desc
= "An IO error has occurred",
160 .error_fmt
= QERR_JSON_PARSING
,
161 .desc
= "Invalid JSON syntax",
164 .error_fmt
= QERR_JSON_PARSE_ERROR
,
165 .desc
= "JSON parse error, %(message)",
169 .error_fmt
= QERR_KVM_MISSING_CAP
,
170 .desc
= "Using KVM without %(capability), %(feature) unavailable",
173 .error_fmt
= QERR_MIGRATION_EXPECTED
,
174 .desc
= "An incoming migration is expected before this command can be executed",
177 .error_fmt
= QERR_MISSING_PARAMETER
,
178 .desc
= "Parameter '%(name)' is missing",
181 .error_fmt
= QERR_NO_BUS_FOR_DEVICE
,
182 .desc
= "No '%(bus)' bus found for device '%(device)'",
185 .error_fmt
= QERR_OPEN_FILE_FAILED
,
186 .desc
= "Could not open '%(filename)'",
189 .error_fmt
= QERR_PROPERTY_NOT_FOUND
,
190 .desc
= "Property '%(device).%(property)' not found",
193 .error_fmt
= QERR_PROPERTY_VALUE_BAD
,
194 .desc
= "Property '%(device).%(property)' doesn't take value '%(value)'",
197 .error_fmt
= QERR_PROPERTY_VALUE_IN_USE
,
198 .desc
= "Property '%(device).%(property)' can't take value '%(value)', it's in use",
201 .error_fmt
= QERR_PROPERTY_VALUE_NOT_FOUND
,
202 .desc
= "Property '%(device).%(property)' can't find value '%(value)'",
205 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT
,
206 .desc
= "Expected '%(expected)' in QMP input",
209 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT_MEMBER
,
210 .desc
= "QMP input object member '%(member)' expects '%(expected)'",
213 .error_fmt
= QERR_QMP_EXTRA_MEMBER
,
214 .desc
= "QMP input object member '%(member)' is unexpected",
217 .error_fmt
= QERR_RESET_REQUIRED
,
218 .desc
= "Resetting the Virtual Machine is required",
221 .error_fmt
= QERR_SET_PASSWD_FAILED
,
222 .desc
= "Could not set password",
225 .error_fmt
= QERR_ADD_CLIENT_FAILED
,
226 .desc
= "Could not add client",
229 .error_fmt
= QERR_TOO_MANY_FILES
,
230 .desc
= "Too many open files",
233 .error_fmt
= QERR_UNDEFINED_ERROR
,
234 .desc
= "An undefined error has occurred",
237 .error_fmt
= QERR_UNSUPPORTED
,
238 .desc
= "this feature or command is not currently supported",
241 .error_fmt
= QERR_UNKNOWN_BLOCK_FORMAT_FEATURE
,
242 .desc
= "'%(device)' uses a %(format) feature which is not "
243 "supported by this qemu version: %(feature)",
246 .error_fmt
= QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION
,
247 .desc
= "Migration is disabled when VirtFS export path '%(path)' "
248 "is mounted in the guest using mount_tag '%(tag)'",
251 .error_fmt
= QERR_VNC_SERVER_FAILED
,
252 .desc
= "Could not start VNC server on %(target)",
255 .error_fmt
= QERR_QGA_LOGGING_FAILED
,
256 .desc
= "Guest agent failed to log non-optional log statement",
259 .error_fmt
= QERR_QGA_COMMAND_FAILED
,
260 .desc
= "Guest agent command failed, error was '%(message)'",
263 .error_fmt
= QERR_INVALID_PARAMETER_COMBINATION
,
264 .desc
= "Invalid paramter combination",
270 * qerror_new(): Create a new QError
272 * Return strong reference.
274 QError
*qerror_new(void)
278 qerr
= g_malloc0(sizeof(*qerr
));
279 QOBJECT_INIT(qerr
, &qerror_type
);
284 static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError
*qerr
,
285 const char *fmt
, ...)
289 fprintf(stderr
, "qerror: bad call in function '%s':\n", qerr
->func
);
290 fprintf(stderr
, "qerror: -> ");
293 vfprintf(stderr
, fmt
, ap
);
296 fprintf(stderr
, "\nqerror: call at %s:%d\n", qerr
->file
, qerr
->linenr
);
300 static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError
*qerr
,
301 const char *fmt
, va_list *va
)
305 obj
= qobject_from_jsonv(fmt
, va
);
307 qerror_abort(qerr
, "invalid format '%s'", fmt
);
309 if (qobject_type(obj
) != QTYPE_QDICT
) {
310 qerror_abort(qerr
, "error format is not a QDict '%s'", fmt
);
313 qerr
->error
= qobject_to_qdict(obj
);
315 obj
= qdict_get(qerr
->error
, "class");
317 qerror_abort(qerr
, "missing 'class' key in '%s'", fmt
);
319 if (qobject_type(obj
) != QTYPE_QSTRING
) {
320 qerror_abort(qerr
, "'class' key value should be a QString");
323 obj
= qdict_get(qerr
->error
, "data");
325 qerror_abort(qerr
, "missing 'data' key in '%s'", fmt
);
327 if (qobject_type(obj
) != QTYPE_QDICT
) {
328 qerror_abort(qerr
, "'data' key value should be a QDICT");
332 static void qerror_set_desc(QError
*qerr
, const char *fmt
)
336 // FIXME: inefficient loop
338 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
339 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
340 qerr
->entry
= &qerror_table
[i
];
345 qerror_abort(qerr
, "error format '%s' not found", fmt
);
349 * qerror_from_info(): Create a new QError from error information
351 * The information consists of:
353 * - file the file name of where the error occurred
354 * - linenr the line number of where the error occurred
355 * - func the function name of where the error occurred
356 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
358 * - va va_list of all arguments specified by fmt
360 * Return strong reference.
362 QError
*qerror_from_info(const char *file
, int linenr
, const char *func
,
363 const char *fmt
, va_list *va
)
368 loc_save(&qerr
->loc
);
369 qerr
->linenr
= linenr
;
374 qerror_abort(qerr
, "QDict not specified");
377 qerror_set_data(qerr
, fmt
, va
);
378 qerror_set_desc(qerr
, fmt
);
383 static void parse_error(const QErrorStringTable
*entry
, int c
)
385 fprintf(stderr
, "expected '%c' in '%s'", c
, entry
->desc
);
389 static const char *append_field(QDict
*error
, QString
*outstr
,
390 const QErrorStringTable
*entry
,
396 const char *end
, *key
;
399 parse_error(entry
, '%');
402 parse_error(entry
, '(');
405 end
= strchr(start
, ')');
407 parse_error(entry
, ')');
409 key_qs
= qstring_from_substr(start
, 0, end
- start
- 1);
410 key
= qstring_get_str(key_qs
);
412 qdict
= qobject_to_qdict(qdict_get(error
, "data"));
413 obj
= qdict_get(qdict
, key
);
418 switch (qobject_type(obj
)) {
420 qstring_append(outstr
, qdict_get_str(qdict
, key
));
423 qstring_append_int(outstr
, qdict_get_int(qdict
, key
));
433 static QString
*qerror_format_desc(QDict
*error
,
434 const QErrorStringTable
*entry
)
439 assert(entry
!= NULL
);
441 qstring
= qstring_new();
443 for (p
= entry
->desc
; *p
!= '\0';) {
445 qstring_append_chr(qstring
, *p
++);
446 } else if (*(p
+ 1) == '%') {
447 qstring_append_chr(qstring
, '%');
450 p
= append_field(error
, qstring
, entry
, p
);
457 QString
*qerror_format(const char *fmt
, QDict
*error
)
459 const QErrorStringTable
*entry
= NULL
;
462 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
463 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
464 entry
= &qerror_table
[i
];
469 return qerror_format_desc(error
, entry
);
473 * qerror_human(): Format QError data into human-readable string.
475 QString
*qerror_human(const QError
*qerror
)
477 return qerror_format_desc(qerror
->error
, qerror
->entry
);
481 * qerror_print(): Print QError data
483 * This function will print the member 'desc' of the specified QError object,
484 * it uses error_report() for this, so that the output is routed to the right
485 * place (ie. stderr or Monitor's device).
487 void qerror_print(QError
*qerror
)
489 QString
*qstring
= qerror_human(qerror
);
490 loc_push_restore(&qerror
->loc
);
491 error_report("%s", qstring_get_str(qstring
));
492 loc_pop(&qerror
->loc
);
496 void qerror_report_internal(const char *file
, int linenr
, const char *func
,
497 const char *fmt
, ...)
503 qerror
= qerror_from_info(file
, linenr
, func
, fmt
, &va
);
506 if (monitor_cur_is_qmp()) {
507 monitor_set_error(cur_mon
, qerror
);
509 qerror_print(qerror
);
522 void qerror_report_err(Error
*err
)
528 loc_save(&qerr
->loc
);
530 qerr
->error
= err
->obj
;
532 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
533 if (strcmp(qerror_table
[i
].error_fmt
, err
->fmt
) == 0) {
534 qerr
->entry
= &qerror_table
[i
];
539 if (monitor_cur_is_qmp()) {
540 monitor_set_error(cur_mon
, qerr
);
548 * qobject_to_qerror(): Convert a QObject into a QError
550 QError
*qobject_to_qerror(const QObject
*obj
)
552 if (qobject_type(obj
) != QTYPE_QERROR
) {
556 return container_of(obj
, QError
, base
);
560 * qerror_destroy_obj(): Free all memory allocated by a QError
562 static void qerror_destroy_obj(QObject
*obj
)
567 qerr
= qobject_to_qerror(obj
);
569 QDECREF(qerr
->error
);