virerror.c 48.2 KB
Newer Older
1
/*
2
 * virerror.c: error handling and reporting code for libvirt
3
 *
4
 * Copyright (C) 2006, 2008-2016 Red Hat, Inc.
5
 *
O
Osier Yang 已提交
6 7 8 9 10 11 12 13 14 15 16
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
O
Osier Yang 已提交
18
 * <http://www.gnu.org/licenses/>.
19 20 21 22
 *
 * Author: Daniel Veillard <veillard@redhat.com>
 */

23
#include <config.h>
J
Jim Meyering 已提交
24

25 26 27
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
D
Daniel Veillard 已提交
28
#include <stdarg.h>
29

30
#include "virerror.h"
31
#include "datatypes.h"
32
#include "virlog.h"
33
#include "viralloc.h"
34
#include "virthread.h"
35
#include "virutil.h"
36
#include "virstring.h"
37

38 39
VIR_LOG_INIT("util.error");

40
virThreadLocal virLastErr;
41

42 43
virErrorFunc virErrorHandler = NULL;     /* global error handler */
void *virUserData = NULL;        /* associated data */
44
virErrorLogPriorityFunc virErrorLogPriorityFilter = NULL;
45

46 47
static virLogPriority virErrorLevelPriority(virErrorLevel level)
{
48 49
    switch (level) {
        case VIR_ERR_NONE:
50
            return VIR_LOG_INFO;
51
        case VIR_ERR_WARNING:
52
            return VIR_LOG_WARN;
53
        case VIR_ERR_ERROR:
54
            return VIR_LOG_ERROR;
55
    }
56
    return VIR_LOG_ERROR;
57 58
}

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

VIR_ENUM_DECL(virErrorDomain)
VIR_ENUM_IMPL(virErrorDomain, VIR_ERR_DOMAIN_LAST,
              "", /* 0 */
              "Xen Driver",
              "Xen Daemon",
              "Xen Store",
              "S-Expression",

              "XML Util", /* 5 */
              "Domain",
              "XML-RPC",
              "Proxy Daemon",
              "Config File",

              "QEMU Driver", /* 10 */
              "Network",
              "Test Driver",
              "Remote Driver",
              "OpenVZ Driver",

              "Xen XM Driver", /* 15 */
              "Linux Statistics",
              "LXC Driver",
              "Storage Driver",
              "Network Driver",

              "Domain Config", /* 20 */
              "User Mode Linux Driver",
              "Node Device Driver",
              "Xen Inotify Driver",
              "Security Driver",

              "VirtualBox Driver", /* 25 */
              "Network Interface Driver",
              "Open Nebula Driver",
              "ESX Driver",
              "Power Hypervisor Driver",

              "Secrets Driver", /* 30 */
              "CPU Driver",
              "XenAPI Driver",
              "Network Filter Driver",
              "Lifecycle Hook",

              "Domain Snapshot", /* 35 */
              "Audit Utils",
              "Sysinfo Utils",
              "I/O Stream Utils",
J
Ján Tomko 已提交
108
              "VMware Driver",
109 110 111 112 113 114 115 116 117

              "Event Loop", /* 40 */
              "Xen Light Driver",
              "Lock Driver",
              "Hyper-V Driver",
              "Capabilities Utils",

              "URI Utils", /* 45 */
              "Authentication Utils",
D
Dmitry Guryanov 已提交
118
              "DBus Utils",
119
              "Parallels Cloud Server",
120 121
              "Device Config",

122 123
              "SSH transport layer", /* 50 */
              "Lock Space",
124
              "Init control",
125
              "Identity",
126
              "Cgroup",
127 128

              "Access Manager", /* 55 */
129
              "Systemd",
R
Roman Bogorodskiy 已提交
130
              "Bhyve",
131
              "Crypto",
132
              "Firewall",
133 134

              "Polkit", /* 60 */
135
              "Thread jobs",
M
Martin Kletzander 已提交
136
              "Admin Interface",
137
              "Log Manager",
138
              "Xen XL Config",
139

140 141
              "Perf", /* 65 */
              "Libssh transport layer",
142
              "Resource control",
143
    )
144

145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

/*
 * Internal helper that is called when a thread exits, to
 * release the error object stored in the thread local
 */
static void
virLastErrFreeData(void *data)
{
    virErrorPtr err = data;
    if (!err)
        return;
    virResetError(err);
    VIR_FREE(err);
}


D
Daniel Veillard 已提交
161 162 163 164 165 166 167
/**
 * virErrorInitialize:
 *
 * Initialize the error data (per thread)
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
int
virErrorInitialize(void)
{
    return virThreadLocalInit(&virLastErr, virLastErrFreeData);
}


/*
 * Internal helper to ensure a generic error code is stored
 * in case where API returns failure, but forgot to set an
 * error
 */
static void
virErrorGenericFailure(virErrorPtr err)
{
    err->code = VIR_ERR_INTERNAL_ERROR;
    err->domain = VIR_FROM_NONE;
    err->level = VIR_ERR_ERROR;
186 187
    ignore_value(VIR_STRDUP_QUIET(err->message,
                                  _("An error occurred, but the cause is unknown")));
188 189 190
}


191
/*
192
 * Internal helper to perform a deep copy of an error
193 194 195 196 197 198 199 200 201 202 203 204 205 206
 */
static int
virCopyError(virErrorPtr from,
             virErrorPtr to)
{
    int ret = 0;
    if (!to)
        return 0;
    virResetError(to);
    if (!from)
        return 0;
    to->code = from->code;
    to->domain = from->domain;
    to->level = from->level;
207
    if (VIR_STRDUP_QUIET(to->message, from->message) < 0)
208
        ret = -1;
209
    if (VIR_STRDUP_QUIET(to->str1, from->str1) < 0)
210
        ret = -1;
211
    if (VIR_STRDUP_QUIET(to->str2, from->str2) < 0)
212
        ret = -1;
213
    if (VIR_STRDUP_QUIET(to->str3, from->str3) < 0)
214 215 216 217
        ret = -1;
    to->int1 = from->int1;
    to->int2 = from->int2;
    /*
E
Eric Blake 已提交
218
     * Deliberately not setting 'conn', 'dom', 'net' references
219 220 221 222
     */
    return ret;
}

J
Jiri Denemark 已提交
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

virErrorPtr
virErrorCopyNew(virErrorPtr err)
{
    virErrorPtr ret;

    if (VIR_ALLOC_QUIET(ret) < 0)
        return NULL;

    if (virCopyError(err, ret) < 0)
        VIR_FREE(ret);

    return ret;
}


239 240 241 242 243 244
static virErrorPtr
virLastErrorObject(void)
{
    virErrorPtr err;
    err = virThreadLocalGet(&virLastErr);
    if (!err) {
245
        if (VIR_ALLOC_QUIET(err) < 0)
246
            return NULL;
247 248
        if (virThreadLocalSet(&virLastErr, err) < 0)
            VIR_FREE(err);
249 250 251 252 253 254
    }
    return err;
}


