Annotation of qemu/qerror.c, revision 1.1.1.4

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

unix.superglobalmegacorp.com