blob: 41c729a01fcae468f547d6ea797fe63eb67f5729 [file] [log] [blame]
Luiz Capitulino9f9daf92009-11-18 23:05:30 -02001/*
Luiz Capitulino41836a92010-05-12 16:34:42 -03002 * QError Module
Luiz Capitulino9f9daf92009-11-18 23:05:30 -02003 *
4 * Copyright (C) 2009 Red Hat Inc.
5 *
6 * Authors:
7 * Luiz Capitulino <lcapitulino@redhat.com>
8 *
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.
11 */
Markus Armbruster0167f772010-03-22 10:29:05 +010012
13#include "monitor.h"
Luiz Capitulino9f9daf92009-11-18 23:05:30 -020014#include "qjson.h"
15#include "qerror.h"
Luiz Capitulino9f9daf92009-11-18 23:05:30 -020016#include "qemu-common.h"
17
18static void qerror_destroy_obj(QObject *obj);
19
20static const QType qerror_type = {
21 .code = QTYPE_QERROR,
22 .destroy = qerror_destroy_obj,
23};
24
25/**
26 * The 'desc' parameter is a printf-like string, the format of the format
27 * string is:
28 *
29 * %(KEY)
30 *
31 * Where KEY is a QDict key, which has to be passed to qerror_from_info().
32 *
33 * Example:
34 *
35 * "foo error on device: %(device) slot: %(slot_nr)"
36 *
37 * A single percent sign can be printed if followed by a second one,
38 * for example:
39 *
40 * "running out of foo: %(foo)%%"
Markus Armbruster9d494c42010-03-25 17:22:30 +010041 *
42 * Please keep the entries in alphabetical order.
Stefan Hajnoczi97373832012-01-04 22:23:32 +000043 * Use scripts/check-qerror.sh to check.
Luiz Capitulino9f9daf92009-11-18 23:05:30 -020044 */
Blue Swirld05ac8f2009-12-04 20:44:44 +000045static const QErrorStringTable qerror_table[] = {
Luiz Capitulino357b6152009-11-18 23:05:32 -020046 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +000047 .error_fmt = QERR_ADD_CLIENT_FAILED,
48 .desc = "Could not add client",
49 },
50 {
Paolo Bonzini11e35bf2012-02-02 12:37:53 +010051 .error_fmt = QERR_AMBIGUOUS_PATH,
52 .desc = "Path '%(path)' does not uniquely identify a %(object)"
53 },
54 {
Markus Armbruster56e9f562010-02-19 19:52:45 +010055 .error_fmt = QERR_BAD_BUS_FOR_DEVICE,
56 .desc = "Device '%(device)' can't go on a %(bad_bus_type) bus",
57 },
58 {
Marcelo Tosatti019b8cb2012-01-18 14:40:52 +000059 .error_fmt = QERR_BASE_NOT_FOUND,
60 .desc = "Base '%(base)' not found",
61 },
62 {
Anthony Liguori1ed520c2011-11-14 15:09:47 -060063 .error_fmt = QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
64 .desc = "Block format '%(format)' used by device '%(name)' does not support feature '%(feature)'",
65 },
66 {
Markus Armbruster8eae73b2010-02-19 19:53:36 +010067 .error_fmt = QERR_BUS_NO_HOTPLUG,
68 .desc = "Bus '%(bus)' does not support hotplugging",
69 },
70 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +000071 .error_fmt = QERR_BUS_NOT_FOUND,
72 .desc = "Bus '%(bus)' not found",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -020073 },
74 {
Michael Rothabd6cf62011-12-06 22:03:42 -060075 .error_fmt = QERR_COMMAND_DISABLED,
76 .desc = "The command %(name) has been disabled for this instance",
77 },
78 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +000079 .error_fmt = QERR_COMMAND_NOT_FOUND,
80 .desc = "The command %(name) has not been found",
81 },
82 {
Luiz Capitulino0df37c42009-12-07 21:36:59 +010083 .error_fmt = QERR_DEVICE_ENCRYPTED,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +010084 .desc = "Device '%(device)' is encrypted",
Luiz Capitulino0df37c42009-12-07 21:36:59 +010085 },
86 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +000087 .error_fmt = QERR_DEVICE_FEATURE_BLOCKS_MIGRATION,
88 .desc = "Migration is disabled when using feature '%(feature)' in device '%(device)'",
89 },
90 {
Stefan Hajnoczi939a1cc2012-01-04 22:23:34 +000091 .error_fmt = QERR_DEVICE_HAS_NO_MEDIUM,
92 .desc = "Device '%(device)' has no medium",
93 },
94 {
Markus Armbruster4d9a1a12010-02-19 19:53:54 +010095 .error_fmt = QERR_DEVICE_INIT_FAILED,
96 .desc = "Device '%(device)' could not be initialized",
97 },
98 {
Markus Armbruster5124eb52010-03-25 17:22:39 +010099 .error_fmt = QERR_DEVICE_IN_USE,
100 .desc = "Device '%(device)' is in use",
101 },
102 {
Stefan Hajnoczi939a1cc2012-01-04 22:23:34 +0000103 .error_fmt = QERR_DEVICE_IS_READ_ONLY,
104 .desc = "Device '%(device)' is read only",
105 },
106 {
Markus Armbrusterb0868382009-12-07 21:37:03 +0100107 .error_fmt = QERR_DEVICE_LOCKED,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100108 .desc = "Device '%(device)' is locked",
Markus Armbrusterb0868382009-12-07 21:37:03 +0100109 },
110 {
Markus Armbruster1ae78712010-02-19 18:05:59 +0100111 .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
112 .desc = "Device '%(device)' has multiple child busses",
113 },
114 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +0000115 .error_fmt = QERR_DEVICE_NO_BUS,
116 .desc = "Device '%(device)' has no child bus",
117 },
118 {
119 .error_fmt = QERR_DEVICE_NO_HOTPLUG,
120 .desc = "Device '%(device)' does not support hotplugging",
121 },
122 {
Luiz Capitulino055f6122009-11-18 23:05:34 -0200123 .error_fmt = QERR_DEVICE_NOT_ACTIVE,
Luiz Capitulino8754c812010-06-23 12:37:47 -0300124 .desc = "Device '%(device)' has not been activated",
Luiz Capitulino055f6122009-11-18 23:05:34 -0200125 },
Luiz Capitulino82a60712009-11-18 23:05:35 -0200126 {
Markus Armbruster9d494c42010-03-25 17:22:30 +0100127 .error_fmt = QERR_DEVICE_NOT_ENCRYPTED,
128 .desc = "Device '%(device)' is not encrypted",
129 },
130 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100131 .error_fmt = QERR_DEVICE_NOT_FOUND,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100132 .desc = "Device '%(device)' not found",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200133 },
134 {
Markus Armbruster5cfe0262009-12-07 21:37:04 +0100135 .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100136 .desc = "Device '%(device)' is not removable",
Markus Armbruster5cfe0262009-12-07 21:37:04 +0100137 },
138 {
Markus Armbruster7bc84012010-03-25 17:22:31 +0100139 .error_fmt = QERR_DUPLICATE_ID,
140 .desc = "Duplicate ID '%(id)' for %(object)",
141 },
142 {
Markus Armbrusterc7c338c2009-12-07 21:37:10 +0100143 .error_fmt = QERR_FD_NOT_FOUND,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100144 .desc = "File descriptor named '%(name)' not found",
Markus Armbrusterc7c338c2009-12-07 21:37:10 +0100145 },
146 {
Markus Armbruster41471a22009-12-07 21:37:12 +0100147 .error_fmt = QERR_FD_NOT_SUPPLIED,
148 .desc = "No file descriptor supplied via SCM_RIGHTS",
149 },
150 {
Luiz Capitulinobf826322011-10-19 15:15:57 -0200151 .error_fmt = QERR_FEATURE_DISABLED,
152 .desc = "The feature '%(name)' is not enabled",
153 },
154 {
Markus Armbruster17901e72009-12-07 21:37:06 +0100155 .error_fmt = QERR_INVALID_BLOCK_FORMAT,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100156 .desc = "Invalid block format '%(name)'",
Markus Armbruster17901e72009-12-07 21:37:06 +0100157 },
158 {
Markus Armbruster7a046f52009-12-07 21:37:13 +0100159 .error_fmt = QERR_INVALID_PARAMETER,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100160 .desc = "Invalid parameter '%(name)'",
Markus Armbruster7a046f52009-12-07 21:37:13 +0100161 },
162 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +0000163 .error_fmt = QERR_INVALID_PARAMETER_COMBINATION,
164 .desc = "Invalid parameter combination",
165 },
166 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100167 .error_fmt = QERR_INVALID_PARAMETER_TYPE,
Anthony Liguori5eeee3f2011-12-22 14:40:54 -0600168 .desc = "Invalid parameter type for '%(name)', expected: %(expected)",
Markus Armbrustere16a1812009-12-07 21:37:02 +0100169 },
170 {
Markus Armbruster985a3e52010-03-25 17:22:33 +0100171 .error_fmt = QERR_INVALID_PARAMETER_VALUE,
172 .desc = "Parameter '%(name)' expects %(expected)",
173 },
174 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100175 .error_fmt = QERR_INVALID_PASSWORD,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100176 .desc = "Password incorrect",
Markus Armbrustere16a1812009-12-07 21:37:02 +0100177 },
178 {
Luiz Capitulino58898872011-11-22 16:29:52 -0200179 .error_fmt = QERR_IO_ERROR,
180 .desc = "An IO error has occurred",
181 },
182 {
Michael Rothac32c782011-07-19 15:41:52 -0500183 .error_fmt = QERR_JSON_PARSE_ERROR,
184 .desc = "JSON parse error, %(message)",
185
186 },
187 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +0000188 .error_fmt = QERR_JSON_PARSING,
189 .desc = "Invalid JSON syntax",
190 },
191 {
Luiz Capitulino82a60712009-11-18 23:05:35 -0200192 .error_fmt = QERR_KVM_MISSING_CAP,
193 .desc = "Using KVM without %(capability), %(feature) unavailable",
194 },
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200195 {
Luiz Capitulinoa4acc062011-12-02 14:58:12 -0200196 .error_fmt = QERR_MIGRATION_ACTIVE,
197 .desc = "There's a migration process in progress",
198 },
199 {
200 .error_fmt = QERR_MIGRATION_NOT_SUPPORTED,
201 .desc = "State blocked by non-migratable device '%(device)'",
202 },
203 {
Amit Shah8e848652010-07-27 15:49:19 +0530204 .error_fmt = QERR_MIGRATION_EXPECTED,
205 .desc = "An incoming migration is expected before this command can be executed",
206 },
207 {
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200208 .error_fmt = QERR_MISSING_PARAMETER,
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100209 .desc = "Parameter '%(name)' is missing",
210 },
211 {
Markus Armbrusterfab57672010-02-19 19:54:06 +0100212 .error_fmt = QERR_NO_BUS_FOR_DEVICE,
213 .desc = "No '%(bus)' bus found for device '%(device)'",
214 },
215 {
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +0000216 .error_fmt = QERR_NOT_SUPPORTED,
217 .desc = "Not supported",
218 },
219 {
Markus Armbrusterfc5469d2010-02-19 17:42:46 +0100220 .error_fmt = QERR_OPEN_FILE_FAILED,
221 .desc = "Could not open '%(filename)'",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200222 },
223 {
Anthony Liguori44677de2011-12-12 14:29:26 -0600224 .error_fmt = QERR_PERMISSION_DENIED,
225 .desc = "Insufficient permission to perform this operation",
226 },
227 {
Markus Armbrusterc58a35f2010-02-19 13:11:41 +0100228 .error_fmt = QERR_PROPERTY_NOT_FOUND,
229 .desc = "Property '%(device).%(property)' not found",
230 },
231 {
Markus Armbruster06b4a702010-02-19 13:17:58 +0100232 .error_fmt = QERR_PROPERTY_VALUE_BAD,
233 .desc = "Property '%(device).%(property)' doesn't take value '%(value)'",
234 },
235 {
Markus Armbruster9c5eff92010-03-16 17:40:48 +0100236 .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
237 .desc = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
238 },
239 {
Markus Armbruster84745d62010-03-16 17:44:38 +0100240 .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
241 .desc = "Property '%(device).%(property)' can't find value '%(value)'",
242 },
243 {
Paolo Bonzini6aced822011-12-18 17:05:08 +0100244 .error_fmt = QERR_PROPERTY_VALUE_OUT_OF_RANGE,
245 .desc = "Property '%(device).%(property)' doesn't take "
246 "value %(value) (minimum: %(min), maximum: %(max)'",
247 },
248 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +0000249 .error_fmt = QERR_QGA_COMMAND_FAILED,
250 .desc = "Guest agent command failed, error was '%(message)'",
251 },
252 {
253 .error_fmt = QERR_QGA_LOGGING_FAILED,
254 .desc = "Guest agent failed to log non-optional log statement",
255 },
256 {
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200257 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
Luiz Capitulinoabaf2f52010-04-07 14:53:49 -0300258 .desc = "Expected '%(expected)' in QMP input",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200259 },
260 {
Luiz Capitulino7dfb6122010-04-07 14:46:33 -0300261 .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
262 .desc = "QMP input object member '%(member)' expects '%(expected)'",
263 },
264 {
Luiz Capitulino60d76d72010-06-01 16:15:23 -0300265 .error_fmt = QERR_QMP_EXTRA_MEMBER,
266 .desc = "QMP input object member '%(member)' is unexpected",
267 },
268 {
Luiz Capitulino6667b232011-07-29 15:57:54 -0300269 .error_fmt = QERR_RESET_REQUIRED,
270 .desc = "Resetting the Virtual Machine is required",
271 },
272 {
Markus Armbruster7a84cb22009-12-07 21:37:07 +0100273 .error_fmt = QERR_SET_PASSWD_FAILED,
274 .desc = "Could not set password",
275 },
276 {
Markus Armbrustera488be22009-12-07 21:37:14 +0100277 .error_fmt = QERR_TOO_MANY_FILES,
278 .desc = "Too many open files",
279 },
280 {
Markus Armbrustere16a1812009-12-07 21:37:02 +0100281 .error_fmt = QERR_UNDEFINED_ERROR,
Dong Xu Wang07f35072011-11-22 18:06:26 +0800282 .desc = "An undefined error has occurred",
Luiz Capitulino4b9d4682009-11-26 22:58:57 -0200283 },
Markus Armbrustera6906e32009-12-07 21:37:08 +0100284 {
Kevin Wolff54e3642011-02-09 11:09:38 +0100285 .error_fmt = QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
286 .desc = "'%(device)' uses a %(format) feature which is not "
287 "supported by this qemu version: %(feature)",
288 },
289 {
Stefan Hajnoczic1303592012-01-04 17:38:22 +0000290 .error_fmt = QERR_UNSUPPORTED,
291 .desc = "this feature or command is not currently supported",
292 },
293 {
Aneesh Kumar K.Ve9a01522011-12-04 22:35:28 +0530294 .error_fmt = QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION,
295 .desc = "Migration is disabled when VirtFS export path '%(path)' "
296 "is mounted in the guest using mount_tag '%(tag)'",
297 },
298 {
Markus Armbrustera6906e32009-12-07 21:37:08 +0100299 .error_fmt = QERR_VNC_SERVER_FAILED,
300 .desc = "Could not start VNC server on %(target)",
301 },
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200302 {}
303};
304
305/**
306 * qerror_new(): Create a new QError
307 *
308 * Return strong reference.
309 */
310QError *qerror_new(void)
311{
312 QError *qerr;
313
Anthony Liguori7267c092011-08-20 22:09:37 -0500314 qerr = g_malloc0(sizeof(*qerr));
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200315 QOBJECT_INIT(qerr, &qerror_type);
316
317 return qerr;
318}
319
Stefan Weil8b7968f2010-09-23 21:28:05 +0200320static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr,
321 const char *fmt, ...)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200322{
323 va_list ap;
324
325 fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
326 fprintf(stderr, "qerror: -> ");
327
328 va_start(ap, fmt);
329 vfprintf(stderr, fmt, ap);
330 va_end(ap);
331
332 fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
333 abort();
334}
335
Stefan Weil8b7968f2010-09-23 21:28:05 +0200336static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr,
337 const char *fmt, va_list *va)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200338{
339 QObject *obj;
340
341 obj = qobject_from_jsonv(fmt, va);
342 if (!obj) {
343 qerror_abort(qerr, "invalid format '%s'", fmt);
344 }
345 if (qobject_type(obj) != QTYPE_QDICT) {
346 qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
347 }
348
349 qerr->error = qobject_to_qdict(obj);
350
351 obj = qdict_get(qerr->error, "class");
352 if (!obj) {
353 qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
354 }
355 if (qobject_type(obj) != QTYPE_QSTRING) {
356 qerror_abort(qerr, "'class' key value should be a QString");
357 }
358
359 obj = qdict_get(qerr->error, "data");
360 if (!obj) {
361 qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
362 }
363 if (qobject_type(obj) != QTYPE_QDICT) {
364 qerror_abort(qerr, "'data' key value should be a QDICT");
365 }
366}
367
368static void qerror_set_desc(QError *qerr, const char *fmt)
369{
370 int i;
371
372 // FIXME: inefficient loop
373
374 for (i = 0; qerror_table[i].error_fmt; i++) {
375 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
376 qerr->entry = &qerror_table[i];
377 return;
378 }
379 }
380
381 qerror_abort(qerr, "error format '%s' not found", fmt);
382}
383
384/**
385 * qerror_from_info(): Create a new QError from error information
386 *
387 * The information consists of:
388 *
389 * - file the file name of where the error occurred
390 * - linenr the line number of where the error occurred
391 * - func the function name of where the error occurred
392 * - fmt JSON printf-like dictionary, there must exist keys 'class' and
393 * 'data'
394 * - va va_list of all arguments specified by fmt
395 *
396 * Return strong reference.
397 */
398QError *qerror_from_info(const char *file, int linenr, const char *func,
399 const char *fmt, va_list *va)
400{
401 QError *qerr;
402
403 qerr = qerror_new();
Markus Armbruster827b0812010-02-18 19:46:49 +0100404 loc_save(&qerr->loc);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200405 qerr->linenr = linenr;
406 qerr->file = file;
407 qerr->func = func;
408
409 if (!fmt) {
410 qerror_abort(qerr, "QDict not specified");
411 }
412
413 qerror_set_data(qerr, fmt, va);
414 qerror_set_desc(qerr, fmt);
415
416 return qerr;
417}
418
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500419static void parse_error(const QErrorStringTable *entry, int c)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200420{
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500421 fprintf(stderr, "expected '%c' in '%s'", c, entry->desc);
422 abort();
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200423}
424
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500425static const char *append_field(QDict *error, QString *outstr,
426 const QErrorStringTable *entry,
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200427 const char *start)
428{
429 QObject *obj;
430 QDict *qdict;
431 QString *key_qs;
432 const char *end, *key;
433
434 if (*start != '%')
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500435 parse_error(entry, '%');
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200436 start++;
437 if (*start != '(')
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500438 parse_error(entry, '(');
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200439 start++;
440
441 end = strchr(start, ')');
442 if (!end)
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500443 parse_error(entry, ')');
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200444
445 key_qs = qstring_from_substr(start, 0, end - start - 1);
446 key = qstring_get_str(key_qs);
447
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500448 qdict = qobject_to_qdict(qdict_get(error, "data"));
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200449 obj = qdict_get(qdict, key);
450 if (!obj) {
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500451 abort();
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200452 }
453
454 switch (qobject_type(obj)) {
455 case QTYPE_QSTRING:
456 qstring_append(outstr, qdict_get_str(qdict, key));
457 break;
458 case QTYPE_QINT:
459 qstring_append_int(outstr, qdict_get_int(qdict, key));
460 break;
461 default:
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500462 abort();
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200463 }
464
465 QDECREF(key_qs);
466 return ++end;
467}
468
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500469static QString *qerror_format_desc(QDict *error,
470 const QErrorStringTable *entry)
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200471{
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200472 QString *qstring;
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500473 const char *p;
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200474
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500475 assert(entry != NULL);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200476
477 qstring = qstring_new();
478
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500479 for (p = entry->desc; *p != '\0';) {
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200480 if (*p != '%') {
481 qstring_append_chr(qstring, *p++);
482 } else if (*(p + 1) == '%') {
483 qstring_append_chr(qstring, '%');
484 p += 2;
485 } else {
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500486 p = append_field(error, qstring, entry, p);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200487 }
488 }
489
Markus Armbruster77e595e2009-12-07 21:37:16 +0100490 return qstring;
491}
492
Luiz Capitulino87c2f592011-06-01 12:14:48 -0500493QString *qerror_format(const char *fmt, QDict *error)
494{
495 const QErrorStringTable *entry = NULL;
496 int i;
497
498 for (i = 0; qerror_table[i].error_fmt; i++) {
499 if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
500 entry = &qerror_table[i];
501 break;
502 }
503 }
504
505 return qerror_format_desc(error, entry);
506}
507
Markus Armbruster77e595e2009-12-07 21:37:16 +0100508/**
Luiz Capitulinoa12eeaa2011-06-01 12:14:47 -0500509 * qerror_human(): Format QError data into human-readable string.
510 */
511QString *qerror_human(const QError *qerror)
512{
513 return qerror_format_desc(qerror->error, qerror->entry);
514}
515
516/**
Markus Armbruster77e595e2009-12-07 21:37:16 +0100517 * qerror_print(): Print QError data
518 *
519 * This function will print the member 'desc' of the specified QError object,
Markus Armbruster1ecda022010-02-18 17:25:24 +0100520 * it uses error_report() for this, so that the output is routed to the right
Markus Armbruster77e595e2009-12-07 21:37:16 +0100521 * place (ie. stderr or Monitor's device).
522 */
Markus Armbruster827b0812010-02-18 19:46:49 +0100523void qerror_print(QError *qerror)
Markus Armbruster77e595e2009-12-07 21:37:16 +0100524{
525 QString *qstring = qerror_human(qerror);
Markus Armbruster827b0812010-02-18 19:46:49 +0100526 loc_push_restore(&qerror->loc);
Markus Armbruster1ecda022010-02-18 17:25:24 +0100527 error_report("%s", qstring_get_str(qstring));
Markus Armbruster827b0812010-02-18 19:46:49 +0100528 loc_pop(&qerror->loc);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200529 QDECREF(qstring);
530}
531
Markus Armbruster0167f772010-03-22 10:29:05 +0100532void qerror_report_internal(const char *file, int linenr, const char *func,
533 const char *fmt, ...)
534{
535 va_list va;
536 QError *qerror;
537
538 va_start(va, fmt);
539 qerror = qerror_from_info(file, linenr, func, fmt, &va);
540 va_end(va);
541
542 if (monitor_cur_is_qmp()) {
543 monitor_set_error(cur_mon, qerror);
544 } else {
545 qerror_print(qerror);
546 QDECREF(qerror);
547 }
548}
549
Anthony Liguori2a82d932011-09-02 12:34:45 -0500550/* Evil... */
551struct Error
552{
553 QDict *obj;
554 const char *fmt;
555 char *msg;
556};
557
558void qerror_report_err(Error *err)
559{
560 QError *qerr;
561 int i;
562
563 qerr = qerror_new();
564 loc_save(&qerr->loc);
565 QINCREF(err->obj);
566 qerr->error = err->obj;
567
568 for (i = 0; qerror_table[i].error_fmt; i++) {
569 if (strcmp(qerror_table[i].error_fmt, err->fmt) == 0) {
570 qerr->entry = &qerror_table[i];
571 break;
572 }
573 }
574
575 if (monitor_cur_is_qmp()) {
576 monitor_set_error(cur_mon, qerr);
577 } else {
578 qerror_print(qerr);
579 QDECREF(qerr);
580 }
581}
582
Paolo Bonzini59f971d2012-02-14 10:19:53 +0100583void assert_no_error(Error *err)
584{
585 if (err) {
586 qerror_report_err(err);
587 abort();
588 }
589}
590
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200591/**
592 * qobject_to_qerror(): Convert a QObject into a QError
593 */
594QError *qobject_to_qerror(const QObject *obj)
595{
596 if (qobject_type(obj) != QTYPE_QERROR) {
597 return NULL;
598 }
599
600 return container_of(obj, QError, base);
601}
602
603/**
604 * qerror_destroy_obj(): Free all memory allocated by a QError
605 */
606static void qerror_destroy_obj(QObject *obj)
607{
608 QError *qerr;
609
610 assert(obj != NULL);
611 qerr = qobject_to_qerror(obj);
612
613 QDECREF(qerr->error);
Anthony Liguori7267c092011-08-20 22:09:37 -0500614 g_free(qerr);
Luiz Capitulino9f9daf92009-11-18 23:05:30 -0200615}