/**
255 256 257
 * virGetLastError:
 *
 * Provide a pointer to the last error caught at the library level
258 259 260
 *
 * The error object is kept in thread local storage, so separate
 * threads can safely access this concurrently.
261
 *
R
Richard W.M. Jones 已提交
262
 * Returns a pointer to the last error or NULL if none occurred.
263 264
 */
virErrorPtr
265 266
virGetLastError(void)
{
267 268 269 270
    virErrorPtr err = virLastErrorObject();
    if (!err || err->code == VIR_ERR_OK)
        return NULL;
    return err;
271 272
}

273 274 275 276 277 278 279 280 281 282 283 284 285

/**
 * virGetLastErrorMessage:
 *
 * Get the most recent error message
 *
 * Returns the most recent error message string in this
 * thread, or a generic message if none is set
 */
const char *
virGetLastErrorMessage(void)
{
    virErrorPtr err = virLastErrorObject();
286
    if (err && err->code == VIR_ERR_OK)
287
        return _("no error");
288
    if (!err || !err->message)
289 290 291 292 293
        return _("unknown error");
    return err->message;
}


C
Cole Robinson 已提交
294 295
/**
 * virSetError:
296
 * @newerr: previously saved error object
C
Cole Robinson 已提交
297 298 299 300 301 302
 *
 * Set the current error from a previously saved error object
 *
 * Can be used to re-set an old error, which may have been squashed by
 * other functions (like cleanup routines).
 *
303
 * Returns 0 on success, -1 on failure.  Leaves errno unchanged.
C
Cole Robinson 已提交
304 305 306 307 308
 */
int
virSetError(virErrorPtr newerr)
{
    virErrorPtr err;
309 310 311
    int saved_errno = errno;
    int ret = -1;

312
    err = virLastErrorObject();
C
Cole Robinson 已提交
313
    if (!err)
314
        goto cleanup;
C
Cole Robinson 已提交
315 316

    virResetError(err);
317
    ret = virCopyError(newerr, err);
318
 cleanup:
319 320
    errno = saved_errno;
    return ret;
C
Cole Robinson 已提交
321 322
}

323
/**
324 325 326 327
 * virCopyLastError:
 * @to: target to receive the copy
 *
 * Copy the content of the last error caught at the library level
328 329 330 331
 *
 * The error object is kept in thread local storage, so separate
 * threads can safely access this concurrently.
 *
332 333 334 335 336 337
 * 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
338 339
virCopyLastError(virErrorPtr to)
{
340
    virErrorPtr err = virLastErrorObject();
E
Eric Blake 已提交
341
    /* We can't guarantee caller has initialized it to zero */
342 343 344 345 346 347
    memset(to, 0, sizeof(*to));
    if (err)
        virCopyError(err, to);
    else
        virResetError(to);
    return to->code;
348 349
}

350 351 352
/**
 * virSaveLastError:
 *
353 354
 * Save the last error into a new error object.  On success, errno is
 * unchanged; on failure, errno is ENOMEM.
355 356 357 358 359 360 361 362 363
 *
 * Returns a pointer to the copied error or NULL if allocation failed.
 * It is the caller's responsibility to free the error with
 * virFreeError().
 */
virErrorPtr
virSaveLastError(void)
{
    virErrorPtr to;
364
    int saved_errno = errno;
365

366
    if (VIR_ALLOC_QUIET(to) < 0)
367 368 369
        return NULL;

    virCopyLastError(to);
370
    errno = saved_errno;
371 372 373
    return to;
}

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418

/**
 * virErrorPreserveLast:
 * @saveerr: pointer to virErrorPtr for storing last error object
 *
 * Preserves the currently set last error (for the thread) into @saveerr so that
 * it can be restored via virErrorRestore(). @saveerr must be passed to
 * virErrorRestore()
 */
void
virErrorPreserveLast(virErrorPtr *saveerr)
{
    int saved_errno = errno;
    virErrorPtr lasterr = virGetLastError();

    *saveerr = NULL;

    if (lasterr)
        *saveerr = virErrorCopyNew(lasterr);

    errno = saved_errno;
}


/**
 * virErrorRestore:
 * @savederr: error object holding saved error
 *
 * Restores the error passed via @savederr and clears associated memory.
 */
void
virErrorRestore(virErrorPtr *savederr)
{
    int saved_errno = errno;

    if (!*savederr)
        return;

    virSetError(*savederr);
    virFreeError(*savederr);
    *savederr = NULL;
    errno = saved_errno;
}


419 420 421
/**
 * virResetError:
 * @err: pointer to the virError to clean up
422
 *
423 424 425
 * Reset the error being pointed to
 */
void
426 427
virResetError(virErrorPtr err)
{
428 429
    if (err == NULL)
        return;
430 431 432 433
    VIR_FREE(err->message);
    VIR_FREE(err->str1);
    VIR_FREE(err->str2);
    VIR_FREE(err->str3);
434 435 436
    memset(err, 0, sizeof(virError));
}

437 438 439 440 441 442 443 444 445 446 447 448
/**
 * virFreeError:
 * @err: error to free
 *
 * Resets and frees the given error.
 */
void
virFreeError(virErrorPtr err)
{
    virResetError(err);
    VIR_FREE(err);
}
449

450 451
/**
 * virResetLastError:
452
 *
453
 * Reset the last error caught at the library level.
454 455 456 457
 *
 * The error object is kept in thread local storage, so separate
 * threads can safely access this concurrently, only resetting
 * their own error object.
458 459
 */
void
460 461
virResetLastError(void)
{
462 463 464
    virErrorPtr err = virLastErrorObject();
    if (err)
        virResetError(err);
465 466 467 468 469 470 471
}

/**
 * virConnGetLastError:
 * @conn: pointer to the hypervisor connection
 *
 * Provide a pointer to the last error caught on that connection
472 473 474 475 476 477 478 479 480
 *
 * This method is not protected against access from multiple
 * threads. In a multi-threaded application, always use the
 * global virGetLastError() API which is backed by thread
 * local storage.
 *
 * If the connection object was discovered to be invalid by
 * an API call, then the error will be reported against the
 * global error object.
J
Jim Meyering 已提交
481
 *
482 483 484
 * Since 0.6.0, all errors reported in the per-connection object
 * are also duplicated in the global error object. As such an
 * application can always use virGetLastError(). This method
485
 * remains for backwards compatibility.
486
 *
R
Richard W.M. Jones 已提交
487
 * Returns a pointer to the last error or NULL if none occurred.
488 489
 */
