2 * QError: QEMU Error data-type.
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.
15 #include "qemu-common.h"
16 #include "qemu-error.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 static const QErrorStringTable qerror_table
[] = {
44 .error_fmt
= QERR_BUS_NOT_FOUND
,
45 .desc
= "Bus '%(bus)' not found",
48 .error_fmt
= QERR_COMMAND_NOT_FOUND
,
49 .desc
= "The command %(name) has not been found",
52 .error_fmt
= QERR_DEVICE_ENCRYPTED
,
53 .desc
= "Device '%(device)' is encrypted",
56 .error_fmt
= QERR_DEVICE_LOCKED
,
57 .desc
= "Device '%(device)' is locked",
60 .error_fmt
= QERR_DEVICE_MULTIPLE_BUSSES
,
61 .desc
= "Device '%(device)' has multiple child busses",
64 .error_fmt
= QERR_DEVICE_NOT_ACTIVE
,
65 .desc
= "Device '%(device)' has not been activated by the guest",
68 .error_fmt
= QERR_DEVICE_NOT_FOUND
,
69 .desc
= "Device '%(device)' not found",
72 .error_fmt
= QERR_DEVICE_NOT_REMOVABLE
,
73 .desc
= "Device '%(device)' is not removable",
76 .error_fmt
= QERR_DEVICE_NO_BUS
,
77 .desc
= "Device '%(device)' has no child bus",
80 .error_fmt
= QERR_FD_NOT_FOUND
,
81 .desc
= "File descriptor named '%(name)' not found",
84 .error_fmt
= QERR_FD_NOT_SUPPLIED
,
85 .desc
= "No file descriptor supplied via SCM_RIGHTS",
88 .error_fmt
= QERR_INVALID_BLOCK_FORMAT
,
89 .desc
= "Invalid block format '%(name)'",
92 .error_fmt
= QERR_INVALID_PARAMETER
,
93 .desc
= "Invalid parameter '%(name)'",
96 .error_fmt
= QERR_INVALID_PARAMETER_TYPE
,
97 .desc
= "Invalid parameter type, expected: %(expected)",
100 .error_fmt
= QERR_INVALID_PASSWORD
,
101 .desc
= "Password incorrect",
104 .error_fmt
= QERR_JSON_PARSING
,
105 .desc
= "Invalid JSON syntax",
108 .error_fmt
= QERR_KVM_MISSING_CAP
,
109 .desc
= "Using KVM without %(capability), %(feature) unavailable",
112 .error_fmt
= QERR_MISSING_PARAMETER
,
113 .desc
= "Parameter '%(name)' is missing",
116 .error_fmt
= QERR_OPEN_FILE_FAILED
,
117 .desc
= "Could not open '%(filename)'",
120 .error_fmt
= QERR_PROPERTY_NOT_FOUND
,
121 .desc
= "Property '%(device).%(property)' not found",
124 .error_fmt
= QERR_PROPERTY_VALUE_BAD
,
125 .desc
= "Property '%(device).%(property)' doesn't take value '%(value)'",
128 .error_fmt
= QERR_PROPERTY_VALUE_IN_USE
,
129 .desc
= "Property '%(device).%(property)' can't take value '%(value)', it's in use",
132 .error_fmt
= QERR_PROPERTY_VALUE_NOT_FOUND
,
133 .desc
= "Property '%(device).%(property)' can't find value '%(value)'",
136 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT
,
137 .desc
= "Bad QMP input object",
140 .error_fmt
= QERR_SET_PASSWD_FAILED
,
141 .desc
= "Could not set password",
144 .error_fmt
= QERR_TOO_MANY_FILES
,
145 .desc
= "Too many open files",
148 .error_fmt
= QERR_UNDEFINED_ERROR
,
149 .desc
= "An undefined error has ocurred",
152 .error_fmt
= QERR_VNC_SERVER_FAILED
,
153 .desc
= "Could not start VNC server on %(target)",
159 * qerror_new(): Create a new QError
161 * Return strong reference.
163 QError
*qerror_new(void)
167 qerr
= qemu_mallocz(sizeof(*qerr
));
168 QOBJECT_INIT(qerr
, &qerror_type
);
173 static void qerror_abort(const QError
*qerr
, const char *fmt
, ...)
177 fprintf(stderr
, "qerror: bad call in function '%s':\n", qerr
->func
);
178 fprintf(stderr
, "qerror: -> ");
181 vfprintf(stderr
, fmt
, ap
);
184 fprintf(stderr
, "\nqerror: call at %s:%d\n", qerr
->file
, qerr
->linenr
);
188 static void qerror_set_data(QError
*qerr
, const char *fmt
, va_list *va
)
192 obj
= qobject_from_jsonv(fmt
, va
);
194 qerror_abort(qerr
, "invalid format '%s'", fmt
);
196 if (qobject_type(obj
) != QTYPE_QDICT
) {
197 qerror_abort(qerr
, "error format is not a QDict '%s'", fmt
);
200 qerr
->error
= qobject_to_qdict(obj
);
202 obj
= qdict_get(qerr
->error
, "class");
204 qerror_abort(qerr
, "missing 'class' key in '%s'", fmt
);
206 if (qobject_type(obj
) != QTYPE_QSTRING
) {
207 qerror_abort(qerr
, "'class' key value should be a QString");
210 obj
= qdict_get(qerr
->error
, "data");
212 qerror_abort(qerr
, "missing 'data' key in '%s'", fmt
);
214 if (qobject_type(obj
) != QTYPE_QDICT
) {
215 qerror_abort(qerr
, "'data' key value should be a QDICT");
219 static void qerror_set_desc(QError
*qerr
, const char *fmt
)
223 // FIXME: inefficient loop
225 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
226 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
227 qerr
->entry
= &qerror_table
[i
];
232 qerror_abort(qerr
, "error format '%s' not found", fmt
);
236 * qerror_from_info(): Create a new QError from error information
238 * The information consists of:
240 * - file the file name of where the error occurred
241 * - linenr the line number of where the error occurred
242 * - func the function name of where the error occurred
243 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
245 * - va va_list of all arguments specified by fmt
247 * Return strong reference.
249 QError
*qerror_from_info(const char *file
, int linenr
, const char *func
,
250 const char *fmt
, va_list *va
)
255 loc_save(&qerr
->loc
);
256 qerr
->linenr
= linenr
;
261 qerror_abort(qerr
, "QDict not specified");
264 qerror_set_data(qerr
, fmt
, va
);
265 qerror_set_desc(qerr
, fmt
);
270 static void parse_error(const QError
*qerror
, int c
)
272 qerror_abort(qerror
, "expected '%c' in '%s'", c
, qerror
->entry
->desc
);
275 static const char *append_field(QString
*outstr
, const QError
*qerror
,
281 const char *end
, *key
;
284 parse_error(qerror
, '%');
287 parse_error(qerror
, '(');
290 end
= strchr(start
, ')');
292 parse_error(qerror
, ')');
294 key_qs
= qstring_from_substr(start
, 0, end
- start
- 1);
295 key
= qstring_get_str(key_qs
);
297 qdict
= qobject_to_qdict(qdict_get(qerror
->error
, "data"));
298 obj
= qdict_get(qdict
, key
);
300 qerror_abort(qerror
, "key '%s' not found in QDict", key
);
303 switch (qobject_type(obj
)) {
305 qstring_append(outstr
, qdict_get_str(qdict
, key
));
308 qstring_append_int(outstr
, qdict_get_int(qdict
, key
));
311 qerror_abort(qerror
, "invalid type '%c'", qobject_type(obj
));
319 * qerror_human(): Format QError data into human-readable string.
321 * Formats according to member 'desc' of the specified QError object.
323 QString
*qerror_human(const QError
*qerror
)
328 assert(qerror
->entry
!= NULL
);
330 qstring
= qstring_new();
332 for (p
= qerror
->entry
->desc
; *p
!= '\0';) {
334 qstring_append_chr(qstring
, *p
++);
335 } else if (*(p
+ 1) == '%') {
336 qstring_append_chr(qstring
, '%');
339 p
= append_field(qstring
, qerror
, p
);
347 * qerror_print(): Print QError data
349 * This function will print the member 'desc' of the specified QError object,
350 * it uses error_report() for this, so that the output is routed to the right
351 * place (ie. stderr or Monitor's device).
353 void qerror_print(QError
*qerror
)
355 QString
*qstring
= qerror_human(qerror
);
356 loc_push_restore(&qerror
->loc
);
357 error_report("%s", qstring_get_str(qstring
));
358 loc_pop(&qerror
->loc
);
363 * qobject_to_qerror(): Convert a QObject into a QError
365 QError
*qobject_to_qerror(const QObject
*obj
)
367 if (qobject_type(obj
) != QTYPE_QERROR
) {
371 return container_of(obj
, QError
, base
);
375 * qerror_destroy_obj(): Free all memory allocated by a QError
377 static void qerror_destroy_obj(QObject
*obj
)
382 qerr
= qobject_to_qerror(obj
);
384 QDECREF(qerr
->error
);