Statistics
| Branch: | Revision:

root / qerror.c @ e3d4d252

History | View | Annotate | Download (12.8 kB)

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_JSON_PARSE_ERROR,
145
        .desc      = "JSON parse error, %(message)",
146

    
147
    },
148
    {
149
        .error_fmt = QERR_KVM_MISSING_CAP,
150
        .desc      = "Using KVM without %(capability), %(feature) unavailable",
151
    },
152
    {
153
        .error_fmt = QERR_MIGRATION_EXPECTED,
154
        .desc      = "An incoming migration is expected before this command can be executed",
155
    },
156
    {
157
        .error_fmt = QERR_MISSING_PARAMETER,
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)'",
183
    },
184
    {
185
        .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
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",
195
    },
196
    {
197
        .error_fmt = QERR_SET_PASSWD_FAILED,
198
        .desc      = "Could not set password",
199
    },
200
    {
201
        .error_fmt = QERR_TOO_MANY_FILES,
202
        .desc      = "Too many open files",
203
    },
204
    {
205
        .error_fmt = QERR_UNDEFINED_ERROR,
206
        .desc      = "An undefined error has ocurred",
207
    },
208
    {
209
        .error_fmt = QERR_UNSUPPORTED,
210
        .desc      = "this feature or command is not currently supported",
211
    },
212
    {
213
        .error_fmt = QERR_UNKNOWN_BLOCK_FORMAT_FEATURE,
214
        .desc      = "'%(device)' uses a %(format) feature which is not "
215
                     "supported by this qemu version: %(feature)",
216
    },
217
    {
218
        .error_fmt = QERR_VNC_SERVER_FAILED,
219
        .desc      = "Could not start VNC server on %(target)",
220
    },
221
    {
222
        .error_fmt = QERR_QGA_LOGGING_FAILED,
223
        .desc      = "Guest agent failed to log non-optional log statement",
224
    },
225
    {
226
        .error_fmt = QERR_QGA_COMMAND_FAILED,
227
        .desc      = "Guest agent command failed, error was '%(message)'",
228
    },
229
    {}
230
};
231

    
232
/**
233
 * qerror_new(): Create a new QError
234
 *
235
 * Return strong reference.
236
 */
237
QError *qerror_new(void)
238
{
239
    QError *qerr;
240

    
241
    qerr = qemu_mallocz(sizeof(*qerr));
242
    QOBJECT_INIT(qerr, &qerror_type);
243

    
244
    return qerr;
245
}
246

    
247
static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr,
248
                                            const char *fmt, ...)
249
{
250
    va_list ap;
251

    
252
    fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
253
    fprintf(stderr, "qerror: -> ");
254

    
255
    va_start(ap, fmt);
256
    vfprintf(stderr, fmt, ap);
257
    va_end(ap);
258

    
259
    fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
260
    abort();
261
}
262

    
263
static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr,
264
                                               const char *fmt, va_list *va)
265
{
266
    QObject *obj;
267

    
268
    obj = qobject_from_jsonv(fmt, va);
269
    if (!obj) {
270
        qerror_abort(qerr, "invalid format '%s'", fmt);
271
    }
272
    if (qobject_type(obj) != QTYPE_QDICT) {
273
        qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
274
    }
275

    
276
    qerr->error = qobject_to_qdict(obj);
277

    
278
    obj = qdict_get(qerr->error, "class");
279
    if (!obj) {
280
        qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
281
    }
282
    if (qobject_type(obj) != QTYPE_QSTRING) {
283
        qerror_abort(qerr, "'class' key value should be a QString");
284
    }
285
    
286
    obj = qdict_get(qerr->error, "data");
287
    if (!obj) {
288
        qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
289
    }
290
    if (qobject_type(obj) != QTYPE_QDICT) {
291
        qerror_abort(qerr, "'data' key value should be a QDICT");
292
    }
293
}
294

    
295
static void qerror_set_desc(QError *qerr, const char *fmt)
296
{
297
    int i;
298

    
299
    // FIXME: inefficient loop
300

    
301
    for (i = 0; qerror_table[i].error_fmt; i++) {
302
        if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
303
            qerr->entry = &qerror_table[i];
304
            return;
305
        }
306
    }
307

    
308
    qerror_abort(qerr, "error format '%s' not found", fmt);
309
}
310

    
311
/**
312
 * qerror_from_info(): Create a new QError from error information
313
 *
314
 * The information consists of:
315
 *
316
 * - file   the file name of where the error occurred
317
 * - linenr the line number of where the error occurred
318
 * - func   the function name of where the error occurred
319
 * - fmt    JSON printf-like dictionary, there must exist keys 'class' and
320
 *          'data'
321
 * - va     va_list of all arguments specified by fmt
322
 *
323
 * Return strong reference.
324
 */
325
QError *qerror_from_info(const char *file, int linenr, const char *func,
326
                         const char *fmt, va_list *va)
