qerror.c

   1 /*
   2  * QError Module
   3  *
   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  */
  12
  13 #include "monitor.h"
  14 #include "qjson.h"
  15 #include "qerror.h"
  16 #include "qemu-common.h"
  17
  18 static void qerror_destroy_obj(QObject *obj);
  19
  20 static 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)%%"
  41  *
  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.
  45  */
  46 static const QErrorStringTable qerror_table[] = {
  47     {
  48         .error_fmt = QERR_BAD_BUS_FOR_DEVICE,
  49         .desc      = "Device '%(device)' can't go on a %(bad_bus_type) bus",
  50     },
  51     {
  52         .error_fmt = QERR_BUS_NOT_FOUND,
  53         .desc      = "Bus '%(bus)' not found",
  54     },
  55     {
  56         .error_fmt = QERR_BUS_NO_HOTPLUG,
  57         .desc      = "Bus '%(bus)' does not support hotplugging",
  58     },
  59     {
  60         .error_fmt = QERR_COMMAND_NOT_FOUND,
  61         .desc      = "The command %(name) has not been found",
  62     },
  63     {
  64         .error_fmt = QERR_DEVICE_ENCRYPTED,
  65         .desc      = "Device '%(device)' is encrypted",
  66     },
  67     {
  68         .error_fmt = QERR_DEVICE_INIT_FAILED,
  69         .desc      = "Device '%(device)' could not be initialized",
  70     },
  71     {
  72         .error_fmt = QERR_DEVICE_IN_USE,
  73         .desc      = "Device '%(device)' is in use",
  74     },
  75     {
  76         .error_fmt = QERR_DEVICE_LOCKED,
  77         .desc      = "Device '%(device)' is locked",
  78     },
  79     {
  80         .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
  81         .desc      = "Device '%(device)' has multiple child busses",
  82     },
  83     {
  84         .error_fmt = QERR_DEVICE_NOT_ACTIVE,
  85         .desc      = "Device '%(device)' has not been activated",
  86     },
  87     {
  88         .error_fmt = QERR_DEVICE_NOT_ENCRYPTED,
  89         .desc      = "Device '%(device)' is not encrypted",
  90     },
  91     {
  92         .error_fmt = QERR_DEVICE_NOT_FOUND,
  93         .desc      = "Device '%(device)' not found",
  94     },
  95     {
  96         .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
  97         .desc      = "Device '%(device)' is not removable",
  98     },
  99     {
 100         .error_fmt = QERR_DEVICE_NO_BUS,
 101         .desc      = "Device '%(device)' has no child bus",
 102     },
 103     {
 104         .error_fmt = QERR_DEVICE_NO_HOTPLUG,
 105         .desc      = "Device '%(device)' does not support hotplugging",
 106     },
 107     {
 108         .error_fmt = QERR_DUPLICATE_ID,
 109         .desc      = "Duplicate ID '%(id)' for %(object)",
 110     },
 111     {
 112         .error_fmt = QERR_FD_NOT_FOUND,
 113         .desc      = "File descriptor named '%(name)' not found",
 114     },
 115     {
 116         .error_fmt = QERR_FD_NOT_SUPPLIED,
 117         .desc      = "No file descriptor supplied via SCM_RIGHTS",
 118     },
 119     {
 120         .error_fmt = QERR_INVALID_BLOCK_FORMAT,
 121         .desc      = "Invalid block format '%(name)'",
 122     },
 123     {
 124         .error_fmt = QERR_INVALID_PARAMETER,
 125         .desc      = "Invalid parameter '%(name)'",
 126     },
 127     {
 128         .error_fmt = QERR_INVALID_PARAMETER_TYPE,
 129         .desc      = "Invalid parameter type, expected: %(expected)",
 130     },
 131     {
 132         .error_fmt = QERR_INVALID_PARAMETER_VALUE,
 133         .desc      = "Parameter '%(name)' expects %(expected)",
 134     },
 135     {
 136         .error_fmt = QERR_INVALID_PASSWORD,
 137         .desc      = "Password incorrect",
 138     },
 139     {
 140         .error_fmt = QERR_JSON_PARSING,
 141         .desc      = "Invalid JSON syntax",
 142     },
 143     {
 144         .error_fmt = QERR_KVM_MISSING_CAP,
 145         .desc      = "Using KVM without %(capability), %(feature) unavailable",
 146     },
 147     {
 148         .error_fmt = QERR_MIGRATION_EXPECTED,
 149         .desc      = "An incoming migration is expected before this command can be executed",
 150     },
 151     {
 152         .error_fmt = QERR_MISSING_PARAMETER,
 153         .desc      = "Parameter '%(name)' is missing",
 154     },
 155     {
 156         .error_fmt = QERR_NO_BUS_FOR_DEVICE,
 157         .desc      = "No '%(bus)' bus found for device '%(device)'",
 158     },
 159     {
 160         .error_fmt = QERR_OPEN_FILE_FAILED,
 161         .desc      = "Could not open '%(filename)'",
 162     },
 163     {
 164         .error_fmt = QERR_PROPERTY_NOT_FOUND,
 165         .desc      = "Property '%(device).%(property)' not found",
 166     },
 167     {
 168         .error_fmt = QERR_PROPERTY_VALUE_BAD,
 169         .desc      = "Property '%(device).%(property)' doesn't take value '%(value)'",
 170     },
 171     {
 172         .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
 173         .desc      = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
 174     },
 175     {
 176         .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
 177         .desc      = "Property '%(device).%(property)' can't find value '%(value)'",
 178     },
 179     {
 180         .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
 181         .desc      = "Expected '%(expected)' in QMP input",
 182     },
 183     {
 184         .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
 185         .desc      = "QMP input object member '%(member)' expects '%(expected)'",
 186     },
 187     {
 188         .error_fmt = QERR_QMP_EXTRA_MEMBER,
 189         .desc      = "QMP input object member '%(member)' is unexpected",
 190     },
 191     {
 192         .error_fmt = QERR_SET_PASSWD_FAILED,
 193         .desc      = "Could not set password",
 194     },
 195     {
 196         .error_fmt = QERR_TOO_MANY_FILES,
 197         .desc      = "Too many open files",
 198     },
 199     {
 200         .error_fmt = QERR_UNDEFINED_ERROR,
 201         .desc      = "An undefined error has ocurred",
 202     },
 203     {
 204         .error_fmt = QERR_VNC_SERVER_FAILED,
 205         .desc      = "Could not start VNC server on %(target)",
 206     },
 207     {}
 208 };
 209
 210 /**
 211  * qerror_new(): Create a new QError
 212  *
 213  * Return strong reference.
 214  */
 215 QError *qerror_new(void)
 216 {
 217     QError *qerr;
 218
 219     qerr = qemu_mallocz(sizeof(*qerr));
 220     QOBJECT_INIT(qerr, &qerror_type);
 221
 222     return qerr;
 223 }
 224
 225 static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr,
 226                                             const char *fmt, ...)
 227 {
 228     va_list ap;
 229
 230     fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
 231     fprintf(stderr, "qerror: -> ");
 232
 233     va_start(ap, fmt);
 234     vfprintf(stderr, fmt, ap);
 235     va_end(ap);
 236
 237     fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
 238     abort();
 239 }
 240
 241 static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr,
 242                                                const char *fmt, va_list *va)
 243 {
 244     QObject *obj;
 245
 246     obj = qobject_from_jsonv(fmt, va);
 247     if (!obj) {
 248         qerror_abort(qerr, "invalid format '%s'", fmt);
 249     }
 250     if (qobject_type(obj) != QTYPE_QDICT) {
 251         qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
 252     }
 253
 254     qerr->error = qobject_to_qdict(obj);
 255
 256     obj = qdict_get(qerr->error, "class");
 257     if (!obj) {
 258         qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
 259     }
 260     if (qobject_type(obj) != QTYPE_QSTRING) {
 261         qerror_abort(qerr, "'class' key value should be a QString");
 262     }
 263
 264     obj = qdict_get(qerr->error, "data");
 265     if (!obj) {
 266         qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
 267     }
 268     if (qobject_type(obj) != QTYPE_QDICT) {
 269         qerror_abort(qerr, "'data' key value should be a QDICT");
 270     }
 271 }
 272
 273 static void qerror_set_desc(QError *qerr, const char *fmt)
 274 {
 275     int i;
 276
 277     // FIXME: inefficient loop
 278
 279     for (i = 0; qerror_table[i].error_fmt; i++) {
 280         if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
 281             qerr->entry = &qerror_table[i];
 282             return;
 283         }
 284     }
 285
 286     qerror_abort(qerr, "error format '%s' not found", fmt);
 287 }
 288
 289 /**
 290  * qerror_from_info(): Create a new QError from error information
 291  *
 292  * The information consists of:
 293  *
 294  * - file   the file name of where the error occurred
 295  * - linenr the line number of where the error occurred
 296  * - func   the function name of where the error occurred
 297  * - fmt    JSON printf-like dictionary, there must exist keys 'class' and
 298  *          'data'
 299  * - va     va_list of all arguments specified by fmt
 300  *
 301  * Return strong reference.
 302  */
 303 QError *qerror_from_info(const char *file, int linenr, const char *func,
 304                          const char *fmt, va_list *va)
 305 {
 306     QError *qerr;
 307
 308     qerr = qerror_new();
 309     loc_save(&qerr->loc);
 310     qerr->linenr = linenr;
 311     qerr->file = file;
 312     qerr->func = func;
 313
 314     if (!fmt) {
 315         qerror_abort(qerr, "QDict not specified");
 316     }
 317
 318     qerror_set_data(qerr, fmt, va);
 319     qerror_set_desc(qerr, fmt);
 320
 321     return qerr;
 322 }
 323
 324 static void parse_error(const QError *qerror, int c)
 325 {
 326     qerror_abort(qerror, "expected '%c' in '%s'", c, qerror->entry->desc);
 327 }
 328
 329 static const char *append_field(QString *outstr, const QError *qerror,
 330                                 const char *start)
 331 {
 332     QObject *obj;
 333     QDict *qdict;
 334     QString *key_qs;
 335     const char *end, *key;
 336
 337     if (*start != '%')
 338         parse_error(qerror, '%');
 339     start++;
 340     if (*start != '(')
 341         parse_error(qerror, '(');
 342     start++;
 343
 344     end = strchr(start, ')');
 345     if (!end)
 346         parse_error(qerror, ')');
 347
 348     key_qs = qstring_from_substr(start, 0, end - start - 1);
 349     key = qstring_get_str(key_qs);
 350
 351     qdict = qobject_to_qdict(qdict_get(qerror->error, "data"));
 352     obj = qdict_get(qdict, key);
 353     if (!obj) {
 354         qerror_abort(qerror, "key '%s' not found in QDict", key);
 355     }
 356
 357     switch (qobject_type(obj)) {
 358         case QTYPE_QSTRING:
 359             qstring_append(outstr, qdict_get_str(qdict, key));
 360             break;
 361         case QTYPE_QINT:
 362             qstring_append_int(outstr, qdict_get_int(qdict, key));
 363             break;
 364         default:
 365             qerror_abort(qerror, "invalid type '%c'", qobject_type(obj));
 366     }
 367
 368     QDECREF(key_qs);
 369     return ++end;
 370 }
 371
 372 /**
 373  * qerror_human(): Format QError data into human-readable string.
 374  *
 375  * Formats according to member 'desc' of the specified QError object.
 376  */
 377 QString *qerror_human(const QError *qerror)
 378 {
 379     const char *p;
 380     QString *qstring;
 381
 382     assert(qerror->entry != NULL);
 383
 384     qstring = qstring_new();
 385
 386     for (p = qerror->entry->desc; *p != '\0';) {
 387         if (*p != '%') {
 388             qstring_append_chr(qstring, *p++);
 389         } else if (*(p + 1) == '%') {
 390             qstring_append_chr(qstring, '%');
 391             p += 2;
 392         } else {
 393             p = append_field(qstring, qerror, p);
 394         }
 395     }
 396
 397     return qstring;
 398 }
 399
 400 /**
 401  * qerror_print(): Print QError data
 402  *
 403  * This function will print the member 'desc' of the specified QError object,
 404  * it uses error_report() for this, so that the output is routed to the right
 405  * place (ie. stderr or Monitor's device).
 406  */
 407 void qerror_print(QError *qerror)
 408 {
 409     QString *qstring = qerror_human(qerror);
 410     loc_push_restore(&qerror->loc);
 411     error_report("%s", qstring_get_str(qstring));
 412     loc_pop(&qerror->loc);
 413     QDECREF(qstring);
 414 }
 415
 416 void qerror_report_internal(const char *file, int linenr, const char *func,
 417                             const char *fmt, ...)
 418 {
 419     va_list va;
 420     QError *qerror;
 421
 422     va_start(va, fmt);
 423     qerror = qerror_from_info(file, linenr, func, fmt, &va);
 424     va_end(va);
 425
 426     if (monitor_cur_is_qmp()) {
 427         monitor_set_error(cur_mon, qerror);
 428     } else {
 429         qerror_print(qerror);
 430         QDECREF(qerror);
 431     }
 432 }
 433
 434 /**
 435  * qobject_to_qerror(): Convert a QObject into a QError
 436  */
 437 QError *qobject_to_qerror(const QObject *obj)
 438 {
 439     if (qobject_type(obj) != QTYPE_QERROR) {
 440         return NULL;
 441     }
 442
 443     return container_of(obj, QError, base);
 444 }
 445
 446 /**
 447  * qerror_destroy_obj(): Free all memory allocated by a QError
 448  */
 449 static void qerror_destroy_obj(QObject *obj)
 450 {
 451     QError *qerr;
 452
 453     assert(obj != NULL);
 454     qerr = qobject_to_qerror(obj);
 455
 456     QDECREF(qerr->error);
 457     qemu_free(qerr);
 458 }