Annotation of qemu/qerror.c, revision 1.1.1.2

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

unix.superglobalmegacorp.com