Monitor: Drop QMP bits from do_info()
[qemu/wangdongxu.git] / qerror.c
blob0af3ab32bd751dd35dbef3cf83c4acae8f2ea098
1 /*
2 * QError Module
4 * Copyright (C) 2009 Red Hat Inc.
6 * Authors:
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.
13 #include "monitor.h"
14 #include "qjson.h"
15 #include "qerror.h"
16 #include "qemu-common.h"
18 static void qerror_destroy_obj(QObject *obj);
20 static const QType qerror_type = {
21 .code = QTYPE_QERROR,
22 .destroy = qerror_destroy_obj,
25 /**
26 * The 'desc' parameter is a printf-like string, the format of the format
27 * string is:
29 * %(KEY)
31 * Where KEY is a QDict key, which has to be passed to qerror_from_info().
33 * Example:
35 * "foo error on device: %(device) slot: %(slot_nr)"
37 * A single percent sign can be printed if followed by a second one,
38 * for example:
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"
44 * to check.
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_LOCKED,
77 .desc = "Device '%(device)' is locked",
80 .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
81 .desc = "Device '%(device)' has multiple child busses",
84 .error_fmt = QERR_DEVICE_NOT_ACTIVE,
85 .desc = "Device '%(device)' has not been activated",
88 .error_fmt = QERR_DEVICE_NOT_ENCRYPTED,
89 .desc = "Device '%(device)' is not encrypted",
92 .error_fmt = QERR_DEVICE_NOT_FOUND,
93 .desc = "Device '%(device)' not found",
96 .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
97 .desc = "Device '%(device)' is not removable",
100 .error_fmt = QERR_DEVICE_NO_BUS,
101 .desc = "Device '%(device)' has no child bus",
104 .error_fmt = QERR_DUPLICATE_ID,
105 .desc = "Duplicate ID '%(id)' for %(object)",
108 .error_fmt = QERR_FD_NOT_FOUND,
109 .desc = "File descriptor named '%(name)' not found",
112 .error_fmt = QERR_FD_NOT_SUPPLIED,
113 .desc = "No file descriptor supplied via SCM_RIGHTS",
116 .error_fmt = QERR_INVALID_BLOCK_FORMAT,
117 .desc = "Invalid block format '%(name)'",
120 .error_fmt = QERR_INVALID_PARAMETER,
121 .desc = "Invalid parameter '%(name)'",
124 .error_fmt = QERR_INVALID_PARAMETER_TYPE,
125 .desc = "Invalid parameter type, expected: %(expected)",
128 .error_fmt = QERR_INVALID_PARAMETER_VALUE,
129 .desc = "Parameter '%(name)' expects %(expected)",
132 .error_fmt = QERR_INVALID_PASSWORD,
133 .desc = "Password incorrect",
136 .error_fmt = QERR_JSON_PARSING,
137 .desc = "Invalid JSON syntax",
140 .error_fmt = QERR_KVM_MISSING_CAP,
141 .desc = "Using KVM without %(capability), %(feature) unavailable",
144 .error_fmt = QERR_MIGRATION_EXPECTED,
145 .desc = "An incoming migration is expected before this command can be executed",
148 .error_fmt = QERR_MISSING_PARAMETER,
149 .desc = "Parameter '%(name)' is missing",
152 .error_fmt = QERR_NO_BUS_FOR_DEVICE,
153 .desc = "No '%(bus)' bus found for device '%(device)'",
156 .error_fmt = QERR_OPEN_FILE_FAILED,
157 .desc = "Could not open '%(filename)'",
160 .error_fmt = QERR_PROPERTY_NOT_FOUND,
161 .desc = "Property '%(device).%(property)' not found",
164 .error_fmt = QERR_PROPERTY_VALUE_BAD,
165 .desc = "Property '%(device).%(property)' doesn't take value '%(value)'",
168 .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
169 .desc = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
172 .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
173 .desc = "Property '%(device).%(property)' can't find value '%(value)'",
176 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
177 .desc = "Expected '%(expected)' in QMP input",
180 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
181 .desc = "QMP input object member '%(member)' expects '%(expected)'",
184 .error_fmt = QERR_QMP_EXTRA_MEMBER,
185 .desc = "QMP input object member '%(member)' is unexpected",
188 .error_fmt = QERR_SET_PASSWD_FAILED,
189 .desc = "Could not set password",
192 .error_fmt = QERR_TOO_MANY_FILES,
193 .desc = "Too many open files",
196 .error_fmt = QERR_UNDEFINED_ERROR,
197 .desc = "An undefined error has ocurred",
200 .error_fmt = QERR_VNC_SERVER_FAILED,
201 .desc = "Could not start VNC server on %(target)",
207 * qerror_new(): Create a new QError
209 * Return strong reference.
211 QError *qerror_new(void)
213 QError *qerr;
215 qerr = qemu_mallocz(sizeof(*qerr));
216 QOBJECT_INIT(qerr, &qerror_type);
218 return qerr;
221 static void qerror_abort(const QError *qerr, const char *fmt, ...)
223 va_list ap;
225 fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
226 fprintf(stderr, "qerror: -> ");
228 va_start(ap, fmt);
229 vfprintf(stderr, fmt, ap);
230 va_end(ap);
232 fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
233 abort();
236 static void qerror_set_data(QError *qerr, const char *fmt, va_list *va)
238 QObject *obj;
240 obj = qobject_from_jsonv(fmt, va);
241 if (!obj) {
242 qerror_abort(qerr, "invalid format '%s'", fmt);
244 if (qobject_type(obj) != QTYPE_QDICT) {
245 qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
248 qerr->error = qobject_to_qdict(obj);
250 obj = qdict_get(qerr->error, "class");
251 if (!obj) {
252 qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
254 if (qobject_type(obj) != QTYPE_QSTRING) {
255 qerror_abort(qerr, "'class' key value should be a QString");
258 obj = qdict_get(qerr->error, "data");
259 if (!obj) {
260 qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
262 if (qobject_type(obj) != QTYPE_QDICT) {
263 qerror_abort(qerr, "'data' key value should be a QDICT");
267 static void qerror_set_desc(QError *qerr, const char *fmt)
269 int i;
271 // FIXME: inefficient loop
273 for (i = 0; qerror_table[i].error_fmt; i++) {
274 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
275 qerr->entry = &qerror_table[i];
276 return;
280 qerror_abort(qerr, "error format '%s' not found", fmt);
284 * qerror_from_info(): Create a new QError from error information
286 * The information consists of:
288 * - file the file name of where the error occurred
289 * - linenr the line number of where the error occurred
290 * - func the function name of where the error occurred
291 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
292 * 'data'
293 * - va va_list of all arguments specified by fmt
295 * Return strong reference.
297 QError *qerror_from_info(const char *file, int linenr, const char *func,
298 const char *fmt, va_list *va)
300 QError *qerr;
302 qerr = qerror_new();
303 loc_save(&qerr->loc);
304 qerr->linenr = linenr;
305 qerr->file = file;
306 qerr->func = func;
308 if (!fmt) {
309 qerror_abort(qerr, "QDict not specified");
312 qerror_set_data(qerr, fmt, va);
313 qerror_set_desc(qerr, fmt);
315 return qerr;
318 static void parse_error(const QError *qerror, int c)
320 qerror_abort(qerror, "expected '%c' in '%s'", c, qerror->entry->desc);
323 static const char *append_field(QString *outstr, const QError *qerror,
324 const char *start)
326 QObject *obj;
327 QDict *qdict;
328 QString *key_qs;
329 const char *end, *key;
331 if (*start != '%')
332 parse_error(qerror, '%');
333 start++;
334 if (*start != '(')
335 parse_error(qerror, '(');
336 start++;
338 end = strchr(start, ')');
339 if (!end)
340 parse_error(qerror, ')');
342 key_qs = qstring_from_substr(start, 0, end - start - 1);
343 key = qstring_get_str(key_qs);
345 qdict = qobject_to_qdict(qdict_get(qerror->error, "data"));
346 obj = qdict_get(qdict, key);
347 if (!obj) {
348 qerror_abort(qerror, "key '%s' not found in QDict", key);
351 switch (qobject_type(obj)) {
352 case QTYPE_QSTRING:
353 qstring_append(outstr, qdict_get_str(qdict, key));
354 break;
355 case QTYPE_QINT:
356 qstring_append_int(outstr, qdict_get_int(qdict, key));
357 break;
358 default:
359 qerror_abort(qerror, "invalid type '%c'", qobject_type(obj));
362 QDECREF(key_qs);
363 return ++end;
367 * qerror_human(): Format QError data into human-readable string.
369 * Formats according to member 'desc' of the specified QError object.
371 QString *qerror_human(const QError *qerror)
373 const char *p;
374 QString *qstring;
376 assert(qerror->entry != NULL);
378 qstring = qstring_new();
380 for (p = qerror->entry->desc; *p != '\0';) {
381 if (*p != '%') {
382 qstring_append_chr(qstring, *p++);
383 } else if (*(p + 1) == '%') {
384 qstring_append_chr(qstring, '%');
385 p += 2;
386 } else {
387 p = append_field(qstring, qerror, p);
391 return qstring;
395 * qerror_print(): Print QError data
397 * This function will print the member 'desc' of the specified QError object,
398 * it uses error_report() for this, so that the output is routed to the right
399 * place (ie. stderr or Monitor's device).
401 void qerror_print(QError *qerror)
403 QString *qstring = qerror_human(qerror);
404 loc_push_restore(&qerror->loc);
405 error_report("%s", qstring_get_str(qstring));
406 loc_pop(&qerror->loc);
407 QDECREF(qstring);
410 void qerror_report_internal(const char *file, int linenr, const char *func,
411 const char *fmt, ...)
413 va_list va;
414 QError *qerror;
416 va_start(va, fmt);
417 qerror = qerror_from_info(file, linenr, func, fmt, &va);
418 va_end(va);
420 if (monitor_cur_is_qmp()) {
421 monitor_set_error(cur_mon, qerror);
422 } else {
423 qerror_print(qerror);
424 QDECREF(qerror);
429 * qobject_to_qerror(): Convert a QObject into a QError
431 QError *qobject_to_qerror(const QObject *obj)
433 if (qobject_type(obj) != QTYPE_QERROR) {
434 return NULL;
437 return container_of(obj, QError, base);
441 * qerror_destroy_obj(): Free all memory allocated by a QError
443 static void qerror_destroy_obj(QObject *obj)
445 QError *qerr;
447 assert(obj != NULL);
448 qerr = qobject_to_qerror(obj);
450 QDECREF(qerr->error);
451 qemu_free(qerr);