virErrorPtr
490 491
virConnGetLastError(virConnectPtr conn)
{
492
    if (conn == NULL)
493 494
        return NULL;
    return &conn->err;
495 496 497 498 499 500 501 502
}

/**
 * virConnCopyLastError:
 * @conn: pointer to the hypervisor connection
 * @to: target to receive the copy
 *
 * Copy the content of the last error caught on that connection
503 504 505 506 507 508 509 510 511
 *
 * This method is not protected against access from multiple
 * threads. In a multi-threaded application, always use the
 * global virGetLastError() API which is backed by thread
 * local storage.
 *
 * If the connection object was discovered to be invalid by
 * an API call, then the error will be reported against the
 * global error object.
J
Jim Meyering 已提交
512
 *
513 514 515
 * Since 0.6.0, all errors reported in the per-connection object
 * are also duplicated in the global error object. As such an
 * application can always use virGetLastError(). This method
516
 * remains for backwards compatibility.
517
 *
518 519 520 521 522 523
 * 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
524 525
virConnCopyLastError(virConnectPtr conn, virErrorPtr to)
{
E
Eric Blake 已提交
526
    /* We can't guarantee caller has initialized it to zero */
527 528
    memset(to, 0, sizeof(*to));

529
    if (conn == NULL)
530
        return -1;
531
    virObjectLock(conn);
532
    if (conn->err.code == VIR_ERR_OK)
533 534 535
        virResetError(to);
    else
        virCopyError(&conn->err, to);
536
    virObjectUnlock(conn);
537
    return to->code;
538 539 540 541 542 543
}

/**
 * virConnResetLastError:
 * @conn: pointer to the hypervisor connection
 *
544 545 546
 * The error object is kept in thread local storage, so separate
 * threads can safely access this concurrently.
 *
547 548 549
 * Reset the last error caught on that connection
 */
void
550 551
virConnResetLastError(virConnectPtr conn)
{
552 553
    if (conn == NULL)
        return;
554
    virObjectLock(conn);
555
    virResetError(&conn->err);
556
    virObjectUnlock(conn);
557 558 559 560 561 562 563 564 565 566 567 568
}

/**
 * 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
569 570
virSetErrorFunc(void *userData, virErrorFunc handler)
{
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
    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
586 587 588
virConnSetErrorFunc(virConnectPtr conn, void *userData,
                    virErrorFunc handler)
{
589 590
    if (conn == NULL)
        return;
591
    virObjectLock(conn);
592 593
    conn->handler = handler;
    conn->userData = userData;
594
    virObjectUnlock(conn);
595 596
}

D
Daniel Veillard 已提交
597
/**
598
 * virDefaultErrorFunc:
D
Daniel Veillard 已提交
599 600
 * @err: pointer to the error.
 *
601
 * Default routine reporting an error to stderr.
D
Daniel Veillard 已提交
602
 */
603
void
604 605
virDefaultErrorFunc(virErrorPtr err)
{
606
    const char *lvl = "", *dom = "", *domain = "", *network = "";
D
Daniel Veillard 已提交
607 608 609 610 611 612
    int len;

    if ((err == NULL) || (err->code == VIR_ERR_OK))
        return;
    switch (err->level) {
        case VIR_ERR_NONE:
613 614
            lvl = "";
            break;
D
Daniel Veillard 已提交
615
        case VIR_ERR_WARNING:
616
            lvl = _("warning");
617
            break;
D
Daniel Veillard 已提交
618
        case VIR_ERR_ERROR:
619
            lvl = _("error");
620 621
            break;
    }
622 623 624
    dom = virErrorDomainTypeToString(err->domain);
    if (!dom)
        dom = "Unknown";
D
Daniel Veillard 已提交
625 626
    if ((err->dom != NULL) && (err->code != VIR_ERR_INVALID_DOMAIN)) {
        domain = err->dom->name;
627 628
    } else if ((err->net != NULL) && (err->code != VIR_ERR_INVALID_NETWORK)) {
        network = err->net->name;
D
Daniel Veillard 已提交
629 630
    }
    len = strlen(err->message);
631 632
    if ((err->domain == VIR_FROM_XML) && (err->code == VIR_ERR_XML_DETAIL) &&
        (err->int1 != 0))
633
        fprintf(stderr, "libvirt: %s %s %s%s: line %d: %s",
634
                dom, lvl, domain, network, err->int1, err->message);
635
    else if ((len == 0) || (err->message[len - 1] != '\n'))
636
        fprintf(stderr, "libvirt: %s %s %s%s: %s\n",
637
                dom, lvl, domain, network, err->message);
638
    else
639
        fprintf(stderr, "libvirt: %s %s %s%s: %s",
640
                dom, lvl, domain, network, err->message);
D
Daniel Veillard 已提交
641 642
}

D
Daniel Veillard 已提交
643
/**
644
 * virDispatchError:
D
Daniel Veillard 已提交
645 646
 * @conn: pointer to the hypervisor connection
 *
647 648 649 650 651 652
 * Internal helper to do final stage of error
 * reporting in public APIs.
 *
 *  - Copy the global error to per-connection error if needed
 *  - Set a generic error message if none is already set
 *  - Invoke the error callback functions
653 654
 */
void
655
virDispatchError(virConnectPtr conn)
656 657
{
    virErrorPtr err = virLastErrorObject();
658 659 660
    virErrorFunc handler = virErrorHandler;
    void *userData = virUserData;

661
    /* Can only happen on OOM.  */
662 663
    if (!err)
        return;
664

665 666
    /* Set a generic error message if none is already set */
    if (err->code == VIR_ERR_OK)
667 668
        virErrorGenericFailure(err);

669
    /* Copy the global error to per-connection error if needed */
670
    if (conn) {
671
        virObjectLock(conn);
672 673 674 675 676 677
        virCopyError(err, &conn->err);

        if (conn->handler != NULL) {
            handler = conn->handler;
            userData = conn->userData;
        }
678
        virObjectUnlock(conn);
679
    }
680 681 682 683 684 685 686

    /* Invoke the error callback functions */
    if (handler != NULL) {
        (handler)(userData, err);
    } else {
        virDefaultErrorFunc(err);
    }
687 688 689
}


690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
/*
 * Reports an error through the logging subsystem
 */
static
void virRaiseErrorLog(const char *filename,
                      const char *funcname,
                      size_t linenr,
                      virErrorPtr err,
                      virLogMetadata *meta)
{
    int priority;

    /*
     * Hook up the error or warning to the logging facility
     */
    priority = virErrorLevelPriority(err->level);
    if (virErrorLogPriorityFilter)
        priority = virErrorLogPriorityFilter(err, priority);

    /* We don't want to pollute stderr if no logging outputs
     * are explicitly requested by the user, since the default
     * error function already pollutes stderr and most apps
     * hate & thus disable that too. If the daemon has set
     * a priority filter though, we should always forward
     * all errors to the logging code.
     */
    if (virLogGetNbOutputs() > 0 ||
        virErrorLogPriorityFilter)
        virLogMessage(&virLogSelf,
                      priority,
                      filename, linenr, funcname,
                      meta, "%s", err->message);
}
723

