virterror.c 17.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * virterror.c: implements error handling and reporting code for libvirt
 *
 * Copy:  Copyright (C) 2006 Red Hat, Inc.
 *
 * See COPYING.LIB for the License of this software
 *
 * Author: Daniel Veillard <veillard@redhat.com>
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
D
Daniel Veillard 已提交
14
#include <stdarg.h>
15 16
#include "libvirt/libvirt.h"
#include "libvirt/virterror.h"
17 18
#include "internal.h"

19
static virError lastErr =       /* the last error */
20
{ 0, 0, NULL, VIR_ERR_NONE, NULL, NULL, NULL, NULL, NULL, 0, 0, NULL };
21 22
static virErrorFunc virErrorHandler = NULL;     /* global error handlet */
static void *virUserData = NULL;        /* associated data */
23

D
Daniel Veillard 已提交
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
/*
 * Macro used to format the message as a string in __virRaiseError
 * and borrowed from libxml2.
 */
#define VIR_GET_VAR_STR(msg, str) {				\
    int       size, prev_size = -1;				\
    int       chars;						\
    char      *larger;						\
    va_list   ap;						\
								\
    str = (char *) malloc(150);					\
    if (str != NULL) {						\
								\
    size = 150;							\
								\
    while (1) {							\
	va_start(ap, msg);					\
  	chars = vsnprintf(str, size, msg, ap);			\
	va_end(ap);						\
	if ((chars > -1) && (chars < size)) {			\
	    if (prev_size == chars) {				\
		break;						\
	    } else {						\
		prev_size = chars;				\
	    }							\
	}							\
	if (chars > -1)						\
	    size += chars + 1;					\
	else							\
	    size += 100;					\
	if ((larger = (char *) realloc(str, size)) == NULL) {	\
	    break;						\
	}							\
	str = larger;						\
    }}								\
}

61 62 63 64 65 66 67 68 69 70
/*
 * virGetLastError:
 *
 * Provide a pointer to the last error caught at the library level
 * Simpler but may not be suitable for multithreaded accesses, in which
 * case use virCopyLastError()
 *
 * Returns a pointer to the last error or NULL if none occured.
 */
virErrorPtr
71 72
virGetLastError(void)
{
73
    if (lastErr.code == VIR_ERR_OK)
74 75
        return (NULL);
    return (&lastErr);
76 77 78 79 80 81 82 83 84 85 86 87 88
}

/*
 * virCopyLastError:
 * @to: target to receive the copy
 *
 * Copy the content of the last error caught at the library level
 * One will need to free the result with virResetError()
 *
 * Returns 0 if no error was found and the error code otherwise and -1 in case
 *         of parameter error.
 */
int
89 90
virCopyLastError(virErrorPtr to)
{
91
    if (to == NULL)
92
        return (-1);
93
    if (lastErr.code == VIR_ERR_OK)
94
        return (0);
95
    memcpy(to, &lastErr, sizeof(virError));
96
    return (lastErr.code);
97 98 99 100 101 102 103 104 105
}

/**
 * virResetError:
 * @err: pointer to the virError to clean up
 * 
 * Reset the error being pointed to
 */
void
106 107
virResetError(virErrorPtr err)
{
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
    if (err == NULL)
        return;
    if (err->message != NULL)
        free(err->message);
    if (err->str1 != NULL)
        free(err->str1);
    if (err->str2 != NULL)
        free(err->str2);
    if (err->str3 != NULL)
        free(err->str3);
    memset(err, 0, sizeof(virError));
}

/**
 * virResetLastError:
 * 
 * Reset the last error caught at the library level.
 */
void
127 128
virResetLastError(void)
{
129 130 131 132 133 134 135 136 137 138 139 140 141 142
    virResetError(&lastErr);
}

/**
 * virConnGetLastError:
 * @conn: pointer to the hypervisor connection
 *
 * Provide a pointer to the last error caught on that connection
 * Simpler but may not be suitable for multithreaded accesses, in which
 * case use virConnCopyLastError()
 *
 * Returns a pointer to the last error or NULL if none occured.
 */
virErrorPtr
143 144
virConnGetLastError(virConnectPtr conn)
{
145
    if (conn == NULL)
146 147
        return (NULL);
    return (&conn->err);
148 149 150 151 152 153 154 155 156 157 158 159 160 161
}

