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_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED,
  53         .desc      = "Block format '%(format)' used by device '%(name)' does not support feature '%(feature)'",
  54     },
  55     {
  56         .error_fmt = QERR_BUS_NOT_FOUND,
  57         .desc      = "Bus '%(bus)' not found",
  58     },
  59     {
  60         .error_fmt = QERR_BUS_NO_HOTPLUG,
  61         .desc      = "Bus '%(bus)' does not support hotplugging",
  62     },
  63     {
  64         .error_fmt = QERR_COMMAND_NOT_FOUND,
  65         .desc      = "The command %(name) has not been found",
  66     },
  67     {
  68         .error_fmt = QERR_DEVICE_ENCRYPTED,
  69         .desc      = "Device '%(device)' is encrypted",
  70     },
  71     {
  72         .error_fmt = QERR_DEVICE_INIT_FAILED,
  73         .desc      = "Device '%(device)' could not be initialized",
  74     },
  75     {
  76         .error_fmt = QERR_DEVICE_IN_USE,
  77         .desc      = "Device '%(device)' is in use",
  78     },
  79     {
  80         .error_fmt = QERR_DEVICE_FEATURE_BLOCKS_MIGRATION,
  81         .desc      = "Migration is disabled when using feature '%(feature)' in device '%(device)'",
  82     },
  83     {
  84         .error_fmt = QERR_DEVICE_LOCKED,
  85         .desc      = "Device '%(device)' is locked",
  86     },
  87     {
  88         .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
  89         .desc      = "Device '%(device)' has multiple child busses",
  90     },
  91     {
  92         .error_fmt = QERR_DEVICE_NOT_ACTIVE,
  93         .desc      = "Device '%(device)' has not been activated",
  94     },
  95     {
  96         .error_fmt = QERR_DEVICE_NOT_ENCRYPTED,
  97         .desc      = "Device '%(device)' is not encrypted",
  98     },
  99     {
 100         .error_fmt = QERR_DEVICE_NOT_FOUND,
 101         .desc      = "Device '%(device)' not found",
 102     },
 103     {
 104         .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
 105         .desc      = "Device '%(device)' is not removable",
 106     },
 107     {
 108         .error_fmt = QERR_DEVICE_NO_BUS,
 109         .desc      = "Device '%(device)' has no child bus",
 110     },
 111     {
 112         .error_fmt = QERR_DEVICE_NO_HOTPLUG,
 113         .desc      = "Device '%(device)' does not support hotplugging",
 114     },
 115     {
 116         .error_fmt = QERR_DUPLICATE_ID,
 117         .desc      = "Duplicate ID '%(id)' for %(object)",
 118     },
 119     {
 120         .error_fmt = QERR_FD_NOT_FOUND,
 121         .desc      = "File descriptor named '%(name)' not found",
 122     },
 123     {
 124         .error_fmt = QERR_FD_NOT_SUPPLIED,
 125         .desc      = "No file descriptor supplied via SCM_RIGHTS",
 126     },
 127     {
 128         .error_fmt = QERR_FEATURE_DISABLED,
 129         .desc      = "The feature '%(name)' is not enabled",
 130     },
 131     {
 132         .error_fmt = QERR_INVALID_BLOCK_FORMAT,
 133         .desc      = "Invalid block format '%(name)'",
 134     },
 135     {
 136         .error_fmt = QERR_INVALID_PARAMETER,
 137         .desc      = "Invalid parameter '%(name)'",
 138     },
 139     {
 140         .error_fmt = QERR_INVALID_PARAMETER_TYPE,
 141         .desc      = "Invalid parameter type, expected: %(expected)",
 142     },
 143     {
 144         .error_fmt = QERR_INVALID_PARAMETER_VALUE,
 145         .desc      = "Parameter '%(name)' expects %(expected)",
 146     },
 147     {
 148         .error_fmt = QERR_INVALID_PASSWORD,
 149         .desc      = "Password incorrect",
 150     },
 151     {
 152         .error_fmt = QERR_JSON_PARSING,
 153         .desc      = "Invalid JSON syntax",
 154     },
 155     {
 156         .error_fmt = QERR_JSON_PARSE_ERROR,
 157         .desc      = "JSON parse error, %(message)",
 158
 159     },
 160     {
 161         .error_fmt = QERR_KVM_MISSING_CAP,
 162         .desc      = "Using KVM without %(capability), %(feature) unavailable",
 163     },
 164     {
 165         .error_fmt = QERR_MIGRATION_EXPECTED,
 166         .desc      = "An incoming migration is expected before this command can be executed",
 167     },
 168     {
 169         .error_fmt = QERR_MISSING_PARAMETER,
 170         .desc      = "Parameter '%(name)' is missing",
 171     },
 172     {
 173         .error_fmt = QERR_NO_BUS_FOR_DEVICE,
 174         .desc      = "No '%(bus)' bus found for device '%(device)'",
 175     },
 176     {
 177         .error_fmt = QERR_OPEN_FILE_FAILED,
 178         .desc      = "Could not open '%(filename)'",
 179     },
 180     {
 181         .error_fmt = QERR_PROPERTY_NOT_FOUND,
 182         .desc      = "Property '%(device).%(property)' not found",
 183     },
 184     {
 185         .error_fmt = QERR_PROPERTY_VALUE_BAD,
 186         .desc      = "Property '%(device).%(property)' doesn't take value '%(value)'",
 187     },
 188     {
 189         .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
 190         .desc      = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
 191     },
 192     {
 193         .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
 194         .desc      = "Property '%(device).%(property)' can't find value '%(value)'",
 195     },
 196     {
 197         .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
 198         .desc      = "Expected '%(expected)' in QMP input",
 199     },
 200     {
 201         .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER,
 202         .desc      = "QMP input object member '%(member)' expects '%(expected)'",
 203     },
 204     {
 205         .error_fmt = QERR_QMP_EXTRA_MEMBER,
 206         .desc      = "QMP input object member '%(member)' is unexpected",
 207     },
 208     {
 209         .error_fmt = QERR_RESET_REQUIRED,
 210         .desc      = "Resetting the Virtual Machine is required",
 211     },
 212     {
 213         .error_fmt = QERR_SET_PASSWD_FAILED,
 214         .desc      = "Could not set password",
 215     },
 216     {
 217         .error_fmt = QERR_ADD_CLIENT_FAILED,
 218         .desc      = "Could not add client",
 219     },
 220     {
 221         .error_fmt = QERR_TOO_MANY_FILES,
 222         .desc      = "Too many open files",
 223     },
 224     {
 225         .error_fmt = QERR_UNDEFINED_ERROR,
 226         .desc      = "An undefined error has occurred",
 227     },
 228     {
 229         .error_fmt = QERR_UNSUPPORTED,
 230         .desc      = "this feature or command is not currently supported",
 231     },
 232     {
 233         .error_fmt = QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
 234         .desc      = "'%(device)' uses a %(format) feature which is not "
 235                      "supported by this qemu version: %(feature)",
 236     },
 237     {
 238         .error_fmt = QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION,
 239         .desc      = "Migration is disabled when VirtFS export path '%(path)' "
 240                      "is mounted in the guest using mount_tag '%(tag)'",
 241     },
 242     {
 243         .error_fmt = QERR_VNC_SERVER_FAILED,
 244         .desc      = "Could not start VNC server on %(target)",
 245     },
 246     {
 247         .error_fmt = QERR_QGA_LOGGING_FAILED,
 248         .desc      = "Guest agent failed to log non-optional log statement",
 249     },
 250     {
 251         .error_fmt = QERR_QGA_COMMAND_FAILED,
 252         .desc      = "Guest agent command failed, error was '%(message)'",
 253     },
 254     {
 255         .error_fmt = QERR_INVALID_PARAMETER_COMBINATION,
 256         .desc      = "Invalid paramter combination",
 257     },
 258     {}
 259 };
 260
 261 /**
 262  * qerror_new(): Create a new QError
 263  *
 264  * Return strong reference.
 265  */
 266 QError *qerror_new(void)
 267 {
 268     QError *qerr;
 269
 270     qerr = g_malloc0(sizeof(*qerr));
 271     QOBJECT_INIT(qerr, &qerror_type);
 272
 273     return qerr;
 274 }
 275
 276 static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr,
 277                                             const char *fmt, ...)
 278 {
 279     va_list ap;
 280
 281     fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
 282     fprintf(stderr, "qerror: -> ");
 283
 284     va_start(ap, fmt);
 285     vfprintf(stderr, fmt, ap);
 286     va_end(ap);
 287
 288     fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
 289     abort();
 290 }
 291
 292 static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr,
 293                                                const char *fmt, va_list *va)
 294 {
 295     QObject *obj;
 296
 297     obj = qobject_from_jsonv(fmt, va);
 298     if (!obj) {
 299         qerror_abort(qerr, "invalid format '%s'", fmt);
 300     }
 301     if (qobject_type(obj) != QTYPE_QDICT) {
 302         qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
 303     }
 304
 305     qerr->error = qobject_to_qdict(obj);
 306
 307     obj = qdict_get(qerr->error, "class");
 308     if (!obj) {
 309         qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
 310     }
 311     if (qobject_type(obj) != QTYPE_QSTRING) {
 312         qerror_abort(qerr, "'class' key value should be a QString");
 313     }
 314
 315     obj = qdict_get(qerr->error, "data");
 316     if (!obj) {
 317         qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
 318     }
 319     if (qobject_type(obj) != QTYPE_QDICT) {
 320         qerror_abort(qerr, "'data' key value should be a QDICT");
 321     }
 322 }
 323
 324 static void qerror_set_desc(QError *qerr, const char *fmt)
 325 {
 326     int i;
 327
 328     // FIXME: inefficient loop
 329
 330     for (i = 0; qerror_table[i].error_fmt; i++) {
 331         if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
 332             qerr->entry = &qerror_table[i];
 333             return;
 334         }
 335     }
 336
 337     qerror_abort(qerr, "error format '%s' not found", fmt);
 338 }
 339
 340 /**
 341  * qerror_from_info(): Create a new QError from error information
 342  *
 343  * The information consists of:
 344  *
 345  * - file   the file name of where the error occurred
 346  * - linenr the line number of where the error occurred
 347  * - func   the function name of where the error occurred
 348  * - fmt    JSON printf-like dictionary, there must exist keys 'class' and
 349  *          'data'
 350  * - va     va_list of all arguments specified by fmt
 351  *
 352  * Return strong reference.
 353  */
 354 QError *qerror_from_info(const char *file, int linenr, const char *func,
 355                          const char *fmt, va_list *va)
 356 {
 357     QError *qerr;
 358
 359     qerr = qerror_new();
 360     loc_save(&qerr->loc);
 361     qerr->linenr = linenr;
 362     qerr->file = file;
 363     qerr->func = func;
 364
 365     if (!fmt) {
 366         qerror_abort(qerr, "QDict not specified");
 367     }
 368
 369     qerror_set_data(qerr, fmt, va);
 370     qerror_set_desc(qerr, fmt);
 371
 372     return qerr;
 373 }
 374
 375 static void parse_error(const QErrorStringTable *entry, int c)
 376 {
 377     fprintf(stderr, "expected '%c' in '%s'", c, entry->desc);
 378     abort();
 379 }
 380
 381 static const char *append_field(QDict *error, QString *outstr,
 382                                 const QErrorStringTable *entry,
 383                                 const char *start)
 384 {
 385     QObject *obj;
 386     QDict *qdict;
 387     QString *key_qs;
 388     const char *end, *key;
 389
 390     if (*start != '%')
 391         parse_error(entry, '%');
 392     start++;
 393     if (*start != '(')
 394         parse_error(entry, '(');
 395     start++;
 396
 397     end = strchr(start, ')');
 398     if (!end)
 399         parse_error(entry, ')');
 400
 401     key_qs = qstring_from_substr(start, 0, end - start - 1);
 402     key = qstring_get_str(key_qs);
 403
 404     qdict = qobject_to_qdict(qdict_get(error, "data"));
 405     obj = qdict_get(qdict, key);
 406     if (!obj) {
 407         abort();
 408     }
 409
 410     switch (qobject_type(obj)) {
 411         case QTYPE_QSTRING:
 412             qstring_append(outstr, qdict_get_str(qdict, key));
 413             break;
 414         case QTYPE_QINT:
 415             qstring_append_int(outstr, qdict_get_int(qdict, key));
 416             break;
 417         default:
 418             abort();
 419     }
 420
 421     QDECREF(key_qs);
 422     return ++end;
 423 }
 424
 425 static QString *qerror_format_desc(QDict *error,
 426                                    const QErrorStringTable *entry)
 427 {
 428     QString *qstring;
 429     const char *p;
 430
 431     assert(entry != NULL);
 432
 433     qstring = qstring_new();
 434
 435     for (p = entry->desc; *p != '\0';) {
 436         if (*p != '%') {
 437             qstring_append_chr(qstring, *p++);
 438         } else if (*(p + 1) == '%') {
 439             qstring_append_chr(qstring, '%');
 440             p += 2;
 441         } else {
 442             p = append_field(error, qstring, entry, p);
 443         }
 444     }
 445
 446     return qstring;
 447 }
 448
 449 QString *qerror_format(const char *fmt, QDict *error)
 450 {
 451     const QErrorStringTable *entry = NULL;
 452     int i;
 453
 454     for (i = 0; qerror_table[i].error_fmt; i++) {
 455         if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
 456             entry = &qerror_table[i];
 457             break;
 458         }
 459     }
 460
 461     return qerror_format_desc(error, entry);
 462 }
 463
 464 /**
 465  * qerror_human(): Format QError data into human-readable string.
 466  */
 467 QString *qerror_human(const QError *qerror)
 468 {
 469     return qerror_format_desc(qerror->error, qerror->entry);
 470 }
 471
 472 /**
 473  * qerror_print(): Print QError data
 474  *
 475  * This function will print the member 'desc' of the specified QError object,
 476  * it uses error_report() for this, so that the output is routed to the right
 477  * place (ie. stderr or Monitor's device).
 478  */
 479 void qerror_print(QError *qerror)
 480 {
 481     QString *qstring = qerror_human(qerror);
 482     loc_push_restore(&qerror->loc);
 483     error_report("%s", qstring_get_str(qstring));
 484     loc_pop(&qerror->loc);
 485     QDECREF(qstring);
 486 }
 487
 488 void qerror_report_internal(const char *file, int linenr, const char *func,
 489                             const char *fmt, ...)
 490 {
 491     va_list va;
 492     QError *qerror;
 493
 494     va_start(va, fmt);
 495     qerror = qerror_from_info(file, linenr, func, fmt, &va);
 496     va_end(va);
 497
 498     if (monitor_cur_is_qmp()) {
 499         monitor_set_error(cur_mon, qerror);
 500     } else {
 501         qerror_print(qerror);
 502         QDECREF(qerror);
 503     }
 504 }
 505
 506 /* Evil... */
 507 struct Error
 508 {
 509     QDict *obj;
 510     const char *fmt;
 511     char *msg;
 512 };
 513
 514 void qerror_report_err(Error *err)
 515 {
 516     QError *qerr;
 517     int i;
 518
 519     qerr = qerror_new();
 520     loc_save(&qerr->loc);
 521     QINCREF(err->obj);
 522     qerr->error = err->obj;
 523
 524     for (i = 0; qerror_table[i].error_fmt; i++) {
 525         if (strcmp(qerror_table[i].error_fmt, err->fmt) == 0) {
 526             qerr->entry = &qerror_table[i];
 527             break;
 528         }
 529     }
 530
 531     if (monitor_cur_is_qmp()) {
 532         monitor_set_error(cur_mon, qerr);
 533     } else {
 534         qerror_print(qerr);
 535         QDECREF(qerr);
 536     }
 537 }
 538
 539 /**
 540  * qobject_to_qerror(): Convert a QObject into a QError
 541  */
 542 QError *qobject_to_qerror(const QObject *obj)
 543 {
 544     if (qobject_type(obj) != QTYPE_QERROR) {
 545         return NULL;
 546     }
 547
 548     return container_of(obj, QError, base);
 549 }
 550
 551 /**
 552  * qerror_destroy_obj(): Free all memory allocated by a QError
 553  */
 554 static void qerror_destroy_obj(QObject *obj)
 555 {
 556     QError *qerr;
 557
 558     assert(obj != NULL);
 559     qerr = qobject_to_qerror(obj);
 560
 561     QDECREF(qerr->error);
 562     g_free(qerr);
 563 }