D
Daniel Veillard 已提交
724
/**
D
Daniel P. Berrange 已提交
725 726 727 728
 * virRaiseErrorFull:
 * @filename: filename where error was raised
 * @funcname: function name where error was raised
 * @linenr: line number where error was raised
D
Daniel Veillard 已提交
729 730 731 732 733 734 735 736
 * @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
D
Daniel Veillard 已提交
737
 * @fmt:  the message to display/transmit
D
Daniel Veillard 已提交
738 739 740 741 742 743
 * @...:  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
744
virRaiseErrorFull(const char *filename,
D
Daniel P. Berrange 已提交
745 746 747 748 749 750 751 752 753 754 755
                  const char *funcname,
                  size_t linenr,
                  int domain,
                  int code,
                  virErrorLevel level,
                  const char *str1,
                  const char *str2,
                  const char *str3,
                  int int1,
                  int int2,
                  const char *fmt, ...)
756
{
757
    int save_errno = errno;
758
    virErrorPtr to;
D
Daniel Veillard 已提交
759
    char *str;
760 761 762 763 764
    virLogMetadata meta[] = {
        { .key = "LIBVIRT_DOMAIN", .s = NULL, .iv = domain },
        { .key = "LIBVIRT_CODE", .s = NULL, .iv = code },
        { .key = NULL },
    };
D
Daniel Veillard 已提交
765

766 767
    /*
     * All errors are recorded in thread local storage
768
     * For compatibility, public API calls will copy them
769
     * to the per-connection error object when necessary
770 771
     */
    to = virLastErrorObject();
772 773
    if (!to) {
        errno = save_errno;
774
        return; /* Hit OOM allocating thread error object, sod all we can do now */
775
    }
776 777 778

    virResetError(to);

779 780
    if (code == VIR_ERR_OK) {
        errno = save_errno;
781
        return;
782
    }
D
Daniel Veillard 已提交
783 784

    /*
E
Eric Blake 已提交
785
     * formats the message; drop message on OOM situations
D
Daniel Veillard 已提交
786
     */
D
Daniel P. Berrange 已提交
787
    if (fmt == NULL) {
788
        ignore_value(VIR_STRDUP_QUIET(str, _("No error message provided")));
D
Daniel Veillard 已提交
789
    } else {
E
Eric Blake 已提交
790 791
        va_list ap;
        va_start(ap, fmt);
792
        ignore_value(virVasprintfQuiet(&str, fmt, ap));
E
Eric Blake 已提交
793
        va_end(ap);
D
Daniel Veillard 已提交
794 795 796 797 798
    }

    /*
     * Save the information about the error
     */
799
    /*
E
Eric Blake 已提交
800
     * Deliberately not setting conn, dom & net fields since
801 802
     * they're utterly unsafe
     */
D
Daniel Veillard 已提交
803 804 805 806
    to->domain = domain;
    to->code = code;
    to->message = str;
    to->level = level;
807 808 809
    ignore_value(VIR_STRDUP_QUIET(to->str1, str1));
    ignore_value(VIR_STRDUP_QUIET(to->str2, str2));
    ignore_value(VIR_STRDUP_QUIET(to->str3, str3));
D
Daniel Veillard 已提交
810 811
    to->int1 = int1;
    to->int2 = int2;
812

813 814
    virRaiseErrorLog(filename, funcname, linenr,
                     to, meta);
815

816
    errno = save_errno;
D
Daniel Veillard 已提交
817 818
}

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864

/**
 * virRaiseErrorObject:
 * @filename: filename where error was raised
 * @funcname: function name where error was raised
 * @linenr: line number where error was raised
 * @newerr: the error object to report
 *
 * Sets the thread local error object to be a copy of
 * @newerr and logs the error
 *
 * This is like virRaiseErrorFull, except that it accepts the
 * error information via a pre-filled virErrorPtr object
 *
 * This is like virSetError, except that it will trigger the
 * logging callbacks.
 *
 * The caller must clear the @newerr instance afterwards, since
 * it will be copied into the thread local error.
 */
void virRaiseErrorObject(const char *filename,
                         const char *funcname,
                         size_t linenr,
                         virErrorPtr newerr)
{
    int saved_errno = errno;
    virErrorPtr err;
    virLogMetadata meta[] = {
        { .key = "LIBVIRT_DOMAIN", .s = NULL, .iv = newerr->domain },
        { .key = "LIBVIRT_CODE", .s = NULL, .iv = newerr->code },
        { .key = NULL },
    };

    err = virLastErrorObject();
    if (!err)
        goto cleanup;

    virResetError(err);
    virCopyError(newerr, err);
    virRaiseErrorLog(filename, funcname, linenr,
                     err, meta);
 cleanup:
    errno = saved_errno;
}


D
Daniel Veillard 已提交
865
/**
866
 * virErrorMsg:
D
Daniel Veillard 已提交
867
 * @error: the virErrorNumber
R
Richard W.M. Jones 已提交
868
 * @info: usually the first parameter string
D
Daniel Veillard 已提交
869 870 871 872 873 874
 *
 * Internal routine to get the message associated to an error raised
 * from the library
 *
 * Returns the constant string associated to @error
 */
