Statistics
| Branch: | Revision:

root / qerror.c @ 8eae73b5

History | View | Annotate | Download (9.9 kB)

1
/*
2
 * QError: QEMU Error data-type.
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
#include "qjson.h"
13
#include "qerror.h"
14
#include "qstring.h"
15
#include "qemu-common.h"
16
#include "qemu-error.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
static const QErrorStringTable qerror_table[] = {
43
    {
44
        .error_fmt = QERR_BAD_BUS_FOR_DEVICE,
45
        .desc      = "Device '%(device)' can't go on a %(bad_bus_type) bus",
46
    },
47
    {
48
        .error_fmt = QERR_BUS_NOT_FOUND,
49
        .desc      = "Bus '%(bus)' not found",
50
    },
51
    {
52
        .error_fmt = QERR_BUS_NO_HOTPLUG,
53
        .desc      = "Bus '%(bus)' does not support hotplugging",
54
    },
55
    {
56
        .error_fmt = QERR_COMMAND_NOT_FOUND,
57
        .desc      = "The command %(name) has not been found",
58
    },
59
    {
60
        .error_fmt = QERR_DEVICE_ENCRYPTED,
61
        .desc      = "Device '%(device)' is encrypted",
62
    },
63
    {
64
        .error_fmt = QERR_DEVICE_LOCKED,
65
        .desc      = "Device '%(device)' is locked",
66
    },
67
    {
68
        .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES,
69
        .desc      = "Device '%(device)' has multiple child busses",
70
    },
71
    {
72
        .error_fmt = QERR_DEVICE_NOT_ACTIVE,
73
        .desc      = "Device '%(device)' has not been activated by the guest",
74
    },
75
    {
76
        .error_fmt = QERR_DEVICE_NOT_FOUND,
77
        .desc      = "Device '%(device)' not found",
78
    },
79
    {
80
        .error_fmt = QERR_DEVICE_NOT_REMOVABLE,
81
        .desc      = "Device '%(device)' is not removable",
82
    },
83
    {
84
        .error_fmt = QERR_DEVICE_NO_BUS,
85
        .desc      = "Device '%(device)' has no child bus",
86
    },
87
    {
88
        .error_fmt = QERR_FD_NOT_FOUND,
89
        .desc      = "File descriptor named '%(name)' not found",
90
    },
91
    {
92
        .error_fmt = QERR_FD_NOT_SUPPLIED,
93
        .desc      = "No file descriptor supplied via SCM_RIGHTS",
94
    },
95
    {
96
        .error_fmt = QERR_INVALID_BLOCK_FORMAT,
97
        .desc      = "Invalid block format '%(name)'",
98
    },
99
    {
100
        .error_fmt = QERR_INVALID_PARAMETER,
101
        .desc      = "Invalid parameter '%(name)'",
102
    },
103
    {
104
        .error_fmt = QERR_INVALID_PARAMETER_TYPE,
105
        .desc      = "Invalid parameter type, expected: %(expected)",
106
    },
107
    {
108
        .error_fmt = QERR_INVALID_PASSWORD,
109
        .desc      = "Password incorrect",
110
    },
111
    {
112
        .error_fmt = QERR_JSON_PARSING,
113
        .desc      = "Invalid JSON syntax",
114
    },
115
    {
116
        .error_fmt = QERR_KVM_MISSING_CAP,
117
        .desc      = "Using KVM without %(capability), %(feature) unavailable",
118
    },
119
    {
120
        .error_fmt = QERR_MISSING_PARAMETER,
121
        .desc      = "Parameter '%(name)' is missing",
122
    },
123
    {
124
        .error_fmt = QERR_OPEN_FILE_FAILED,
125
        .desc      = "Could not open '%(filename)'",
126
    },
127
    {
128
        .error_fmt = QERR_PROPERTY_NOT_FOUND,
129
        .desc      = "Property '%(device).%(property)' not found",
130
    },
131
    {
132
        .error_fmt = QERR_PROPERTY_VALUE_BAD,
133
        .desc      = "Property '%(device).%(property)' doesn't take value '%(value)'",
134
    },
135
    {
136
        .error_fmt = QERR_PROPERTY_VALUE_IN_USE,
137
        .desc      = "Property '%(device).%(property)' can't take value '%(value)', it's in use",
138
    },
139
    {
140
        .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND,
141
        .desc      = "Property '%(device).%(property)' can't find value '%(value)'",
142
    },
143
    {
144
        .error_fmt = QERR_QMP_BAD_INPUT_OBJECT,
145
        .desc      = "Bad QMP input object",
146
    },
147
    {
148
        .error_fmt = QERR_SET_PASSWD_FAILED,
149
        .desc      = "Could not set password",
150
    },
151
    {
152
        .error_fmt = QERR_TOO_MANY_FILES,
153
        .desc      = "Too many open files",
154
    },
155
    {
156
        .error_fmt = QERR_UNDEFINED_ERROR,
157
        .desc      = "An undefined error has ocurred",
158
    },
159
    {
160
        .error_fmt = QERR_VNC_SERVER_FAILED,
161
        .desc      = "Could not start VNC server on %(target)",
162
    },
163
    {}
164
};
165

    
166
/**
167
 * qerror_new(): Create a new QError
168
 *
169
 * Return strong reference.
170
 */