/**
 * virConnCopyLastError:
 * @conn: pointer to the hypervisor connection
 * @to: target to receive the copy
 *
 * Copy the content of the last error caught on that connection
 * One will need to free the result with virResetError()
 *
 * Returns 0 if no error was found and the error code otherwise and -1 in case
 *         of parameter error.
 */
int
162 163
virConnCopyLastError(virConnectPtr conn, virErrorPtr to)
{
164
    if (conn == NULL)
165
        return (-1);
166
    if (to == NULL)
167
        return (-1);
168
    if (conn->err.code == VIR_ERR_OK)
169
        return (0);
170
    memcpy(to, &conn->err, sizeof(virError));
171
    return (conn->err.code);
172 173 174 175 176 177 178 179 180
}

/**
 * virConnResetLastError:
 * @conn: pointer to the hypervisor connection
 *
 * Reset the last error caught on that connection
 */
void
181 182
virConnResetLastError(virConnectPtr conn)
{
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    if (conn == NULL)
        return;
    virResetError(&conn->err);
}

/**
 * virSetErrorFunc:
 * @userData: pointer to the user data provided in the handler callback
 * @handler: the function to get called in case of error or NULL
 *
 * Set a library global error handling function, if @handler is NULL,
 * it will reset to default printing on stderr. The error raised there
 * are those for which no handler at the connection level could caught.
 */
void
198 199
virSetErrorFunc(void *userData, virErrorFunc handler)
{
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    virErrorHandler = handler;
    virUserData = userData;
}

/**
 * virConnSetErrorFunc:
 * @conn: pointer to the hypervisor connection
 * @userData: pointer to the user data provided in the handler callback
 * @handler: the function to get called in case of error or NULL
 *
 * Set a connection error handling function, if @handler is NULL
 * it will reset to default which is to pass error back to the global
 * library handler.
 */
void
215 216 217
virConnSetErrorFunc(virConnectPtr conn, void *userData,
                    virErrorFunc handler)
{
218 219 220 221 222 223
    if (conn == NULL)
        return;
    conn->handler = handler;
    conn->userData = userData;
}

D
Daniel Veillard 已提交
224
/**
225
 * virDefaultErrorFunc:
D
Daniel Veillard 已提交
226 227
 * @err: pointer to the error.
 *
228
 * Default routine reporting an error to stderr.
D
Daniel Veillard 已提交
229
 */
230
void
231 232
virDefaultErrorFunc(virErrorPtr err)
{
233
    const char *lvl = "", *dom = "", *domain = "", *network = "";
D
Daniel Veillard 已提交
234 235 236 237 238 239
    int len;

    if ((err == NULL) || (err->code == VIR_ERR_OK))
        return;
    switch (err->level) {
        case VIR_ERR_NONE:
240 241
            lvl = "";
            break;
D
Daniel Veillard 已提交
242
        case VIR_ERR_WARNING:
243
            lvl = _("warning");
244
            break;
D
Daniel Veillard 已提交
245
        case VIR_ERR_ERROR:
246
            lvl = _("error");
247 248
            break;
    }
D
Daniel Veillard 已提交
249 250
    switch (err->domain) {
        case VIR_FROM_NONE:
251 252
            dom = "";
            break;
D
Daniel Veillard 已提交
253
        case VIR_FROM_XEN:
254 255
            dom = "Xen ";
            break;
256 257 258
        case VIR_FROM_XML:
            dom = "XML ";
            break;
D
Daniel Veillard 已提交
259
        case VIR_FROM_XEND:
260 261
            dom = "Xen Daemon ";
            break;
262 263 264
        case VIR_FROM_XENSTORE:
            dom = "Xen Store ";
            break;
D
Daniel Veillard 已提交
265
        case VIR_FROM_DOM:
266 267
            dom = "Domain ";
            break;
K
Karel Zak 已提交
268 269 270
        case VIR_FROM_RPC:
            dom = "XML-RPC ";
            break;
D
Daniel P. Berrange 已提交
271 272 273
        case VIR_FROM_QEMU:
            dom = "QEMU ";
            break;
274 275 276
        case VIR_FROM_NET:
            dom = "Network ";
            break;
277 278 279
        case VIR_FROM_TEST:
            dom = "Test ";
            break;
280 281 282
        case VIR_FROM_REMOTE:
            dom = "Remote ";
            break;
D
Daniel Veillard 已提交
283 284 285
    }
    if ((err->dom != NULL) && (err->code != VIR_ERR_INVALID_DOMAIN)) {
        domain = err->dom->name;
286 287
    } else if ((err->net != NULL) && (err->code != VIR_ERR_INVALID_NETWORK)) {
        network = err->net->name;
D
Daniel Veillard 已提交
288 289
    }
    len = strlen(err->message);
290 291
    if ((err->domain == VIR_FROM_XML) && (err->code == VIR_ERR_XML_DETAIL) &&
        (err->int1 != 0))
292 293
        fprintf(stderr, "libvir: %s%s %s%s: line %d: %s",
                dom, lvl, domain, network, err->int1, err->message);
294
    else if ((len == 0) || (err->message[len - 1] != '\n'))
295 296
        fprintf(stderr, "libvir: %s%s %s%s: %s\n",
                dom, lvl, domain, network, err->message);
297
    else
298 299
        fprintf(stderr, "libvir: %s%s %s%s: %s",
                dom, lvl, domain, network, err->message);
D
Daniel Veillard 已提交
300 301 302 303 304 305
}

