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_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_FEATURE_BLOCKS_MIGRATION
,
77 .desc
= "Migration is disabled when using feature '%(feature)' in device '%(device)'",
80 .error_fmt
= QERR_DEVICE_LOCKED
,
81 .desc
= "Device '%(device)' is locked",
84 .error_fmt
= QERR_DEVICE_MULTIPLE_BUSSES
,
85 .desc
= "Device '%(device)' has multiple child busses",
88 .error_fmt
= QERR_DEVICE_NOT_ACTIVE
,
89 .desc
= "Device '%(device)' has not been activated",
92 .error_fmt
= QERR_DEVICE_NOT_ENCRYPTED
,
93 .desc
= "Device '%(device)' is not encrypted",
96 .error_fmt
= QERR_DEVICE_NOT_FOUND
,
97 .desc
= "Device '%(device)' not found",
100 .error_fmt
= QERR_DEVICE_NOT_REMOVABLE
,
101 .desc
= "Device '%(device)' is not removable",
104 .error_fmt
= QERR_DEVICE_NO_BUS
,
105 .desc
= "Device '%(device)' has no child bus",
108 .error_fmt
= QERR_DEVICE_NO_HOTPLUG
,
109 .desc
= "Device '%(device)' does not support hotplugging",
112 .error_fmt
= QERR_DUPLICATE_ID
,
113 .desc
= "Duplicate ID '%(id)' for %(object)",
116 .error_fmt
= QERR_FD_NOT_FOUND
,
117 .desc
= "File descriptor named '%(name)' not found",
120 .error_fmt
= QERR_FD_NOT_SUPPLIED
,
121 .desc
= "No file descriptor supplied via SCM_RIGHTS",
124 .error_fmt
= QERR_FEATURE_DISABLED
,
125 .desc
= "The feature '%(name)' is not enabled",
128 .error_fmt
= QERR_INVALID_BLOCK_FORMAT
,
129 .desc
= "Invalid block format '%(name)'",
132 .error_fmt
= QERR_INVALID_PARAMETER
,
133 .desc
= "Invalid parameter '%(name)'",
136 .error_fmt
= QERR_INVALID_PARAMETER_TYPE
,
137 .desc
= "Invalid parameter type, expected: %(expected)",
140 .error_fmt
= QERR_INVALID_PARAMETER_VALUE
,
141 .desc
= "Parameter '%(name)' expects %(expected)",
144 .error_fmt
= QERR_INVALID_PASSWORD
,
145 .desc
= "Password incorrect",
148 .error_fmt
= QERR_JSON_PARSING
,
149 .desc
= "Invalid JSON syntax",
152 .error_fmt
= QERR_JSON_PARSE_ERROR
,
153 .desc
= "JSON parse error, %(message)",
157 .error_fmt
= QERR_KVM_MISSING_CAP
,
158 .desc
= "Using KVM without %(capability), %(feature) unavailable",
161 .error_fmt
= QERR_MIGRATION_EXPECTED
,
162 .desc
= "An incoming migration is expected before this command can be executed",
165 .error_fmt
= QERR_MISSING_PARAMETER
,
166 .desc
= "Parameter '%(name)' is missing",
169 .error_fmt
= QERR_NO_BUS_FOR_DEVICE
,
170 .desc
= "No '%(bus)' bus found for device '%(device)'",
173 .error_fmt
= QERR_OPEN_FILE_FAILED
,
174 .desc
= "Could not open '%(filename)'",
177 .error_fmt
= QERR_PROPERTY_NOT_FOUND
,
178 .desc
= "Property '%(device).%(property)' not found",
181 .error_fmt
= QERR_PROPERTY_VALUE_BAD
,
182 .desc
= "Property '%(device).%(property)' doesn't take value '%(value)'",
185 .error_fmt
= QERR_PROPERTY_VALUE_IN_USE
,
186 .desc
= "Property '%(device).%(property)' can't take value '%(value)', it's in use",
189 .error_fmt
= QERR_PROPERTY_VALUE_NOT_FOUND
,
190 .desc
= "Property '%(device).%(property)' can't find value '%(value)'",
193 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT
,
194 .desc
= "Expected '%(expected)' in QMP input",
197 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT_MEMBER
,
198 .desc
= "QMP input object member '%(member)' expects '%(expected)'",
201 .error_fmt
= QERR_QMP_EXTRA_MEMBER
,
202 .desc
= "QMP input object member '%(member)' is unexpected",
205 .error_fmt
= QERR_RESET_REQUIRED
,
206 .desc
= "Resetting the Virtual Machine is required",
209 .error_fmt
= QERR_SET_PASSWD_FAILED
,
210 .desc
= "Could not set password",
213 .error_fmt
= QERR_ADD_CLIENT_FAILED
,
214 .desc
= "Could not add client",
217 .error_fmt
= QERR_TOO_MANY_FILES
,
218 .desc
= "Too many open files",
221 .error_fmt
= QERR_UNDEFINED_ERROR
,
222 .desc
= "An undefined error has ocurred",
225 .error_fmt
= QERR_UNSUPPORTED
,
226 .desc
= "this feature or command is not currently supported",
229 .error_fmt
= QERR_UNKNOWN_BLOCK_FORMAT_FEATURE
,
230 .desc
= "'%(device)' uses a %(format) feature which is not "
231 "supported by this qemu version: %(feature)",
234 .error_fmt
= QERR_VNC_SERVER_FAILED
,
235 .desc
= "Could not start VNC server on %(target)",
238 .error_fmt
= QERR_QGA_LOGGING_FAILED
,
239 .desc
= "Guest agent failed to log non-optional log statement",
242 .error_fmt
= QERR_QGA_COMMAND_FAILED
,
243 .desc
= "Guest agent command failed, error was '%(message)'",
249 * qerror_new(): Create a new QError
251 * Return strong reference.
253 QError
*qerror_new(void)
257 qerr
= g_malloc0(sizeof(*qerr
));
258 QOBJECT_INIT(qerr
, &qerror_type
);
263 static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError
*qerr
,
264 const char *fmt
, ...)
268 fprintf(stderr
, "qerror: bad call in function '%s':\n", qerr
->func
);
269 fprintf(stderr
, "qerror: -> ");
272 vfprintf(stderr
, fmt
, ap
);
275 fprintf(stderr
, "\nqerror: call at %s:%d\n", qerr
->file
, qerr
->linenr
);
279 static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError
*qerr
,
280 const char *fmt
, va_list *va
)
284 obj
= qobject_from_jsonv(fmt
, va
);
286 qerror_abort(qerr
, "invalid format '%s'", fmt
);
288 if (qobject_type(obj
) != QTYPE_QDICT
) {
289 qerror_abort(qerr
, "error format is not a QDict '%s'", fmt
);
292 qerr
->error
= qobject_to_qdict(obj
);
294 obj
= qdict_get(qerr
->error
, "class");
296 qerror_abort(qerr
, "missing 'class' key in '%s'", fmt
);
298 if (qobject_type(obj
) != QTYPE_QSTRING
) {
299 qerror_abort(qerr
, "'class' key value should be a QString");
302 obj
= qdict_get(qerr
->error
, "data");
304 qerror_abort(qerr
, "missing 'data' key in '%s'", fmt
);
306 if (qobject_type(obj
) != QTYPE_QDICT
) {
307 qerror_abort(qerr
, "'data' key value should be a QDICT");
311 static void qerror_set_desc(QError
*qerr
, const char *fmt
)
315 // FIXME: inefficient loop
317 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
318 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
319 qerr
->entry
= &qerror_table
[i
];
324 qerror_abort(qerr
, "error format '%s' not found", fmt
);
328 * qerror_from_info(): Create a new QError from error information
330 * The information consists of:
332 * - file the file name of where the error occurred
333 * - linenr the line number of where the error occurred
334 * - func the function name of where the error occurred
335 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
337 * - va va_list of all arguments specified by fmt
339 * Return strong reference.
341 QError
*qerror_from_info(const char *file
, int linenr
, const char *func
,
342 const char *fmt
, va_list *va
)
347 loc_save(&qerr
->loc
);
348 qerr
->linenr
= linenr
;
353 qerror_abort(qerr
, "QDict not specified");
356 qerror_set_data(qerr
, fmt
, va
);
357 qerror_set_desc(qerr
, fmt
);
362 static void parse_error(const QErrorStringTable
*entry
, int c
)
364 fprintf(stderr
, "expected '%c' in '%s'", c
, entry
->desc
);
368 static const char *append_field(QDict
*error
, QString
*outstr
,
369 const QErrorStringTable
*entry
,
375 const char *end
, *key
;
378 parse_error(entry
, '%');
381 parse_error(entry
, '(');
384 end
= strchr(start
, ')');
386 parse_error(entry
, ')');
388 key_qs
= qstring_from_substr(start
, 0, end
- start
- 1);
389 key
= qstring_get_str(key_qs
);
391 qdict
= qobject_to_qdict(qdict_get(error
, "data"));
392 obj
= qdict_get(qdict
, key
);
397 switch (qobject_type(obj
)) {
399 qstring_append(outstr
, qdict_get_str(qdict
, key
));
402 qstring_append_int(outstr
, qdict_get_int(qdict
, key
));
412 static QString
*qerror_format_desc(QDict
*error
,
413 const QErrorStringTable
*entry
)
418 assert(entry
!= NULL
);
420 qstring
= qstring_new();
422 for (p
= entry
->desc
; *p
!= '\0';) {
424 qstring_append_chr(qstring
, *p
++);
425 } else if (*(p
+ 1) == '%') {
426 qstring_append_chr(qstring
, '%');
429 p
= append_field(error
, qstring
, entry
, p
);
436 QString
*qerror_format(const char *fmt
, QDict
*error
)
438 const QErrorStringTable
*entry
= NULL
;
441 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
442 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
443 entry
= &qerror_table
[i
];
448 return qerror_format_desc(error
, entry
);
452 * qerror_human(): Format QError data into human-readable string.
454 QString
*qerror_human(const QError
*qerror
)
456 return qerror_format_desc(qerror
->error
, qerror
->entry
);
460 * qerror_print(): Print QError data
462 * This function will print the member 'desc' of the specified QError object,
463 * it uses error_report() for this, so that the output is routed to the right
464 * place (ie. stderr or Monitor's device).
466 void qerror_print(QError
*qerror
)
468 QString
*qstring
= qerror_human(qerror
);
469 loc_push_restore(&qerror
->loc
);
470 error_report("%s", qstring_get_str(qstring
));
471 loc_pop(&qerror
->loc
);
475 void qerror_report_internal(const char *file
, int linenr
, const char *func
,
476 const char *fmt
, ...)
482 qerror
= qerror_from_info(file
, linenr
, func
, fmt
, &va
);
485 if (monitor_cur_is_qmp()) {
486 monitor_set_error(cur_mon
, qerror
);
488 qerror_print(qerror
);
501 void qerror_report_err(Error
*err
)
507 loc_save(&qerr
->loc
);
509 qerr
->error
= err
->obj
;
511 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
512 if (strcmp(qerror_table
[i
].error_fmt
, err
->fmt
) == 0) {
513 qerr
->entry
= &qerror_table
[i
];
518 if (monitor_cur_is_qmp()) {
519 monitor_set_error(cur_mon
, qerr
);
527 * qobject_to_qerror(): Convert a QObject into a QError
529 QError
*qobject_to_qerror(const QObject
*obj
)
531 if (qobject_type(obj
) != QTYPE_QERROR
) {
535 return container_of(obj
, QError
, base
);
539 * qerror_destroy_obj(): Free all memory allocated by a QError
541 static void qerror_destroy_obj(QObject
*obj
)
546 qerr
= qobject_to_qerror(obj
);
548 QDECREF(qerr
->error
);