171
QError *qerror_new(void)
172
{
173
    QError *qerr;
174

    
175
    qerr = qemu_mallocz(sizeof(*qerr));
176
    QOBJECT_INIT(qerr, &qerror_type);
177

    
178
    return qerr;
179
}
180

    
181
static void qerror_abort(const QError *qerr, const char *fmt, ...)
182
{
183
    va_list ap;
184

    
185
    fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func);
186
    fprintf(stderr, "qerror: -> ");
187

    
188
    va_start(ap, fmt);
189
    vfprintf(stderr, fmt, ap);
190
    va_end(ap);
191

    
192
    fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr);
193
    abort();
194
}
195

    
196
static void qerror_set_data(QError *qerr, const char *fmt, va_list *va)
197
{
198
    QObject *obj;
199

    
200
    obj = qobject_from_jsonv(fmt, va);
201
    if (!obj) {
202
        qerror_abort(qerr, "invalid format '%s'", fmt);
203
    }
204
    if (qobject_type(obj) != QTYPE_QDICT) {
205
        qerror_abort(qerr, "error format is not a QDict '%s'", fmt);
206
    }
207

    
208
    qerr->error = qobject_to_qdict(obj);
209

    
210
    obj = qdict_get(qerr->error, "class");
211
    if (!obj) {
212
        qerror_abort(qerr, "missing 'class' key in '%s'", fmt);
213
    }
214
    if (qobject_type(obj) != QTYPE_QSTRING) {
215
        qerror_abort(qerr, "'class' key value should be a QString");
216
    }
217
    
218
    obj = qdict_get(qerr->error, "data");
219
    if (!obj) {
220
        qerror_abort(qerr, "missing 'data' key in '%s'", fmt);
221
    }
222
    if (qobject_type(obj) != QTYPE_QDICT) {
223
        qerror_abort(qerr, "'data' key value should be a QDICT");
224
    }
225
}
226

    
227
static void qerror_set_desc(QError *qerr, const char *fmt)
228
{
229
    int i;
230

    
231
    // FIXME: inefficient loop
232

    
233
    for (i = 0; qerror_table[i].error_fmt; i++) {
234
        if (strcmp(qerror_table[i].error_fmt, fmt) == 0) {
235
            qerr->entry = &qerror_table[i];
236
            return;
237
        }
238
    }
239

    
240
    qerror_abort(qerr, "error format '%s' not found", fmt);
241
}
242

    
243
/**
244
 * qerror_from_info(): Create a new QError from error information
245
 *
246
 * The information consists of:
247
 *
248
 * - file   the file name of where the error occurred
249
 * - linenr the line number of where the error occurred
250
 * - func   the function name of where the error occurred
251
 * - fmt    JSON printf-like dictionary, there must exist keys 'class' and
252
 *          'data'
253
 * - va     va_list of all arguments specified by fmt
254
 *
255
 * Return strong reference.
256
 */
257
QError *qerror_from_info(const char *file, int linenr, const char *func,
258
                         const char *fmt, va_list *va)