/**
 * __virRaiseError:
 * @conn: the connection to the hypervisor if available
 * @dom: the domain if available
306
 * @net: the network if available
D
Daniel Veillard 已提交
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
 * @domain: the virErrorDomain indicating where it's coming from
 * @code: the virErrorNumber code for the error
 * @level: the virErrorLevel for the error
 * @str1: extra string info
 * @str2: extra string info
 * @str3: extra string info
 * @int1: extra int info
 * @int2: extra int info
 * @msg:  the message to display/transmit
 * @...:  extra parameters for the message display
 *
 * Internal routine called when an error is detected. It will raise it
 * immediately if a callback is found and store it for later handling.
 */
void
322
__virRaiseError(virConnectPtr conn, virDomainPtr dom, virNetworkPtr net,
D
Daniel Veillard 已提交
323 324
                int domain, int code, virErrorLevel level,
                const char *str1, const char *str2, const char *str3,
325 326
                int int1, int int2, const char *msg, ...)
{
D
Daniel Veillard 已提交
327 328 329 330 331 332
    virErrorPtr to = &lastErr;
    void *userData = virUserData;
    virErrorFunc handler = virErrorHandler;
    char *str;

    if (code == VIR_ERR_OK)
333
        return;
D
Daniel Veillard 已提交
334 335 336 337 338 339

    /*
     * try to find the best place to save and report the error
     */
    if (conn != NULL) {
        to = &conn->err;
340 341 342 343
        if (conn->handler != NULL) {
            handler = conn->handler;
            userData = conn->userData;
        }
D
Daniel Veillard 已提交
344 345 346 347 348 349
    }

    /*
     * formats the message
     */
    if (msg == NULL) {
350
        str = strdup(_("No error message provided"));
D
Daniel Veillard 已提交
351 352 353 354 355 356 357 358 359 360
    } else {
        VIR_GET_VAR_STR(msg, str);
    }

    /*
     * Save the information about the error
     */
    virResetError(to);
    to->conn = conn;
    to->dom = dom;
361
    to->net = net;
D
Daniel Veillard 已提交
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
    to->domain = domain;
    to->code = code;
    to->message = str;
    to->level = level;
    if (str1 != NULL)
        to->str1 = strdup(str1);
    if (str2 != NULL)
        to->str2 = strdup(str2);
    if (str3 != NULL)
        to->str3 = strdup(str3);
    to->int1 = int1;
    to->int2 = int2;

    /*
     * now, report it
     */
    if (handler != NULL) {
        handler(userData, to);
    } else {
381
        virDefaultErrorFunc(to);
D
Daniel Veillard 已提交
382 383 384 385 386 387 388 389 390 391 392 393 394 395
    }
}

/**
 * __virErrorMsg:
 * @error: the virErrorNumber
 * @info: usually the first paprameter string
 *
 * Internal routine to get the message associated to an error raised
 * from the library
 *
 * Returns the constant string associated to @error
 */