875
static const char *
876
virErrorMsg(virErrorNumber error, const char *info)
877
{
D
Daniel Veillard 已提交
878 879 880 881
    const char *errmsg = NULL;

    switch (error) {
        case VIR_ERR_OK:
882
            return NULL;
883 884
        case VIR_ERR_INTERNAL_ERROR:
            if (info != NULL)
J
Ján Tomko 已提交
885
              errmsg = _("internal error: %s");
886
            else
887
              errmsg = _("internal error");
888 889
            break;
        case VIR_ERR_NO_MEMORY:
890
            errmsg = _("out of memory");
891 892
            break;
        case VIR_ERR_NO_SUPPORT:
893
            if (info == NULL)
894
                errmsg = _("this function is not supported by the connection driver");
895
            else
896
                errmsg = _("this function is not supported by the connection driver: %s");
897 898 899
            break;
        case VIR_ERR_NO_CONNECT:
            if (info == NULL)
900
                errmsg = _("no connection driver available");
901
            else
902
                errmsg = _("no connection driver available for %s");
903 904
            break;
        case VIR_ERR_INVALID_CONN:
905
            if (info == NULL)
906 907 908
                errmsg = _("invalid connection pointer in");
            else
                errmsg = _("invalid connection pointer in %s");
909 910
            break;
        case VIR_ERR_INVALID_DOMAIN:
911
            if (info == NULL)
912 913 914
                errmsg = _("invalid domain pointer in");
            else
                errmsg = _("invalid domain pointer in %s");
915 916
            break;
        case VIR_ERR_INVALID_ARG:
917
            if (info == NULL)
918
                errmsg = _("invalid argument");
919
            else
920
                errmsg = _("invalid argument: %s");
921 922 923
            break;
        case VIR_ERR_OPERATION_FAILED:
            if (info != NULL)
924
                errmsg = _("operation failed: %s");
925
            else
926
                errmsg = _("operation failed");
927 928 929
            break;
        case VIR_ERR_GET_FAILED:
            if (info != NULL)
930
                errmsg = _("GET operation failed: %s");
931
            else
932
                errmsg = _("GET operation failed");
933 934 935
            break;
        case VIR_ERR_POST_FAILED:
            if (info != NULL)
936
                errmsg = _("POST operation failed: %s");
937
            else
938
                errmsg = _("POST operation failed");
939 940
            break;
        case VIR_ERR_HTTP_ERROR:
941
            errmsg = _("got unknown HTTP error code %d");
942 943
            break;
        case VIR_ERR_UNKNOWN_HOST:
944
            if (info != NULL)
945 946 947
                errmsg = _("unknown host %s");
            else
                errmsg = _("unknown host");
948 949 950
            break;
        case VIR_ERR_SEXPR_SERIAL:
            if (info != NULL)
951
                errmsg = _("failed to serialize S-Expr: %s");
952
            else
953
                errmsg = _("failed to serialize S-Expr");
954 955 956
            break;
        case VIR_ERR_NO_XEN:
            if (info == NULL)
957
                errmsg = _("could not use Xen hypervisor entry");
958
            else
959
                errmsg = _("could not use Xen hypervisor entry %s");
960
            break;
961
        case VIR_ERR_NO_XENSTORE:
962
            if (info == NULL)
963
                errmsg = _("could not connect to Xen Store");
964
            else
965
                errmsg = _("could not connect to Xen Store %s");
966
            break;
967
        case VIR_ERR_XEN_CALL:
968
            errmsg = _("failed Xen syscall %s");
969 970 971
            break;
        case VIR_ERR_OS_TYPE:
            if (info == NULL)
972
                errmsg = _("unknown OS type");
973
            else
974
                errmsg = _("unknown OS type %s");
975 976
            break;
        case VIR_ERR_NO_KERNEL:
977
            errmsg = _("missing kernel information");
978 979 980
            break;
        case VIR_ERR_NO_ROOT:
            if (info == NULL)
981
                errmsg = _("missing root device information");
982
            else
983
                errmsg = _("missing root device information in %s");
984 985 986
            break;
        case VIR_ERR_NO_SOURCE:
            if (info == NULL)
987
                errmsg = _("missing source information for device");
988
            else
989
                errmsg = _("missing source information for device %s");
990 991 992
            break;
        case VIR_ERR_NO_TARGET:
            if (info == NULL)
993
                errmsg = _("missing target information for device");
994
            else
995
                errmsg = _("missing target information for device %s");
996 997 998
            break;
        case VIR_ERR_NO_NAME:
            if (info == NULL)
999
                errmsg = _("missing name information");
1000
            else
1001
                errmsg = _("missing name information in %s");
1002 1003 1004
            break;
        case VIR_ERR_NO_OS:
            if (info == NULL)
1005
                errmsg = _("missing operating system information");
1006
            else
1007
                errmsg = _("missing operating system information for %s");
1008 1009 1010
            break;
        case VIR_ERR_NO_DEVICE:
            if (info == NULL)
1011
                errmsg = _("missing devices information");
1012
            else
1013
                errmsg = _("missing devices information for %s");
1014
            break;
1015 1016
        case VIR_ERR_DRIVER_FULL:
            if (info == NULL)
1017
                errmsg = _("too many drivers registered");
1018
            else
1019
                errmsg = _("too many drivers registered in %s");
1020
            break;
1021
        case VIR_ERR_CALL_FAILED: /* DEPRECATED, use VIR_ERR_NO_SUPPORT */
1022
            if (info == NULL)
1023
                errmsg = _("library call failed, possibly not supported");
1024
            else
1025
                errmsg = _("library call %s failed, possibly not supported");
1026
            break;
1027 1028
        case VIR_ERR_XML_ERROR:
            if (info == NULL)
1029
                errmsg = _("XML description is invalid or not well formed");
1030
            else
1031
                errmsg = _("XML error: %s");
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
            break;
        case VIR_ERR_DOM_EXIST:
            if (info == NULL)
                errmsg = _("this domain exists already");
            else
                errmsg = _("domain %s exists already");
            break;
        case VIR_ERR_OPERATION_DENIED:
            if (info == NULL)
                errmsg = _("operation forbidden for read only access");
            else
1043
                errmsg = _("operation forbidden: %s");
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
            break;
        case VIR_ERR_OPEN_FAILED:
            if (info == NULL)
                errmsg = _("failed to open configuration file for reading");
            else
                errmsg = _("failed to open %s for reading");
            break;
        case VIR_ERR_READ_FAILED:
            if (info == NULL)
                errmsg = _("failed to read configuration file");
            else
                errmsg = _("failed to read configuration file %s");
            break;
        case VIR_ERR_PARSE_FAILED:
            if (info == NULL)
                errmsg = _("failed to parse configuration file");
            else
                errmsg = _("failed to parse configuration file %s");
            break;
        case VIR_ERR_CONF_SYNTAX:
            if (info == NULL)
                errmsg = _("configuration file syntax error");
            else
                errmsg = _("configuration file syntax error: %s");
            break;
        case VIR_ERR_WRITE_FAILED:
            if (info == NULL)
                errmsg = _("failed to write configuration file");
            else
                errmsg = _("failed to write configuration file: %s");
            break;
        case VIR_ERR_XML_DETAIL:
            if (info == NULL)
                errmsg = _("parser error");
            else
                errmsg = "%s";
1080
            break;
1081 1082
        case VIR_ERR_INVALID_NETWORK:
            if (info == NULL)
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
                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;
        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;
        case VIR_ERR_NO_DOMAIN:
            if (info == NULL)
                errmsg = _("Domain not found");
            else
                errmsg = _("Domain not found: %s");
            break;
        case VIR_ERR_NO_NETWORK:
            if (info == NULL)
                errmsg = _("Network not found");
            else
                errmsg = _("Network not found: %s");
            break;
1129
        case VIR_ERR_INVALID_MAC:
1130 1131 1132 1133 1134
            if (info == NULL)
                errmsg = _("invalid MAC address");
            else
                errmsg = _("invalid MAC address: %s");
            break;
1135
        case VIR_ERR_AUTH_FAILED:
1136 1137 1138 1139 1140
            if (info == NULL)
                errmsg = _("authentication failed");
            else
                errmsg = _("authentication failed: %s");
            break;
1141 1142 1143 1144 1145 1146
        case VIR_ERR_AUTH_CANCELLED:
            if (info == NULL)
                errmsg = _("authentication cancelled");
            else
                errmsg = _("authentication cancelled: %s");
            break;
1147 1148 1149 1150 1151 1152
        case VIR_ERR_AUTH_UNAVAILABLE:
            if (info == NULL)
                errmsg = _("authentication unavailable");
            else
                errmsg = _("authentication unavailable: %s");
            break;
1153
        case VIR_ERR_NO_STORAGE_POOL:
1154
            if (info == NULL)
1155
                errmsg = _("Storage pool not found");
1156
            else
1157
                errmsg = _("Storage pool not found: %s");
1158
            break;
1159
        case VIR_ERR_NO_STORAGE_VOL:
1160
            if (info == NULL)
1161
                errmsg = _("Storage volume not found");
1162
            else
1163
                errmsg = _("Storage volume not found: %s");
1164
            break;
1165
        case VIR_ERR_STORAGE_VOL_EXIST:
1166 1167 1168 1169 1170
            if (info == NULL)
                errmsg = _("this storage volume exists already");
            else
                errmsg = _("storage volume %s exists already");
            break;
O
Osier Yang 已提交
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
        case VIR_ERR_STORAGE_PROBE_FAILED:
            if (info == NULL)
                errmsg = _("Storage pool probe failed");
            else
                errmsg = _("Storage pool probe failed: %s");
            break;
        case VIR_ERR_STORAGE_POOL_BUILT:
            if (info == NULL)
                errmsg = _("Storage pool already built");
            else
                errmsg = _("Storage pool already built: %s");
            break;
1183
        case VIR_ERR_INVALID_STORAGE_POOL:
1184
            if (info == NULL)
1185
                errmsg = _("invalid storage pool pointer in");
1186
            else
1187
                errmsg = _("invalid storage pool pointer in %s");
1188
            break;
1189
        case VIR_ERR_INVALID_STORAGE_VOL:
1190
            if (info == NULL)
1191
                errmsg = _("invalid storage volume pointer in");
1192
            else
1193
                errmsg = _("invalid storage volume pointer in %s");
1194
            break;
1195
        case VIR_WAR_NO_STORAGE:
1196
            if (info == NULL)
1197
                errmsg = _("Failed to find a storage driver");
1198
            else
1199
                errmsg = _("Failed to find a storage driver: %s");
1200
            break;
1201
        case VIR_WAR_NO_NODE:
1202
            if (info == NULL)
1203
                errmsg = _("Failed to find a node driver");
1204
            else
1205
                errmsg = _("Failed to find a node driver: %s");
1206
            break;
1207
        case VIR_ERR_INVALID_NODE_DEVICE:
1208
            if (info == NULL)
1209
                errmsg = _("invalid node device pointer");
1210
            else
1211
                errmsg = _("invalid node device pointer in %s");
1212
            break;
1213
        case VIR_ERR_NO_NODE_DEVICE:
1214
            if (info == NULL)
1215
                errmsg = _("Node device not found");
1216
            else
1217
                errmsg = _("Node device not found: %s");
1218
            break;
1219 1220
        case VIR_ERR_NO_SECURITY_MODEL:
            if (info == NULL)
1221
                errmsg = _("Security model not found");
1222
            else
1223
                errmsg = _("Security model not found: %s");
1224
            break;
1225 1226
        case VIR_ERR_OPERATION_INVALID:
            if (info == NULL)
1227
                errmsg = _("Requested operation is not valid");
1228
            else
1229
                errmsg = _("Requested operation is not valid: %s");
1230
            break;
D
Daniel Veillard 已提交
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
        case VIR_WAR_NO_INTERFACE:
            if (info == NULL)
                errmsg = _("Failed to find the interface");
            else
                errmsg = _("Failed to find the interface: %s");
            break;
        case VIR_ERR_NO_INTERFACE:
            if (info == NULL)
                errmsg = _("Interface not found");
            else
                errmsg = _("Interface not found: %s");
            break;
        case VIR_ERR_INVALID_INTERFACE:
            if (info == NULL)
                errmsg = _("invalid interface pointer in");
            else
                errmsg = _("invalid interface pointer in %s");
            break;
1249 1250 1251 1252 1253 1254
        case VIR_ERR_MULTIPLE_INTERFACES:
            if (info == NULL)
                errmsg = _("multiple matching interfaces found");
            else
                errmsg = _("multiple matching interfaces found: %s");
            break;
1255 1256 1257 1258 1259 1260
        case VIR_WAR_NO_SECRET:
            if (info == NULL)
                errmsg = _("Failed to find a secret storage driver");
            else
                errmsg = _("Failed to find a secret storage driver: %s");
            break;
1261 1262 1263 1264 1265
        case VIR_ERR_INVALID_SECRET:
            if (info == NULL)
                errmsg = _("Invalid secret");
            else
                errmsg = _("Invalid secret: %s");
1266
            break;
1267 1268 1269 1270 1271
        case VIR_ERR_NO_SECRET:
            if (info == NULL)
                errmsg = _("Secret not found");
            else
                errmsg = _("Secret not found: %s");
1272
            break;
S
Stefan Berger 已提交
1273 1274 1275 1276 1277 1278 1279 1280
        case VIR_WAR_NO_NWFILTER:
            if (info == NULL)
                errmsg = _("Failed to start the nwfilter driver");
            else
                errmsg = _("Failed to start the nwfilter driver: %s");
            break;
        case VIR_ERR_INVALID_NWFILTER:
            if (info == NULL)
1281
                errmsg = _("Invalid network filter");
S
Stefan Berger 已提交
1282
            else
1283
                errmsg = _("Invalid network filter: %s");
S
Stefan Berger 已提交
1284 1285 1286
            break;
        case VIR_ERR_NO_NWFILTER:
            if (info == NULL)
1287
                errmsg = _("Network filter not found");
S
Stefan Berger 已提交
1288
            else
1289
                errmsg = _("Network filter not found: %s");
S
Stefan Berger 已提交
1290 1291 1292
            break;
        case VIR_ERR_BUILD_FIREWALL:
            if (info == NULL)
1293
                errmsg = _("Error while building firewall");
S
Stefan Berger 已提交
1294
            else
1295
                errmsg = _("Error while building firewall: %s");
S
Stefan Berger 已提交
1296
            break;
1297 1298 1299 1300 1301 1302
        case VIR_ERR_CONFIG_UNSUPPORTED:
            if (info == NULL)
                errmsg = _("unsupported configuration");
            else
                errmsg = _("unsupported configuration: %s");
            break;
1303 1304 1305 1306 1307 1308
        case VIR_ERR_OPERATION_TIMEOUT:
            if (info == NULL)
                errmsg = _("Timed out during operation");
            else
                errmsg = _("Timed out during operation: %s");
            break;
1309 1310 1311 1312 1313
        case VIR_ERR_MIGRATE_PERSIST_FAILED:
            if (info == NULL)
                errmsg = _("Failed to make domain persistent after migration");
            else
                errmsg = _("Failed to make domain persistent after migration: %s");
1314
            break;
1315 1316 1317 1318 1319
        case VIR_ERR_HOOK_SCRIPT_FAILED:
            if (info == NULL)
                errmsg = _("Hook script execution failed");
            else
                errmsg = _("Hook script execution failed: %s");
1320
            break;
C
Chris Lalancette 已提交
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
        case VIR_ERR_INVALID_DOMAIN_SNAPSHOT:
            if (info == NULL)
                errmsg = _("Invalid snapshot");
            else
                errmsg = _("Invalid snapshot: %s");
            break;
        case VIR_ERR_NO_DOMAIN_SNAPSHOT:
            if (info == NULL)
                errmsg = _("Domain snapshot not found");
            else
                errmsg = _("Domain snapshot not found: %s");
            break;
1333 1334 1335 1336 1337 1338
        case VIR_ERR_INVALID_STREAM:
            if (info == NULL)
                errmsg = _("invalid stream pointer");
            else
                errmsg = _("invalid stream pointer in %s");
            break;
1339 1340 1341 1342 1343 1344
        case VIR_ERR_ARGUMENT_UNSUPPORTED:
            if (info == NULL)
                errmsg = _("argument unsupported");
            else
                errmsg = _("argument unsupported: %s");
            break;
E
Eric Blake 已提交
1345 1346 1347 1348 1349 1350
        case VIR_ERR_SNAPSHOT_REVERT_RISKY:
            if (info == NULL)
                errmsg = _("revert requires force");
            else
                errmsg = _("revert requires force: %s");
            break;
1351 1352 1353 1354 1355 1356
        case VIR_ERR_OPERATION_ABORTED:
            if (info == NULL)
                errmsg = _("operation aborted");
            else
                errmsg = _("operation aborted: %s");
            break;
1357 1358 1359 1360 1361 1362
        case VIR_ERR_NO_DOMAIN_METADATA:
            if (info == NULL)
                errmsg = _("metadata not found");
            else
                errmsg = _("metadata not found: %s");
            break;
J
Jiri Denemark 已提交
1363 1364 1365 1366 1367 1368
        case VIR_ERR_MIGRATE_UNSAFE:
            if (!info)
                errmsg = _("Unsafe migration");
            else
                errmsg = _("Unsafe migration: %s");
            break;
E
Eric Blake 已提交
1369 1370 1371 1372 1373 1374
        case VIR_ERR_OVERFLOW:
            if (!info)
                errmsg = _("numerical overflow");
            else
                errmsg = _("numerical overflow: %s");
            break;
E
Eric Blake 已提交
1375 1376 1377 1378 1379 1380
        case VIR_ERR_BLOCK_COPY_ACTIVE:
            if (!info)
                errmsg = _("block copy still active");
            else
                errmsg = _("block copy still active: %s");
            break;
1381 1382 1383 1384 1385 1386
        case VIR_ERR_OPERATION_UNSUPPORTED:
            if (!info)
                errmsg = _("Operation not supported");
            else
                errmsg = _("Operation not supported: %s");
            break;
1387 1388 1389 1390 1391
        case VIR_ERR_SSH:
            if (info == NULL)
                errmsg = _("SSH transport error");
            else
                errmsg = _("SSH transport error: %s");
1392 1393 1394 1395 1396 1397 1398
            break;
        case VIR_ERR_AGENT_UNRESPONSIVE:
            if (info == NULL)
                errmsg = _("Guest agent is not responding");
            else
                errmsg = _("Guest agent is not responding: %s");
            break;
1399 1400 1401 1402
        case VIR_ERR_RESOURCE_BUSY:
            if (info == NULL)
                errmsg = _("resource busy");
            else
1403
                errmsg = _("resource busy: %s");
1404
            break;
1405 1406 1407 1408 1409 1410
        case VIR_ERR_ACCESS_DENIED:
            if (info == NULL)
                errmsg = _("access denied");
            else
                errmsg = _("access denied: %s");
            break;
1411 1412 1413 1414 1415 1416
        case VIR_ERR_DBUS_SERVICE:
            if (info == NULL)
                errmsg = _("error from service");
            else
                errmsg = _("error from service: %s");
            break;
1417 1418 1419 1420 1421 1422
        case VIR_ERR_CPU_INCOMPATIBLE:
            if (info == NULL)
                errmsg = _("the CPU is incompatible with host CPU");
            else
                errmsg = _("the CPU is incompatible with host CPU: %s");
            break;
1423 1424 1425 1426 1427 1428
        case VIR_ERR_XML_INVALID_SCHEMA:
            if (info == NULL)
                errmsg = _("XML document failed to validate against schema");
            else
                errmsg = _("XML document failed to validate against schema: %s");
            break;
1429 1430 1431
        case VIR_ERR_MIGRATE_FINISH_OK:
            errmsg = _("migration successfully aborted");
            break;
1432 1433 1434 1435 1436 1437
        case VIR_ERR_NO_SERVER:
            if (info == NULL)
                errmsg = _("Server not found");
            else
                errmsg = _("Server not found: %s");
            break;
1438 1439 1440 1441 1442 1443
        case VIR_ERR_NO_CLIENT:
            if (info == NULL)
                errmsg = _("Client not found");
            else
                errmsg = _("Client not found: %s");
            break;
1444
        case VIR_ERR_AGENT_UNSYNCED: /* DEPRECATED */
1445 1446 1447 1448 1449
            if (info == NULL)
                errmsg = _("guest agent replied with wrong id to guest-sync command");
            else
                errmsg = _("guest agent replied with wrong id to guest-sync command: %s");
            break;
1450 1451 1452 1453 1454 1455
        case VIR_ERR_LIBSSH:
            if (info == NULL)
                errmsg = _("libssh transport error");
            else
                errmsg = _("libssh transport error: %s");
            break;
D
Daniel Veillard 已提交
1456
    }
1457
    return errmsg;
D
Daniel Veillard 已提交
1458
}
1459 1460

