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