const char *
396 397
__virErrorMsg(virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
398 399 400 401
    const char *errmsg = NULL;

    switch (error) {
        case VIR_ERR_OK:
402 403 404
            return (NULL);
        case VIR_ERR_INTERNAL_ERROR:
            if (info != NULL)
405
	      errmsg = _("internal error %s");
406
            else
407
	      errmsg = _("internal error");
408 409
            break;
        case VIR_ERR_NO_MEMORY:
410
            errmsg = _("out of memory");
411 412
            break;
        case VIR_ERR_NO_SUPPORT:
413
            if (info != NULL)
414
		errmsg = _("no support for hypervisor");
415
	    else
416
		errmsg = _("no support for hypervisor %s");
417 418 419
            break;
        case VIR_ERR_NO_CONNECT:
            if (info == NULL)
420
                errmsg = _("could not connect to hypervisor");
421
            else
422
                errmsg = _("could not connect to %s");
423 424
            break;
        case VIR_ERR_INVALID_CONN:
425
            if (info == NULL)
426
		errmsg = _("invalid connection pointer in");
427
	    else
428
		errmsg = _("invalid connection pointer in %s");
429 430
            break;
        case VIR_ERR_INVALID_DOMAIN:
431
            if (info == NULL)
432
		errmsg = _("invalid domain pointer in");
433
	    else
434
	        errmsg = _("invalid domain pointer in %s");
435 436
            break;
        case VIR_ERR_INVALID_ARG:
437
            if (info == NULL)
438
		errmsg = _("invalid argument in");
439
	    else
440
		errmsg = _("invalid argument in %s");
441 442 443
            break;
        case VIR_ERR_OPERATION_FAILED:
            if (info != NULL)
444
                errmsg = _("operation failed: %s");
445
            else
446
                errmsg = _("operation failed");
447 448 449
            break;
        case VIR_ERR_GET_FAILED:
            if (info != NULL)
450
                errmsg = _("GET operation failed: %s");
451
            else
452
                errmsg = _("GET operation failed");
453 454 455
            break;
        case VIR_ERR_POST_FAILED:
            if (info != NULL)
456
                errmsg = _("POST operation failed: %s");
457
            else
458
                errmsg = _("POST operation failed");
459 460
            break;
        case VIR_ERR_HTTP_ERROR:
461
            errmsg = _("got unknown HTTP error code %d");
462 463
            break;
        case VIR_ERR_UNKNOWN_HOST:
464
            if (info != NULL)
465
		errmsg = _("unknown host %s");
466
	    else
467
		errmsg = _("unknown host");
468 469 470
            break;
        case VIR_ERR_SEXPR_SERIAL:
            if (info != NULL)
471
                errmsg = _("failed to serialize S-Expr: %s");
472
            else
473
                errmsg = _("failed to serialize S-Expr");
474 475 476
            break;
        case VIR_ERR_NO_XEN:
            if (info == NULL)
477
                errmsg = _("could not use Xen hypervisor entry");
478
            else
479
                errmsg = _("could not use Xen hypervisor entry %s");
480
            break;
481 482
	case VIR_ERR_NO_XENSTORE:
            if (info == NULL)
483
                errmsg = _("could not connect to Xen Store");
484
            else
485
                errmsg = _("could not connect to Xen Store %s");
486
            break;
487
        case VIR_ERR_XEN_CALL:
488
            errmsg = _("failed Xen syscall %s %d");
489 490 491
            break;
        case VIR_ERR_OS_TYPE:
            if (info == NULL)
492
                errmsg = _("unknown OS type");
493
            else
494
                errmsg = _("unknown OS type %s");
495 496
            break;
        case VIR_ERR_NO_KERNEL:
497
            errmsg = _("missing kernel information");
498 499 500
            break;
        case VIR_ERR_NO_ROOT:
            if (info == NULL)
501
                errmsg = _("missing root device information");
502
            else
503
                errmsg = _("missing root device information in %s");
504 505 506
            break;
        case VIR_ERR_NO_SOURCE:
            if (info == NULL)
507
                errmsg = _("missing source information for device");
508
            else
509
                errmsg = _("missing source information for device %s");
510 511 512
            break;
        case VIR_ERR_NO_TARGET:
            if (info == NULL)
513
                errmsg = _("missing target information for device");
514
            else
515
                errmsg = _("missing target information for device %s");
516 517 518
            break;
        case VIR_ERR_NO_NAME:
            if (info == NULL)
519
                errmsg = _("missing domain name information");
520
            else
521
                errmsg = _("missing domain name information in %s");
522 523 524
            break;
        case VIR_ERR_NO_OS:
            if (info == NULL)
525
                errmsg = _("missing operating system information");
526
            else
527
                errmsg = _("missing operating system information for %s");
528 529 530
            break;
        case VIR_ERR_NO_DEVICE:
            if (info == NULL)
531
                errmsg = _("missing devices information");
532
            else
533
                errmsg = _("missing devices information for %s");
534
            break;
535 536
        case VIR_ERR_DRIVER_FULL:
            if (info == NULL)
537
                errmsg = _("too many drivers registered");
538
            else
539
                errmsg = _("too many drivers registered in %s");
540
            break;
541 542
        case VIR_ERR_CALL_FAILED:
            if (info == NULL)
543
                errmsg = _("library call failed, possibly not supported");
544
            else
545
                errmsg = _("library call %s failed, possibly not supported");
546
            break;
547 548
	case VIR_ERR_XML_ERROR:
	    if (info == NULL)
549
	        errmsg = _("XML description not well formed or invalid");
550
	    else
551
	        errmsg = _("XML description for %s is not well formed or invalid");
552 553 554
            break;
	case VIR_ERR_DOM_EXIST:
	    if (info == NULL)
555
	        errmsg = _("this domain exists already");
556
	    else
557
	        errmsg = _("domain %s exists already");
558
            break;
559 560
	case VIR_ERR_OPERATION_DENIED:
	    if (info == NULL)
561
	        errmsg = _("operation forbidden for read only access");
562
	    else
563
	        errmsg = _("operation %s forbidden for read only access");
564
            break;
D
Daniel Veillard 已提交
565 566
	case VIR_ERR_OPEN_FAILED:
	    if (info == NULL)
567
	        errmsg = _("failed to open configuration file for reading");
D
Daniel Veillard 已提交
568
	    else
569
	        errmsg = _("failed to open %s for reading");
D
Daniel Veillard 已提交
570 571 572
            break;
	case VIR_ERR_READ_FAILED:
	    if (info == NULL)
573
	        errmsg = _("failed to read configuration file");
D
Daniel Veillard 已提交
574
	    else
575
	        errmsg = _("failed to read configuration file %s");
D
Daniel Veillard 已提交
576 577 578
            break;
	case VIR_ERR_PARSE_FAILED:
	    if (info == NULL)
579
	        errmsg = _("failed to parse configuration file");
D
Daniel Veillard 已提交
580
	    else
581
	        errmsg = _("failed to parse configuration file %s");
D
Daniel Veillard 已提交
582 583 584
            break;
	case VIR_ERR_CONF_SYNTAX:
	    if (info == NULL)
585
	        errmsg = _("configuration file syntax error");
D
Daniel Veillard 已提交
586
	    else
587
	        errmsg = _("configuration file syntax error: %s");
D
Daniel Veillard 已提交
588 589 590
            break;
	case VIR_ERR_WRITE_FAILED:
	    if (info == NULL)
591
	        errmsg = _("failed to write configuration file");
D
Daniel Veillard 已提交
592
	    else
593
	        errmsg = _("failed to write configuration file: %s");
D
Daniel Veillard 已提交
594
            break;
595 596 597 598 599 600
	case VIR_ERR_XML_DETAIL:
	    if (info == NULL)
	        errmsg = _("parser error");
	    else
	        errmsg = "%s";
            break;
601 602 603 604 605 606 607 608 609 610 611 612
        case VIR_ERR_INVALID_NETWORK:
            if (info == NULL)
		errmsg = _("invalid network pointer in");
	    else
	        errmsg = _("invalid network pointer in %s");
            break;
	case VIR_ERR_NETWORK_EXIST:
	    if (info == NULL)
	        errmsg = _("this network exists already");
	    else
	        errmsg = _("network %s exists already");
            break;
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
	case VIR_ERR_SYSTEM_ERROR:
	    if (info == NULL)
		errmsg = _("system call error");
	    else
		errmsg = "%s";
	    break;
	case VIR_ERR_RPC:
	    if (info == NULL)
		errmsg = _("RPC error");
	    else
		errmsg = "%s";
	    break;
	case VIR_ERR_GNUTLS_ERROR:
	    if (info == NULL)
		errmsg = _("GNUTLS call error");
	    else
		errmsg = "%s";
	    break;
	case VIR_WAR_NO_NETWORK:
	    if (info == NULL)
		errmsg = _("Failed to find the network");
	    else
		errmsg = _("Failed to find the network: %s");
	    break;
D
Daniel Veillard 已提交
637
    }
638
    return (errmsg);
D
Daniel Veillard 已提交
639
}
640 641 642 643 644 645 646 647 648 649 650 651 652 653

/*
 * vim: set tabstop=4:
 * vim: set shiftwidth=4:
 * vim: set expandtab:
 */
/*
 * Local variables:
 *  indent-tabs-mode: nil
 *  c-indent-level: 4
 *  c-basic-offset: 4
 *  tab-width: 4
 * End:
 */