/**
1461
 * virReportErrorHelper:
1462 1463
 *
 * @domcode: the virErrorDomain indicating where it's coming from
1464
 * @errorcode: the virErrorNumber code for the error
1465 1466 1467
 * @filename: Source file error is dispatched from
 * @funcname: Function error is dispatched from
 * @linenr: Line number error is dispatched from
1468
 * @fmt:  the format string
1469 1470 1471 1472 1473
 * @...:  extra parameters for the message display
 *
 * Helper function to do most of the grunt work for individual driver
 * ReportError
 */
1474
void virReportErrorHelper(int domcode,
1475
                          int errorcode,
D
Daniel P. Berrange 已提交
1476 1477 1478
                          const char *filename,
                          const char *funcname,
                          size_t linenr,
1479
                          const char *fmt, ...)
1480
{
1481
    int save_errno = errno;
1482
    va_list args;
1483
    char errorMessage[VIR_ERROR_MAX_LENGTH];
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
    const char *virerr;

    if (fmt) {
        va_start(args, fmt);
        vsnprintf(errorMessage, sizeof(errorMessage)-1, fmt, args);
        va_end(args);
    } else {
        errorMessage[0] = '\0';
    }

1494
    virerr = virErrorMsg(errorcode, (errorMessage[0] ? errorMessage : NULL));
1495
    virRaiseErrorFull(filename, funcname, linenr,
1496
                      domcode, errorcode, VIR_ERR_ERROR,
D
Daniel P. Berrange 已提交
1497 1498
                      virerr, errorMessage, NULL,
                      -1, -1, virerr, errorMessage);
1499
    errno = save_errno;
1500
}
1501

