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_COMMAND_NOT_FOUND
,
45 .desc
= "The command %(name) has not been found",
48 .error_fmt
= QERR_DEVICE_ENCRYPTED
,
49 .desc
= "Device '%(device)' is encrypted",
52 .error_fmt
= QERR_DEVICE_LOCKED
,
53 .desc
= "Device '%(device)' is locked",
56 .error_fmt
= QERR_DEVICE_NOT_ACTIVE
,
57 .desc
= "Device '%(device)' has not been activated by the guest",
60 .error_fmt
= QERR_DEVICE_NOT_FOUND
,
61 .desc
= "Device '%(device)' not found",
64 .error_fmt
= QERR_DEVICE_NOT_REMOVABLE
,
65 .desc
= "Device '%(device)' is not removable",
68 .error_fmt
= QERR_FD_NOT_FOUND
,
69 .desc
= "File descriptor named '%(name)' not found",
72 .error_fmt
= QERR_FD_NOT_SUPPLIED
,
73 .desc
= "No file descriptor supplied via SCM_RIGHTS",
76 .error_fmt
= QERR_INVALID_BLOCK_FORMAT
,
77 .desc
= "Invalid block format '%(name)'",
80 .error_fmt
= QERR_INVALID_PARAMETER
,
81 .desc
= "Invalid parameter '%(name)'",
84 .error_fmt
= QERR_INVALID_PARAMETER_TYPE
,
85 .desc
= "Invalid parameter type, expected: %(expected)",
88 .error_fmt
= QERR_INVALID_PASSWORD
,
89 .desc
= "Password incorrect",
92 .error_fmt
= QERR_JSON_PARSING
,
93 .desc
= "Invalid JSON syntax",
96 .error_fmt
= QERR_KVM_MISSING_CAP
,
97 .desc
= "Using KVM without %(capability), %(feature) unavailable",
100 .error_fmt
= QERR_MISSING_PARAMETER
,
101 .desc
= "Parameter '%(name)' is missing",
104 .error_fmt
= QERR_OPEN_FILE_FAILED
,
105 .desc
= "Could not open '%(filename)'",
108 .error_fmt
= QERR_PROPERTY_NOT_FOUND
,
109 .desc
= "Property '%(device).%(property)' not found",
112 .error_fmt
= QERR_PROPERTY_VALUE_BAD
,
113 .desc
= "Property '%(device).%(property)' doesn't take value '%(value)'",
116 .error_fmt
= QERR_PROPERTY_VALUE_IN_USE
,
117 .desc
= "Property '%(device).%(property)' can't take value '%(value)', it's in use",
120 .error_fmt
= QERR_PROPERTY_VALUE_NOT_FOUND
,
121 .desc
= "Property '%(device).%(property)' can't find value '%(value)'",
124 .error_fmt
= QERR_QMP_BAD_INPUT_OBJECT
,
125 .desc
= "Bad QMP input object",
128 .error_fmt
= QERR_SET_PASSWD_FAILED
,
129 .desc
= "Could not set password",
132 .error_fmt
= QERR_TOO_MANY_FILES
,
133 .desc
= "Too many open files",
136 .error_fmt
= QERR_UNDEFINED_ERROR
,
137 .desc
= "An undefined error has ocurred",
140 .error_fmt
= QERR_VNC_SERVER_FAILED
,
141 .desc
= "Could not start VNC server on %(target)",
147 * qerror_new(): Create a new QError
149 * Return strong reference.
151 QError
*qerror_new(void)
155 qerr
= qemu_mallocz(sizeof(*qerr
));
156 QOBJECT_INIT(qerr
, &qerror_type
);
161 static void qerror_abort(const QError
*qerr
, const char *fmt
, ...)
165 fprintf(stderr
, "qerror: bad call in function '%s':\n", qerr
->func
);
166 fprintf(stderr
, "qerror: -> ");
169 vfprintf(stderr
, fmt
, ap
);
172 fprintf(stderr
, "\nqerror: call at %s:%d\n", qerr
->file
, qerr
->linenr
);
176 static void qerror_set_data(QError
*qerr
, const char *fmt
, va_list *va
)
180 obj
= qobject_from_jsonv(fmt
, va
);
182 qerror_abort(qerr
, "invalid format '%s'", fmt
);
184 if (qobject_type(obj
) != QTYPE_QDICT
) {
185 qerror_abort(qerr
, "error format is not a QDict '%s'", fmt
);
188 qerr
->error
= qobject_to_qdict(obj
);
190 obj
= qdict_get(qerr
->error
, "class");
192 qerror_abort(qerr
, "missing 'class' key in '%s'", fmt
);
194 if (qobject_type(obj
) != QTYPE_QSTRING
) {
195 qerror_abort(qerr
, "'class' key value should be a QString");
198 obj
= qdict_get(qerr
->error
, "data");
200 qerror_abort(qerr
, "missing 'data' key in '%s'", fmt
);
202 if (qobject_type(obj
) != QTYPE_QDICT
) {
203 qerror_abort(qerr
, "'data' key value should be a QDICT");
207 static void qerror_set_desc(QError
*qerr
, const char *fmt
)
211 // FIXME: inefficient loop
213 for (i
= 0; qerror_table
[i
].error_fmt
; i
++) {
214 if (strcmp(qerror_table
[i
].error_fmt
, fmt
) == 0) {
215 qerr
->entry
= &qerror_table
[i
];
220 qerror_abort(qerr
, "error format '%s' not found", fmt
);
224 * qerror_from_info(): Create a new QError from error information
226 * The information consists of:
228 * - file the file name of where the error occurred
229 * - linenr the line number of where the error occurred
230 * - func the function name of where the error occurred
231 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
233 * - va va_list of all arguments specified by fmt
235 * Return strong reference.
237 QError
*qerror_from_info(const char *file
, int linenr
, const char *func
,
238 const char *fmt
, va_list *va
)
243 loc_save(&qerr
->loc
);
244 qerr
->linenr
= linenr
;
249 qerror_abort(qerr
, "QDict not specified");
252 qerror_set_data(qerr
, fmt
, va
);
253 qerror_set_desc(qerr
, fmt
);
258 static void parse_error(const QError
*qerror
, int c
)
260 qerror_abort(qerror
, "expected '%c' in '%s'", c
, qerror
->entry
->desc
);
263 static const char *append_field(QString
*outstr
, const QError
*qerror
,
269 const char *end
, *key
;
272 parse_error(qerror
, '%');
275 parse_error(qerror
, '(');
278 end
= strchr(start
, ')');
280 parse_error(qerror
, ')');
282 key_qs
= qstring_from_substr(start
, 0, end
- start
- 1);
283 key
= qstring_get_str(key_qs
);
285 qdict
= qobject_to_qdict(qdict_get(qerror
->error
, "data"));
286 obj
= qdict_get(qdict
, key
);
288 qerror_abort(qerror
, "key '%s' not found in QDict", key
);
291 switch (qobject_type(obj
)) {
293 qstring_append(outstr
, qdict_get_str(qdict
, key
));
296 qstring_append_int(outstr
, qdict_get_int(qdict
, key
));
299 qerror_abort(qerror
, "invalid type '%c'", qobject_type(obj
));
307 * qerror_human(): Format QError data into human-readable string.
309 * Formats according to member 'desc' of the specified QError object.
311 QString
*qerror_human(const QError
*qerror
)
316 assert(qerror
->entry
!= NULL
);
318 qstring
= qstring_new();
320 for (p
= qerror
->entry
->desc
; *p
!= '\0';) {
322 qstring_append_chr(qstring
, *p
++);
323 } else if (*(p
+ 1) == '%') {
324 qstring_append_chr(qstring
, '%');
327 p
= append_field(qstring
, qerror
, p
);
335 * qerror_print(): Print QError data
337 * This function will print the member 'desc' of the specified QError object,
338 * it uses error_report() for this, so that the output is routed to the right
339 * place (ie. stderr or Monitor's device).
341 void qerror_print(QError
*qerror
)
343 QString
*qstring
= qerror_human(qerror
);
344 loc_push_restore(&qerror
->loc
);
345 error_report("%s", qstring_get_str(qstring
));
346 loc_pop(&qerror
->loc
);
351 * qobject_to_qerror(): Convert a QObject into a QError
353 QError
*qobject_to_qerror(const QObject
*obj
)
355 if (qobject_type(obj
) != QTYPE_QERROR
) {
359 return container_of(obj
, QError
, base
);
363 * qerror_destroy_obj(): Free all memory allocated by a QError
365 static void qerror_destroy_obj(QObject
*obj
)
370 qerr
= qobject_to_qerror(obj
);
372 QDECREF(qerr
->error
);