327
{
328
    QError *qerr;
329

    
330
    qerr = qerror_new();
331
    loc_save(&qerr->loc);
332
    qerr->linenr = linenr;
333
    qerr->file = file;
334
    qerr->func = func;
335

    
336
    if (!fmt) {
337
        qerror_abort(qerr, "QDict not specified");
338
    }
339

    
340
    qerror_set_data(qerr, fmt, va);
341
    qerror_set_desc(qerr, fmt);
342

    
343
    return qerr;
344
}
345

    
346
static void parse_error(const QErrorStringTable *entry, int c)
347
{
348
    fprintf(stderr, "expected '%c' in '%s'", c, entry->desc);
349
    abort();
350
}
351

    
352
static const char *append_field(QDict *error, QString *outstr,
353
                                const QErrorStringTable *entry,
354
                                const char *start)
355
{
356
    QObject *obj;
357
    QDict *qdict;
358
    QString *key_qs;
359
    const char *end, *key;
360

    
361
    if (*start != '%')
362
        parse_error(entry, '%');
363
    start++;
364
    if (*start != '(')
365
        parse_error(entry, '(');
366
    start++;
367

    
368
    end = strchr(start, ')');
369
    if (!end)
370
        parse_error(entry, ')');
371

    
372
    key_qs = qstring_from_substr(start, 0, end - start - 1);
373
    key = qstring_get_str(key_qs);
374

    
375
    qdict = qobject_to_qdict(qdict_get(error, "data"));
376
    obj = qdict_get(qdict, key);
377
    if (!obj) {
378
        abort();
379
    }
380

    
381
    switch (qobject_type(obj)) {
382
        case QTYPE_QSTRING:
383
            qstring_append(outstr, qdict_get_str(qdict, key));
384
            break;
385
        case QTYPE_QINT:
386
            qstring_append_int(outstr, qdict_get_int(qdict, key));
387
            break;
388
        default:
389
            abort();
390
    }
391

    
392
    QDECREF(key_qs);
393
    return ++end;
394
}
395

    
396
static QString *qerror_format_desc(QDict *error,
397
                                   const QErrorStringTable *entry)
398
{
399
    QString *qstring;
400
    const char *p;
401

    
402
    assert(entry != NULL);
403

    
404
    qstring = qstring_new();
405

    
406
    for (p = entry->desc; *p != '\0';) {
407
        if (*p != '%') {
408
            qstring_append_chr(qstring, *p++);
409
        } else if (*(p + 1) == '%') {
410
            qstring_append_chr(qstring, '%');
411
            p += 2;
412
        } else {
413
            p = append_field(error, qstring, entry, p);
414
        }
415
    }
416

    
417
    return qstring;
418
}
419

    
420
QString *qerror_format(const char *fmt, QDict *error)
421
{
422
    const QErrorStringTable *entry = NULL;
423
    int i;
424

    
425
    for (i = 0; qerror_table[i].error_fmt; i++) {
426
        if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
427
            entry = &qerror_table[i];
428
            break;
429
        }
430
    }
431

    
432
    return qerror_format_desc(error, entry);
433
}
434

    
435
/**
436
 * qerror_human(): Format QError data into human-readable string.
437
 */
438
QString *qerror_human(const QError *qerror)
439
{
440
    return qerror_format_desc(qerror->error, qerror->entry);
441
}
442

    
443
/**
444
 * qerror_print(): Print QError data
445
 *
446
 * This function will print the member 'desc' of the specified QError object,
447
 * it uses error_report() for this, so that the output is routed to the right
448
 * place (ie. stderr or Monitor's device).
449
 */
450
void qerror_print(QError *qerror)
451
{
452
    QString *qstring = qerror_human(qerror);
453
    loc_push_restore(&qerror->loc);
454
    error_report("%s", qstring_get_str(qstring));
455
    loc_pop(&qerror->loc);
456
    QDECREF(qstring);
457
}
458

    
459
void qerror_report_internal(const char *file, int linenr, const char *func,
460
                            const char *fmt, ...)
461
{
462
    va_list va;
463
    QError *qerror;
464

    
465
    va_start(va, fmt);
466
    qerror = qerror_from_info(file, linenr, func, fmt, &va);
467
    va_end(va);
468

    
469
    if (monitor_cur_is_qmp()) {
470
        monitor_set_error(cur_mon, qerror);
471
    } else {
472
        qerror_print(qerror);
473
        QDECREF(qerror);
474
    }
475
}
476

    
477
/**
478
 * qobject_to_qerror(): Convert a QObject into a QError
479
 */
480
QError *qobject_to_qerror(const QObject *obj)
481
{
482
    if (qobject_type(obj) != QTYPE_QERROR) {
483
        return NULL;
484
    }
485

    
486
    return container_of(obj, QError, base);
487
}
488

    
489
/**
490
 * qerror_destroy_obj(): Free all memory allocated by a QError
491
 */
492
static void qerror_destroy_obj(QObject *obj)
493
{
494
    QError *qerr;
495

    
496
    assert(obj != NULL);
497
    qerr = qobject_to_qerror(obj);
498

    
499
    QDECREF(qerr->error);
500
    qemu_free(qerr);
501
}