1502 1503 1504 1505 1506 1507
/**
 * virStrerror:
 * @theerrno: the errno value
 * @errBuf: the buffer to save the error to
 * @errBufLen: the buffer length
 *
1508
 * Generate an error string for the given errno
1509 1510 1511 1512
 *
 * Returns a pointer to the error string, possibly indicating that the
 *         error is unknown
 */
J
Jim Meyering 已提交
1513
const char *virStrerror(int theerrno, char *errBuf, size_t errBufLen)
1514
{
1515 1516 1517
    int save_errno = errno;
    const char *ret;

1518
    strerror_r(theerrno, errBuf, errBufLen);
1519 1520 1521
    ret = errBuf;
    errno = save_errno;
    return ret;
1522 1523
}

1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
/**
 * virReportSystemErrorFull:
 * @domcode: the virErrorDomain indicating where it's coming from
 * @theerrno: an errno number
 * @filename: filename where error was raised
 * @funcname: function name where error was raised
 * @linenr: line number where error was raised
 * @fmt:  the message to display/transmit
 * @...:  extra parameters for the message display
 *
 * Convenience internal routine called when a system error is detected.
 */
1536
void virReportSystemErrorFull(int domcode,
1537
                              int theerrno,
D
Daniel P. Berrange 已提交
1538 1539 1540
                              const char *filename,
                              const char *funcname,
                              size_t linenr,
1541 1542
                              const char *fmt, ...)
{
1543
    int save_errno = errno;
1544 1545
    char strerror_buf[VIR_ERROR_MAX_LENGTH];
    char msgDetailBuf[VIR_ERROR_MAX_LENGTH];
1546 1547 1548 1549 1550

    const char *errnoDetail = virStrerror(theerrno, strerror_buf,
                                          sizeof(strerror_buf));
    const char *msg = virErrorMsg(VIR_ERR_SYSTEM_ERROR, fmt);
    const char *msgDetail = NULL;
1551 1552

    if (fmt) {
1553 1554 1555
        va_list args;
        int n;

1556
        va_start(args, fmt);
1557
        n = vsnprintf(msgDetailBuf, sizeof(msgDetailBuf), fmt, args);
1558
        va_end(args);
1559

1560
        size_t len = strlen(errnoDetail);
1561
        if (0 <= n && n + 2 + len < sizeof(msgDetailBuf)) {
1562
          char *p = msgDetailBuf + n;
1563
          stpcpy(stpcpy(p, ": "), errnoDetail);
1564 1565
          msgDetail = msgDetailBuf;
        }
1566 1567
    }

1568
    if (!msgDetail)
1569
        msgDetail = errnoDetail;
1570

1571
    virRaiseErrorFull(filename, funcname, linenr,
D
Daniel P. Berrange 已提交
1572
                      domcode, VIR_ERR_SYSTEM_ERROR, VIR_ERR_ERROR,
1573
                      msg, msgDetail, NULL, theerrno, -1, msg, msgDetail);
1574
    errno = save_errno;
1575 1576
}

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
/**
 * virReportOOMErrorFull:
 * @domcode: the virErrorDomain indicating where it's coming from
 * @filename: filename where error was raised
 * @funcname: function name where error was raised
 * @linenr: line number where error was raised
 *
 * Convenience internal routine called when an out of memory error is
 * detected
 */