259
{
260
    QError *qerr;
261

    
262
    qerr = qerror_new();
263
    loc_save(&qerr->loc);
264
    qerr->linenr = linenr;
265
    qerr->file = file;
266
    qerr->func = func;
267

    
268
    if (!fmt) {
269
        qerror_abort(qerr, "QDict not specified");
270
    }
271

    
272
    qerror_set_data(qerr, fmt, va);
273
    qerror_set_desc(qerr, fmt);
274

    
275
    return qerr;
276
}
277

    
278
static void parse_error(const QError *qerror, int c)
279
{
280
    qerror_abort(qerror, "expected '%c' in '%s'", c, qerror->entry->desc);
281
}
282

    
283
static const char *append_field(QString *outstr, const QError *qerror,
284
                                const char *start)
285
{
286
    QObject *obj;
287
    QDict *qdict;
288
    QString *key_qs;
289
    const char *end, *key;
290

    
291
    if (*start != '%')
292
        parse_error(qerror, '%');
293
    start++;
294
    if (*start != '(')
295
        parse_error(qerror, '(');
296
    start++;
297

    
298
    end = strchr(start, ')');
299
    if (!end)
300
        parse_error(qerror, ')');
301

    
302
    key_qs = qstring_from_substr(start, 0, end - start - 1);
303
    key = qstring_get_str(key_qs);
304

    
305
    qdict = qobject_to_qdict(qdict_get(qerror->error, "data"));
306
    obj = qdict_get(qdict, key);
307
    if (!obj) {
308
        qerror_abort(qerror, "key '%s' not found in QDict", key);
309
    }
310

    
311
    switch (qobject_type(obj)) {
312
        case QTYPE_QSTRING:
313
            qstring_append(outstr, qdict_get_str(qdict, key));
314
            break;
315
        case QTYPE_QINT:
316
            qstring_append_int(outstr, qdict_get_int(qdict, key));
317
            break;
318
        default:
319
            qerror_abort(qerror, "invalid type '%c'", qobject_type(obj));
320
    }
321

    
322
    QDECREF(key_qs);
323
    return ++end;
324
}
325

    
326
/**
327
 * qerror_human(): Format QError data into human-readable string.
328
 *
329
 * Formats according to member 'desc' of the specified QError object.
330
 */
331
QString *qerror_human(const QError *qerror)
332
{
333
    const char *p;
334
    QString *qstring;
335

    
336
    assert(qerror->entry != NULL);
337

    
338
    qstring = qstring_new();
339

    
340
    for (p = qerror->entry->desc; *p != '\0';) {
341
        if (*p != '%') {
342
            qstring_append_chr(qstring, *p++);
343
        } else if (*(p + 1) == '%') {
344
            qstring_append_chr(qstring, '%');
345
            p += 2;
346
        } else {
347
            p = append_field(qstring, qerror, p);
348
        }
349
    }
350

    
351
    return qstring;
352
}
353

    
354
/**
355
 * qerror_print(): Print QError data
356
 *
357
 * This function will print the member 'desc' of the specified QError object,
358
 * it uses error_report() for this, so that the output is routed to the right
359
 * place (ie. stderr or Monitor's device).
360
 */
361
void qerror_print(QError *qerror)
362
{
363
    QString *qstring = qerror_human(qerror);
364
    loc_push_restore(&qerror->loc);
365
    error_report("%s", qstring_get_str(qstring));
366
    loc_pop(&qerror->loc);
367
    QDECREF(qstring);
368
}
369

    
370
/**
371
 * qobject_to_qerror(): Convert a QObject into a QError
372
 */
373
QError *qobject_to_qerror(const QObject *obj)
374
{
375
    if (qobject_type(obj) != QTYPE_QERROR) {
376
        return NULL;
377
    }
378

    
379
    return container_of(obj, QError, base);
380
}
381

    
382
/**
383
 * qerror_destroy_obj(): Free all memory allocated by a QError
384
 */
385
static void qerror_destroy_obj(QObject *obj)
386
{
387
    QError *qerr;
388

    
389
    assert(obj != NULL);
390
    qerr = qobject_to_qerror(obj);
391

    
392
    QDECREF(qerr->error);
393
    qemu_free(qerr);
394
}