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 scripts/check-qerror.sh to check.
45 static const QErrorStringTable qerror_table
[] = {
47 .error_fmt
= QERR_ADD_CLIENT_FAILED
,
48 .desc
= "Could not add client",
51 .error_fmt
= QERR_AMBIGUOUS_PATH
,
52 .desc
= "Path '%(path)' does not uniquely identify an object"
55 .error_fmt
= QERR_BAD_BUS_FOR_DEVICE
,
56 .desc
= "Device '%(device)' can't go on a %(bad_bus_type) bus",
59 .error_fmt
= QERR_BASE_NOT_FOUND
,
60 .desc
= "Base '%(base)' not found",
63 .error_fmt
= QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED
,
64 .desc
= "Block format '%(format)' used by device '%(name)' does not support feature '%(feature)'",
67 .error_fmt
= QERR_BUS_NO_HOTPLUG
,
68 .desc
= "Bus '%(bus)' does not support hotplugging",
71 .error_fmt
= QERR_BUS_NOT_FOUND
,
72 .desc
= "Bus '%(bus)' not found",
75 .error_fmt
= QERR_COMMAND_DISABLED
,
76 .desc
= "The command %(name) has been disabled for this instance",
79 .error_fmt
= QERR_COMMAND_NOT_FOUND
,
80 .desc
= "The command %(name) has not been found",
83 .error_fmt
= QERR_DEVICE_ENCRYPTED
,
84 .desc
= "'%(device)' (%(filename)) is encrypted",
87 .error_fmt
= QERR_DEVICE_FEATURE_BLOCKS_MIGRATION
,
88 .desc
= "Migration is disabled when using feature '%(feature)' in device '%(device)'",
91 .error_fmt
= QERR_DEVICE_HAS_NO_MEDIUM
,
92 .desc
= "Device '%(device)' has no medium",
95 .error_fmt
= QERR_DEVICE_INIT_FAILED
,
96 .desc
= "Device '%(device)' could not be initialized",
99 .error_fmt
= QERR_DEVICE_IN_USE
,
100 .desc
= "Device '%(device)' is in use",
103 .error_fmt
= QERR_DEVICE_IS_READ_ONLY
,
104 .desc
= "Device '%(device)' is read only",
107 .error_fmt
= QERR_DEVICE_LOCKED
,
108 .desc
= "Device '%(device)' is locked",
111 .error_fmt
= QERR_DEVICE_MULTIPLE_BUSSES
,
112 .desc
= "Device '%(device)' has multiple child busses",
115 .error_fmt
= QERR_DEVICE_NO_BUS
,
116 .desc
= "Device '%(device)' has no child bus",
119 .error_fmt
= QERR_DEVICE_NO_HOTPLUG
,
120 .desc
= "Device '%(device)' does not support hotplugging",
123 .error_fmt
= QERR_DEVICE_NOT_ACTIVE
,
124 .desc
= "Device '%(device)' has not been activated",
127 .error_fmt
= QERR_DEVICE_NOT_ENCRYPTED
,
128 .desc
= "Device '%(device)' is not encrypted",
131 .error_fmt
= QERR_DEVICE_NOT_FOUND
,
132 .desc
= "Device '%(device)' not found",
135 .error_fmt
= QERR_DEVICE_NOT_REMOVABLE
,
136 .desc
= "Device '%(device)' is not removable",
139 .error_fmt
= QERR_DUPLICATE_ID
,
140 .desc
= "Duplicate ID '%(id)' for %(object)",
143 .error_fmt
= QERR_FD_NOT_FOUND
,
144 .desc
= "File descriptor named '%(name)' not found",
147 .error_fmt
= QERR_FD_NOT_SUPPLIED
,
148 .desc
= "No file descriptor supplied via SCM_RIGHTS",
151 .error_fmt
= QERR_FEATURE_DISABLED
,
152 .desc
= "The feature '%(name)' is not enabled",
155 .error_fmt
= QERR_INVALID_BLOCK_FORMAT
,
156 .desc
= "Invalid block format '%(name)'",
159 .error_fmt
= QERR_INVALID_OPTION_GROUP
,
160 .desc
= "There is no option group '%(group)'",
163 .error_fmt
= QERR_INVALID_PARAMETER
,
164 .desc
= "Invalid parameter '%(name)'",
167 .error_fmt
= QERR_INVALID_PARAMETER_COMBINATION
,
168 .desc
= "Invalid parameter combination",
171 .error_fmt
= QERR_INVALID_PARAMETER_TYPE
,
172 .desc
= "Invalid parameter type for '%(name)', expected: %(expected)",
175 .error_fmt
= QERR_INVALID_PARAMETER_VALUE
,
176 .desc
= "Parameter '%(name)' expects %(expected)",
179 .error_fmt
= QERR_INVALID_PASSWORD
,
180 .desc
= "Password incorrect",
183 .error_fmt
= QERR_IO_ERROR
,
184 .desc
= "An IO error has occurred",
187 .error_fmt
= QERR_JSON_PARSE_ERROR
,
188 .desc
= "JSON parse error, %(message)",
192 .error_fmt
= QERR_JSON_PARSING
,
193 .desc
= "Invalid JSON syntax",
196 .error_fmt
= QERR_KVM_MISSING_CAP
,
197 .desc
= "Using KVM without %(capability), %(feature) unavailable",
200 .error_fmt
= QERR_MIGRATION_ACTIVE
,
201 .desc
= "There's a migration process in progress",
204 .error_fmt
= QERR_MIGRATION_NOT_SUPPORTED
,
205 .desc
= "State blocked by non-migratable device '%(device)'",
208 .error_fmt
= QERR_MIGRATION_EXPECTED
,
209 .desc
= "An incoming migration is expected before this command can be executed",
212 .error_fmt
= QERR_MISSING_PARAMETER
,
213 .desc
= "Parameter '%(name)' is missing",
216 .error_fmt
= QERR_NO_BUS_FOR_DEVICE
,
217 .desc
= "No '%(bus)' bus found for device '%(device)'",
220 .error_fmt
= QERR_NOT_SUPPORTED
,
221 .desc
= "Not supported",
224 .error_fmt
= QERR_OPEN_FILE_FAILED
,
225 .desc
= "Could not open '%(filename)'",
228 .error_fmt
= QERR_PERMISSION_DENIED
,
229 .desc
= "Insufficient permission to perform this operation",
232 .error_fmt
= QERR_PROPERTY_NOT_FOUND
,
233 .desc
= "Property '%(device).%(property)' not found",
236 .error_fmt
= QERR_PROPERTY_VALUE_BAD
,
237 .desc
= "Property '%(device).%(property)' doesn't take value '%(value)'",
240 .error_fmt
= QERR_PROPERTY_VALUE_IN_USE
,
241 .desc
= "Property '%(device).%(property)' can't take value '%(value)', it's in use",
244 .error_fmt
= QERR_PROPERTY_VALUE_NOT_FOUND
,
245 .desc
= "Property '%(device).%(property)' can't find value '%(value)'",
248 .error_fmt
= QERR_PROPERTY_VALUE_NOT_POWER_OF_2
,
249 .desc
= "Property '%(device).%(property)' doesn't take "
250 "value '%(value)', it's not a power of 2",
253 .error_fmt
= QERR_PROPERTY_VALUE_OUT_OF_RANGE
,
254 .desc
= "Property '%(device).%(property)' doesn't take "
255 "value %(value) (minimum: %(min), maximum: %(max))",
258 .error_fmt
= QERR_QGA_COMMAND_FAILED
,
259 .desc
= "Guest agent command failed, error was '%(message)'",
262 .error_fmt
= QERR_QGA_LOGGING_FAILED
,
263 .desc
= "Guest agent failed to log non-optional log statement",
266 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT
,
267 .desc
= "Expected '%(expected)' in QMP input",
270 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT_MEMBER
,
271 .desc
= "QMP input object member '%(member)' expects '%(expected)'",
274 .error_fmt
= QERR_QMP_EXTRA_MEMBER
,
275 .desc
= "QMP input object member '%(member)' is unexpected",
278 .error_fmt
= QERR_RESET_REQUIRED
,
279 .desc
= "Resetting the Virtual Machine is required",
282 .error_fmt
= QERR_SET_PASSWD_FAILED
,
283 .desc
= "Could not set password",
286 .error_fmt
= QERR_TOO_MANY_FILES
,
287 .desc
= "Too many open files",
290 .error_fmt
= QERR_UNDEFINED_ERROR
,
291 .desc
= "An undefined error has occurred",
294 .error_fmt
= QERR_UNKNOWN_BLOCK_FORMAT_FEATURE
,
295 .desc
= "'%(device)' uses a %(format) feature which is not "
296 "supported by this qemu version: %(feature)",
299 .error_fmt
= QERR_UNSUPPORTED
,
300 .desc
= "this feature or command is not currently supported",
303 .error_fmt
= QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION
,
304 .desc
= "Migration is disabled when VirtFS export path '%(path)' "
305 "is mounted in the guest using mount_tag '%(tag)'",
308 .error_fmt
= QERR_VNC_SERVER_FAILED
,
309 .desc
= "Could not start VNC server on %(target)",
312 .error_fmt
= QERR_SOCKET_CONNECT_IN_PROGRESS
,
313 .desc
= "Connection can not be completed immediately",
316 .error_fmt
= QERR_SOCKET_CONNECT_FAILED
,
317 .desc
= "Failed to connect to socket",
320 .error_fmt
= QERR_SOCKET_LISTEN_FAILED
,
321 .desc
= "Failed to set socket to listening mode",
324 .error_fmt
= QERR_SOCKET_BIND_FAILED
,
325 .desc
= "Failed to bind socket",
328 .error_fmt
= QERR_SOCKET_CREATE_FAILED
,
329 .desc
= "Failed to create socket",
335 * qerror_new(): Create a new QError
337 * Return strong reference.
339 static QError
*qerror_new(void)
343 qerr
= g_malloc0(sizeof(*qerr
));
344 QOBJECT_INIT(qerr
, &qerror_type
);
349 static QDict
*error_obj_from_fmt_no_fail(const char *fmt
, va_list *va
)
354 obj
= qobject_from_jsonv(fmt
, va
);
356 fprintf(stderr
, "invalid json in error dict '%s'\n", fmt
);
359 if (qobject_type(obj
) != QTYPE_QDICT
) {
360 fprintf(stderr
, "error is not a dict '%s'\n", fmt
);
364 ret
= qobject_to_qdict(obj
);
365 obj
= qdict_get(ret
, "class");
367 fprintf(stderr
, "missing 'class' key in '%s'\n", fmt
);
370 if (qobject_type(obj
) != QTYPE_QSTRING
) {
371 fprintf(stderr
, "'class' key value should be a string in '%s'\n", fmt
);
375 obj
= qdict_get(ret
, "data");
377 fprintf(stderr
, "missing 'data' key in '%s'\n", fmt
);
380 if (qobject_type(obj
) != QTYPE_QDICT
) {
381 fprintf(stderr
, "'data' key value should be a dict in '%s'\n", fmt
);
389 * qerror_from_info(): Create a new QError from error information
391 * Return strong reference.
393 static QError
*qerror_from_info(const char *fmt
, va_list *va
)
398 loc_save(&qerr
->loc
);
400 qerr
->error
= error_obj_from_fmt_no_fail(fmt
, va
);
401 qerr
->err_msg
= qerror_format(fmt
, qerr
->error
);
406 static void parse_error(const QErrorStringTable
*entry
, int c
)
408 fprintf(stderr
, "expected '%c' in '%s'", c
, entry
->desc
);
412 static const char *append_field(QDict
*error
, QString
*outstr
,
413 const QErrorStringTable
*entry
,
419 const char *end
, *key
;
422 parse_error(entry
, '%');
425 parse_error(entry
, '(');
428 end
= strchr(start
, ')');
430 parse_error(entry
, ')');
432 key_qs
= qstring_from_substr(start
, 0, end
- start
- 1);
433 key
= qstring_get_str(key_qs
);
435 qdict
= qobject_to_qdict(qdict_get(error
, "data"));
436 obj
= qdict_get(qdict
, key
);
441 switch (qobject_type(obj
)) {
443 qstring_append(outstr
, qdict_get_str(qdict
, key
));
446 qstring_append_int(outstr
, qdict_get_int(qdict
, key
));
456 static QString
*qerror_format_desc(QDict
*error
,
457 const QErrorStringTable
*entry
)
462 assert(entry
!= NULL
);
464 qstring
= qstring_new();
466 for (p
= entry
->desc
; *p
!= '\0';) {
468 qstring_append_chr(qstring
, *p
++);
469 } else if (*(p
+ 1) == '%') {
470 qstring_append_chr(qstring
, '%');
473 p
= append_field(error
, qstring
, entry
, p
);
480 char *qerror_format(const char *fmt
, QDict
*error
)
482 const QErrorStringTable
*entry
= NULL
;
487 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
488 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
489 entry
= &qerror_table
[i
];
494 qstr
= qerror_format_desc(error
, entry
);
495 ret
= g_strdup(qstring_get_str(qstr
));
502 * qerror_human(): Format QError data into human-readable string.
504 QString
*qerror_human(const QError
*qerror
)
506 return qstring_from_str(qerror
->err_msg
);
510 * qerror_print(): Print QError data
512 * This function will print the member 'desc' of the specified QError object,
513 * it uses error_report() for this, so that the output is routed to the right
514 * place (ie. stderr or Monitor's device).
516 static void qerror_print(QError
*qerror
)
518 QString
*qstring
= qerror_human(qerror
);
519 loc_push_restore(&qerror
->loc
);
520 error_report("%s", qstring_get_str(qstring
));
521 loc_pop(&qerror
->loc
);
525 void qerror_report(const char *fmt
, ...)
531 qerror
= qerror_from_info(fmt
, &va
);
534 if (monitor_cur_is_qmp()) {
535 monitor_set_error(cur_mon
, qerror
);
537 qerror_print(qerror
);
549 void qerror_report_err(Error
*err
)
554 loc_save(&qerr
->loc
);
556 qerr
->error
= err
->obj
;
557 qerr
->err_msg
= g_strdup(err
->msg
);
559 if (monitor_cur_is_qmp()) {
560 monitor_set_error(cur_mon
, qerr
);
567 void assert_no_error(Error
*err
)
570 qerror_report_err(err
);
576 * qobject_to_qerror(): Convert a QObject into a QError
578 static QError
*qobject_to_qerror(const QObject
*obj
)
580 if (qobject_type(obj
) != QTYPE_QERROR
) {
584 return container_of(obj
, QError
, base
);
588 * qerror_destroy_obj(): Free all memory allocated by a QError
590 static void qerror_destroy_obj(QObject
*obj
)
595 qerr
= qobject_to_qerror(obj
);
597 QDECREF(qerr
->error
);
598 g_free(qerr
->err_msg
);