1587
void virReportOOMErrorFull(int domcode,
D
Daniel P. Berrange 已提交
1588 1589 1590
                           const char *filename,
                           const char *funcname,
                           size_t linenr)
1591 1592 1593 1594
{
    const char *virerr;

    virerr = virErrorMsg(VIR_ERR_NO_MEMORY, NULL);
1595
    virRaiseErrorFull(filename, funcname, linenr,
D
Daniel P. Berrange 已提交
1596 1597
                      domcode, VIR_ERR_NO_MEMORY, VIR_ERR_ERROR,
                      virerr, NULL, NULL, -1, -1, virerr, NULL);
1598
}
1599

1600 1601 1602 1603 1604 1605
/**
 * virSetErrorLogPriorityFunc:
 * @func: function to install
 *
 * Install a function used to filter error logging based on error priority.
 */
1606 1607 1608 1609
void virSetErrorLogPriorityFunc(virErrorLogPriorityFunc func)
{
    virErrorLogPriorityFilter = func;
}
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657


/**
 * virErrorSetErrnoFromLastError:
 *
 * If the last error had a code of VIR_ERR_SYSTEM_ERROR
 * then set errno to the value saved in the error object.
 *
 * If the last error had a code of VIR_ERR_NO_MEMORY
 * then set errno to ENOMEM
 *
 * Otherwise set errno to EIO.
 */
void virErrorSetErrnoFromLastError(void)
{
    virErrorPtr err = virGetLastError();
    if (err && err->code == VIR_ERR_SYSTEM_ERROR) {
        errno = err->int1;
    } else if (err && err->code == VIR_ERR_NO_MEMORY) {
        errno = ENOMEM;
    } else {
        errno = EIO;
    }
}


/**
 * virLastErrorIsSystemErrno:
 * @errnum: the errno value
 *
 * Check if the last error reported is a system
 * error with the specific errno value.
 *
 * If @errnum is zero, any system error will pass.
 *
 * Returns true if the last error was a system error with errno == @errnum
 */
bool virLastErrorIsSystemErrno(int errnum)
{
    virErrorPtr err = virGetLastError();
    if (!err)
        return false;
    if (err->code != VIR_ERR_SYSTEM_ERROR)
        return false;
    if (errnum != 0 && err->int1 != errnum)
        return false;
    return true;
}