libvirt.c 350.4 KB
Newer Older
D
Daniel Veillard 已提交
1
/*
2
 * libvirt.c: Main interfaces for the libvirt library to handle virtualization
D
Daniel Veillard 已提交
3 4
 *           domains from a process running in domain 0
 *
5
 * Copyright (C) 2005-2006, 2008-2010 Red Hat, Inc.
D
Daniel Veillard 已提交
6 7 8 9 10 11
 *
 * See COPYING.LIB for the License of this software
 *
 * Daniel Veillard <veillard@redhat.com>
 */

12
#include <config.h>
D
Daniel Veillard 已提交
13

14
#include <stdio.h>
15
#include <stdlib.h>
16
#include <string.h>
17 18 19
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
20
#include <assert.h>
E
Eric Blake 已提交
21
#include <sys/wait.h>
22
#include <time.h>
D
Daniel P. Berrange 已提交
23
#include <gcrypt.h>
24

25 26
#include <libxml/parser.h>
#include <libxml/xpath.h>
27
#include <libxml/uri.h>
28 29
#include "getpass.h"

30
#ifdef HAVE_WINSOCK2_H
31
# include <winsock2.h>
32
#endif
33

34
#include "virterror_internal.h"
35
#include "logging.h"
36
#include "datatypes.h"
37
#include "driver.h"
38

39
#include "uuid.h"
40
#include "util.h"
41
#include "memory.h"
42
#include "configmake.h"
43

44
#ifndef WITH_DRIVER_MODULES
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
# ifdef WITH_TEST
#  include "test/test_driver.h"
# endif
# ifdef WITH_XEN
#  include "xen/xen_driver.h"
# endif
# ifdef WITH_REMOTE
#  include "remote/remote_driver.h"
# endif
# ifdef WITH_OPENVZ
#  include "openvz/openvz_driver.h"
# endif
# ifdef WITH_PHYP
#  include "phyp/phyp_driver.h"
# endif
# ifdef WITH_VBOX
#  include "vbox/vbox_driver.h"
# endif
# ifdef WITH_ESX
#  include "esx/esx_driver.h"
# endif
66 67 68
# ifdef WITH_XENAPI
#  include "xenapi/xenapi_driver.h"
# endif
69
#endif
70

71 72
#define VIR_FROM_THIS VIR_FROM_NONE

D
Daniel Veillard 已提交
73 74 75
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
D
Daniel Veillard 已提交
76
 * - use reference counting to guarantee coherent pointer state ?
D
Daniel Veillard 已提交
77 78
 */

79 80
#define MAX_DRIVERS 10

81
static virDriverPtr virDriverTab[MAX_DRIVERS];
82
static int virDriverTabCount = 0;
83
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
84
static int virNetworkDriverTabCount = 0;
D
Daniel Veillard 已提交
85 86
static virInterfaceDriverPtr virInterfaceDriverTab[MAX_DRIVERS];
static int virInterfaceDriverTabCount = 0;
87 88
static virStorageDriverPtr virStorageDriverTab[MAX_DRIVERS];
static int virStorageDriverTabCount = 0;
89 90
static virDeviceMonitorPtr virDeviceMonitorTab[MAX_DRIVERS];
static int virDeviceMonitorTabCount = 0;
91 92
static virSecretDriverPtr virSecretDriverTab[MAX_DRIVERS];
static int virSecretDriverTabCount = 0;
S
Stefan Berger 已提交
93 94
static virNWFilterDriverPtr virNWFilterDriverTab[MAX_DRIVERS];
static int virNWFilterDriverTabCount = 0;
A
Atsushi SAKAI 已提交
95
#ifdef WITH_LIBVIRTD
96 97
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
A
Atsushi SAKAI 已提交
98
#endif
99 100
static int initialized = 0;

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
#if defined(POLKIT_AUTH)
static int virConnectAuthGainPolkit(const char *privilege) {
    const char *const args[] = {
        POLKIT_AUTH, "--obtain", privilege, NULL
    };
    int childpid, status, ret;

    /* Root has all rights */
    if (getuid() == 0)
        return 0;

    if ((childpid = fork()) < 0)
        return -1;

    if (!childpid) {
        execvp(args[0], (char **)args);
        _exit(-1);
    }

    while ((ret = waitpid(childpid, &status, 0) == -1) && errno == EINTR);
    if (ret == -1) {
        return -1;
    }

    if (!WIFEXITED(status) ||
        (WEXITSTATUS(status) != 0 && WEXITSTATUS(status) != 1)) {
        return -1;
    }

    return 0;
}
#endif

134 135 136 137 138 139 140 141
static int virConnectAuthCallbackDefault(virConnectCredentialPtr cred,
                                         unsigned int ncred,
                                         void *cbdata ATTRIBUTE_UNUSED) {
    int i;

    for (i = 0 ; i < ncred ; i++) {
        char buf[1024];
        char *bufptr = buf;
142
        size_t len;
143 144

        switch (cred[i].type) {
145 146 147 148
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

149
#if defined(POLKIT_AUTH)
150
            if (virConnectAuthGainPolkit(cred[i].prompt) < 0)
151
                return -1;
152 153 154 155 156 157 158
#else
            /*
             * Ignore & carry on. Although we can't auth
             * directly, the user may have authenticated
             * themselves already outside context of libvirt
             */
#endif
159 160
            break;
        }
161

162 163 164 165
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
166
            if (printf("%s: ", cred[i].prompt) < 0)
167 168 169 170
                return -1;
            if (fflush(stdout) != 0)
                return -1;

171 172 173 174 175 176 177
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
178 179 180
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
181 182 183 184
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
185
            if (printf("%s: ", cred[i].prompt) < 0)
186 187 188 189
                return -1;
            if (fflush(stdout) != 0)
                return -1;

190 191 192 193
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
194 195 196

        default:
            return -1;
197 198
        }

D
Daniel P. Berrange 已提交
199 200 201 202 203 204 205 206 207
        if (cred[i].type != VIR_CRED_EXTERNAL) {
            if (STREQ(bufptr, "") && cred[i].defresult)
                cred[i].result = strdup(cred[i].defresult);
            else
                cred[i].result = strdup(bufptr);
            if (!cred[i].result)
                return -1;
            cred[i].resultlen = strlen(cred[i].result);
        }
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
    }

    return 0;
}

/* Don't typically want VIR_CRED_USERNAME. It enables you to authenticate
 * as one user, and act as another. It just results in annoying
 * prompts for the username twice & is very rarely what you want
 */
static int virConnectCredTypeDefault[] = {
    VIR_CRED_AUTHNAME,
    VIR_CRED_ECHOPROMPT,
    VIR_CRED_REALM,
    VIR_CRED_PASSPHRASE,
    VIR_CRED_NOECHOPROMPT,
223
    VIR_CRED_EXTERNAL,
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
};

static virConnectAuth virConnectAuthDefault = {
    virConnectCredTypeDefault,
    sizeof(virConnectCredTypeDefault)/sizeof(int),
    virConnectAuthCallbackDefault,
    NULL,
};

/*
 * virConnectAuthPtrDefault
 *
 * A default implementation of the authentication callbacks. This
 * implementation is suitable for command line based tools. It will
 * prompt for username, passwords, realm and one time keys as needed.
 * It will print on STDOUT, and read from STDIN. If this is not
 * suitable for the application's needs an alternative implementation
 * should be provided.
 */
virConnectAuthPtr virConnectAuthPtrDefault = &virConnectAuthDefault;

245 246 247 248 249 250 251 252 253 254
#if HAVE_WINSOCK2_H
static int
winsock_init (void)
{
    WORD winsock_version, err;
    WSADATA winsock_data;

    /* http://msdn2.microsoft.com/en-us/library/ms742213.aspx */
    winsock_version = MAKEWORD (2, 2);
    err = WSAStartup (winsock_version, &winsock_data);
J
Jim Meyering 已提交
255
    return err == 0 ? 0 : -1;
256 257 258
}
#endif

D
Daniel P. Berrange 已提交
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
static int virTLSMutexInit (void **priv)
{                                                                             \
    virMutexPtr lock = NULL;

    if (VIR_ALLOC(lock) < 0)
        return ENOMEM;

    if (virMutexInit(lock) < 0) {
        VIR_FREE(lock);
        return errno;
    }

    *priv = lock;
    return 0;
}

static int virTLSMutexDestroy(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexDestroy(lock);
    VIR_FREE(lock);
    return 0;
}

static int virTLSMutexLock(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexLock(lock);
    return 0;
}

static int virTLSMutexUnlock(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexUnlock(lock);
    return 0;
}

static struct gcry_thread_cbs virTLSThreadImpl = {
298 299
    /* GCRY_THREAD_OPTION_VERSION was added in gcrypt 1.4.2 */
#ifdef GCRY_THREAD_OPTION_VERSION
D
Daniel P. Berrange 已提交
300
    (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8)),
301 302 303
#else
    GCRY_THREAD_OPTION_PTHREAD,
#endif
D
Daniel P. Berrange 已提交
304 305 306 307 308 309 310 311 312
    NULL,
    virTLSMutexInit,
    virTLSMutexDestroy,
    virTLSMutexLock,
    virTLSMutexUnlock,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
};


313 314 315 316 317 318 319 320 321 322 323 324 325 326
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
    if (initialized)
        return(0);
327

328
    initialized = 1;
329

330
    if (virThreadInitialize() < 0 ||
331 332
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
333 334
        return -1;

D
Daniel P. Berrange 已提交
335 336 337
    gcry_control(GCRYCTL_SET_THREAD_CBS, &virTLSThreadImpl);
    gcry_check_version(NULL);

338
    virLogSetFromEnv();
339 340 341

    DEBUG0("register drivers");

342 343 344 345
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

346
    if (!bindtextdomain(PACKAGE, LOCALEDIR))
347 348
        return (-1);

349
    /*
350 351
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
352
     */
353 354 355
#ifdef WITH_DRIVER_MODULES
    /* We don't care if any of these fail, because the whole point
     * is to allow users to only install modules they want to use.
D
Dan Kenigsberg 已提交
356
     * If they try to open a connection for a module that
357 358
     * is not loaded they'll get a suitable error at that point
     */
359
# ifdef WITH_TEST
360
    virDriverLoadModule("test");
361 362
# endif
# ifdef WITH_XEN
363
    virDriverLoadModule("xen");
364 365
# endif
# ifdef WITH_OPENVZ
366
    virDriverLoadModule("openvz");
367 368
# endif
# ifdef WITH_VBOX
369
    virDriverLoadModule("vbox");
370 371
# endif
# ifdef WITH_ESX
372
    virDriverLoadModule("esx");
373 374
# endif
# ifdef WITH_XENAPI
375
    virDriverLoadModule("xenapi");
376 377
# endif
# ifdef WITH_REMOTE
378
    virDriverLoadModule("remote");
379
# endif
380
#else
381
# ifdef WITH_TEST
382
    if (testRegister() == -1) return -1;
383 384
# endif
# ifdef WITH_XEN
385
    if (xenRegister () == -1) return -1;
386 387
# endif
# ifdef WITH_OPENVZ
388
    if (openvzRegister() == -1) return -1;
389 390
# endif
# ifdef WITH_PHYP
391
    if (phypRegister() == -1) return -1;
392 393
# endif
# ifdef WITH_VBOX
394
    if (vboxRegister() == -1) return -1;
395 396
# endif
# ifdef WITH_ESX
397
    if (esxRegister() == -1) return -1;
398
# endif
399 400 401
# ifdef WITH_XENAPI
    if (xenapiRegister() == -1) return -1;
# endif
402
# ifdef WITH_REMOTE
403
    if (remoteRegister () == -1) return -1;
404
# endif
405
#endif
D
Daniel P. Berrange 已提交
406

407 408 409
    return(0);
}

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
#ifdef WIN32
BOOL WINAPI
DllMain (HINSTANCE instance, DWORD reason, LPVOID ignore);

BOOL WINAPI
DllMain (HINSTANCE instance ATTRIBUTE_UNUSED,
         DWORD reason,
         LPVOID ignore ATTRIBUTE_UNUSED)
{
    switch (reason) {
    case DLL_PROCESS_ATTACH:
        virInitialize();
        break;

    case DLL_THREAD_ATTACH:
        /* Nothing todo in libvirt yet */
        break;

    case DLL_THREAD_DETACH:
        /* Release per-thread local data */
        virThreadOnExit();
        break;

    case DLL_PROCESS_DETACH:
        /* Don't bother releasing per-thread data
           since (hopefully) windows cleans up
           everything on process exit */
        break;
    }

    return TRUE;
}
#endif
443 444


D
Daniel Veillard 已提交
445 446 447
/**
 * virLibConnError:
 * @conn: the connection if available
448
 * @error: the error number
D
Daniel Veillard 已提交
449 450 451 452 453
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
454 455
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
456
    const char *errmsg;
457

D
Daniel Veillard 已提交
458 459 460
    if (error == VIR_ERR_OK)
        return;

461 462 463
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
464 465 466
}

/**
467
 * virLibConnWarning:
D
Daniel Veillard 已提交
468
 * @conn: the connection if available
469 470 471 472 473 474 475 476 477 478 479 480 481
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibConnWarning(virConnectPtr conn, virErrorNumber error, const char *info)
{
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

482 483 484
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
485 486 487 488 489 490
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
491 492 493 494 495
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
496 497 498
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
499 500
    virConnectPtr conn = NULL;
    const char *errmsg;
501

D
Daniel Veillard 已提交
502 503 504
    if (error == VIR_ERR_OK)
        return;

505
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
506 507 508
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
509 510
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
511 512
}

513
/**
514 515
 * virLibNetworkError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
516
 * @error: the error number
517
 * @info: extra information string
518
 *
519
 * Handle an error at the connection level
520
 */
521 522 523 524 525 526 527 528 529 530
static void
virLibNetworkError(virNetworkPtr network, virErrorNumber error,
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

531
    errmsg = virErrorMsg(error, info);
532 533 534
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
535 536
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
537 538
}

D
Daniel Veillard 已提交
539 540 541 542 543 544 545 546 547
/**
 * virLibInterfaceError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
548
virLibInterfaceError(virInterfacePtr iface, virErrorNumber error,
D
Daniel Veillard 已提交
549 550 551 552 553 554 555 556 557 558
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

    errmsg = virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_INTERFACE) {
559
        conn = iface->conn;
D
Daniel Veillard 已提交
560 561 562 563 564
    }
    virRaiseError(conn, NULL, NULL, VIR_FROM_INTERFACE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

565 566 567
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
568
 * @error: the error number
569 570 571 572 573 574 575 576 577 578 579 580 581 582
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibStoragePoolError(virStoragePoolPtr pool, virErrorNumber error,
                       const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

583
    errmsg = virErrorMsg(error, info);
584 585 586
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

587 588
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
589 590 591 592 593
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
594
 * @error: the error number
595 596 597 598 599 600 601 602 603 604 605 606 607 608
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibStorageVolError(virStorageVolPtr vol, virErrorNumber error,
                      const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

609
    errmsg = virErrorMsg(error, info);
610 611 612
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

613 614
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
615 616
}

617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
/**
 * virLibNodeDeviceError:
 * @dev: the device if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the node device level
 */
static void
virLibNodeDeviceError(virNodeDevicePtr dev, virErrorNumber error,
                      const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

    errmsg = virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_NODE_DEVICE)
        conn = dev->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_NODEDEV, error, VIR_ERR_ERROR,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

643
#define virLibStreamError(conn, code, ...)                      \
644
    virReportErrorHelper(conn, VIR_FROM_NONE, code, __FILE__,   \
645
                         __FUNCTION__, __LINE__, __VA_ARGS__)
646

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
/**
 * virLibSecretError:
 * @secret: the secret if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the secret level
 */
static void
virLibSecretError(virSecretPtr secret, virErrorNumber error, const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

    errmsg = virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_SECRET)
        conn = secret->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_SECRET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

S
Stefan Berger 已提交
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
/**
 * virLibNWFilterError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibNWFilterError(virNWFilterPtr pool, virErrorNumber error,
                    const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

    errmsg = virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_NWFILTER)
        conn = pool->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_NWFILTER, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

C
Chris Lalancette 已提交
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
/**
 * virLibDomainSnapshotError:
 * @snapshot: the snapshot if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the domain snapshot level
 */
static void
virLibDomainSnapshotError(virDomainSnapshotPtr snapshot, virErrorNumber error, const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

    errmsg = virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN_SNAPSHOT)
        conn = snapshot->domain->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_DOMAIN_SNAPSHOT, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

723 724 725 726 727 728 729 730 731 732 733
/**
 * virRegisterNetworkDriver:
 * @driver: pointer to a network driver block
 *
 * Register a network virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterNetworkDriver(virNetworkDriverPtr driver)
{
734 735 736 737 738
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
739
        return(-1);
740 741 742
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
743 744
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
745 746
    }

747 748 749
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

750 751
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
752 753
}

D
Daniel Veillard 已提交
754 755
/**
 * virRegisterInterfaceDriver:
L
Laine Stump 已提交
756
 * @driver: pointer to an interface driver block
D
Daniel Veillard 已提交
757
 *
L
Laine Stump 已提交
758
 * Register an interface virtualization driver
D
Daniel Veillard 已提交
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterInterfaceDriver(virInterfaceDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virInterfaceDriverTabCount >= MAX_DRIVERS) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    DEBUG ("registering %s as interface driver %d",
           driver->name, virInterfaceDriverTabCount);

    virInterfaceDriverTab[virInterfaceDriverTabCount] = driver;
    return virInterfaceDriverTabCount++;
}

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
/**
 * virRegisterStorageDriver:
 * @driver: pointer to a storage driver block
 *
 * Register a storage virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterStorageDriver(virStorageDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virStorageDriverTabCount >= MAX_DRIVERS) {
805
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
806 807 808
        return(-1);
    }

809 810 811
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

812 813 814 815
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
/**
 * virRegisterDeviceMonitor:
 * @driver: pointer to a device monitor block
 *
 * Register a device monitor
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterDeviceMonitor(virDeviceMonitorPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virDeviceMonitorTabCount >= MAX_DRIVERS) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

840 841 842
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

843 844 845 846
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
/**
 * virRegisterSecretDriver:
 * @driver: pointer to a secret driver block
 *
 * Register a secret driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterSecretDriver(virSecretDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virSecretDriverTabCount >= MAX_DRIVERS) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    DEBUG ("registering %s as secret driver %d",
           driver->name, virSecretDriverTabCount);

    virSecretDriverTab[virSecretDriverTabCount] = driver;
    return virSecretDriverTabCount++;
}

S
Stefan Berger 已提交
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
/**
 * virRegisterNWFilterDriver:
 * @driver: pointer to a network filter driver block
 *
 * Register a network filter virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterNWFilterDriver(virNWFilterDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }

    if (virNWFilterDriverTabCount >= MAX_DRIVERS) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }

    DEBUG ("registering %s as network filter driver %d",
           driver->name, virNWFilterDriverTabCount);

    virNWFilterDriverTab[virNWFilterDriverTabCount] = driver;
    return virNWFilterDriverTabCount++;
}


910 911 912 913 914 915 916 917 918 919 920
/**
 * virRegisterDriver:
 * @driver: pointer to a driver block
 *
 * Register a virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterDriver(virDriverPtr driver)
{
921 922 923 924 925
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
926
        return(-1);
927 928 929
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
930 931
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
932 933
    }

934
    if (driver->no < 0) {
935
        virLibConnError
936 937 938 939 940
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

941 942 943
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

944 945
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
946 947
}

A
Atsushi SAKAI 已提交
948
#ifdef WITH_LIBVIRTD
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
/**
 * virRegisterStateDriver:
 * @driver: pointer to a driver block
 *
 * Register a virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterStateDriver(virStateDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virStateDriverTabCount >= MAX_DRIVERS) {
969
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
970 971 972 973 974 975 976
        return(-1);
    }

    virStateDriverTab[virStateDriverTabCount] = driver;
    return virStateDriverTabCount++;
}

977 978
/**
 * virStateInitialize:
979
 * @privileged: set to 1 if running with root priviledge, 0 otherwise
980 981 982
 *
 * Initialize all virtualization drivers.
 *
983
 * Returns 0 if all succeed, -1 upon any failure.
984
 */
985
int virStateInitialize(int privileged) {
986 987 988 989 990 991
    int i, ret = 0;

    if (virInitialize() < 0)
        return -1;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
992
        if (virStateDriverTab[i]->initialize &&
993
            virStateDriverTab[i]->initialize(privileged) < 0) {
994
            VIR_ERROR(_("Initialization of %s state driver failed"),
995
                      virStateDriverTab[i]->name);
996
            ret = -1;
997
        }
998 999 1000 1001
    }
    return ret;
}

1002 1003 1004 1005 1006
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
1007
 * Returns 0 if all succeed, -1 upon any failure.
1008
 */
D
Daniel P. Berrange 已提交
1009
int virStateCleanup(void) {
1010 1011 1012
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
1013 1014
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
1015 1016 1017 1018 1019
            ret = -1;
    }
    return ret;
}

1020 1021 1022 1023 1024
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
1025
 * Returns 0 if all succeed, -1 upon any failure.
1026
 */
D
Daniel P. Berrange 已提交
1027
int virStateReload(void) {
1028 1029 1030
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
1031 1032
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
1033 1034 1035 1036 1037
            ret = -1;
    }
    return ret;
}

1038 1039 1040 1041 1042
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
1043
 * Returns 0 if none are active, 1 if at least one is.
1044
 */
D
Daniel P. Berrange 已提交
1045
int virStateActive(void) {
1046 1047 1048
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
1049 1050
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
1051 1052 1053 1054 1055
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
1056
#endif
1057

1058 1059


1060 1061 1062
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
1063
 * @type: the type of connection/driver looked at
1064 1065 1066 1067 1068
 * @typeVer: return value for the version of the hypervisor (OUT)
 *
 * Provides two information back, @libVer is the version of the library
 * while @typeVer will be the version of the hypervisor type @type against
 * which the library was compiled. If @type is NULL, "Xen" is assumed, if
D
Daniel Veillard 已提交
1069
 * @type is unknown or not available, an error code will be returned and
1070 1071 1072 1073 1074 1075
 * @typeVer will be 0.
 *
 * Returns -1 in case of failure, 0 otherwise, and values for @libVer and
 *       @typeVer have the format major * 1,000,000 + minor * 1,000 + release.
 */
int
1076 1077 1078
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
1079
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
1080

1081
    if (!initialized)
1082
        if (virInitialize() < 0)
1083
            goto error;
1084

1085
    if (libVer == NULL)
1086
        goto error;
1087 1088 1089
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
1090
        if (type == NULL)
1091
            type = "Xen";
1092 1093 1094 1095 1096

/* FIXME: Add _proper_ type version handling for loadable driver modules... */
#ifdef WITH_DRIVER_MODULES
        *typeVer = LIBVIR_VERSION_NUMBER;
#else
1097
        *typeVer = 0;
1098

1099
# if WITH_XEN
1100 1101
        if (STRCASEEQ(type, "Xen"))
            *typeVer = xenUnifiedVersion();
1102 1103
# endif
# if WITH_TEST
1104 1105
        if (STRCASEEQ(type, "Test"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1106 1107
# endif
# if WITH_QEMU
1108 1109
        if (STRCASEEQ(type, "QEMU"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1110 1111
# endif
# if WITH_LXC
1112 1113
        if (STRCASEEQ(type, "LXC"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1114 1115
# endif
# if WITH_PHYP
1116 1117
        if (STRCASEEQ(type, "phyp"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1118 1119
# endif
# if WITH_OPENVZ
1120 1121
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1122 1123
# endif
# if WITH_VBOX
1124 1125
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1126 1127
# endif
# if WITH_UML
1128 1129
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1130 1131
# endif
# if WITH_ONE
D
Daniel Veillard 已提交
1132 1133
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1134 1135
# endif
# if WITH_ESX
1136 1137
        if (STRCASEEQ(type, "ESX"))
            *typeVer = LIBVIR_VERSION_NUMBER;
1138
# endif
1139 1140 1141 1142
# if WITH_XENAPI
        if (STRCASEEQ(type, "XenAPI"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
1143
# if WITH_REMOTE
1144 1145
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
1146
# endif
1147
        if (*typeVer == 0) {
1148
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
1149
            goto error;
1150
        }
1151
#endif /* WITH_DRIVER_MODULES */
1152 1153
    }
    return (0);
1154 1155 1156 1157

error:
    virDispatchError(NULL);
    return -1;
1158 1159
}

1160
static virConnectPtr
1161 1162 1163
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
1164
{
1165
    int i, res;
1166 1167
    virConnectPtr ret;

1168 1169
    virResetLastError();

1170 1171 1172
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
1173

1174 1175 1176 1177 1178 1179 1180 1181
    /*
     *  If no URI is passed, then check for an environment string if not
     *  available probe the compiled in drivers to find a default hypervisor
     *  if detectable.
     */
    if (!name || name[0] == '\0') {
        char *defname = getenv("LIBVIRT_DEFAULT_URI");
        if (defname && *defname) {
1182
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
1183 1184
            name = defname;
        } else {
1185
            name = NULL;
1186
        }
1187
    }
1188

1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
    if (name) {
        /* Convert xen -> xen:/// for back compat */
        if (STRCASEEQ(name, "xen"))
            name = "xen:///";

        /* Convert xen:// -> xen:/// because xmlParseURI cannot parse the
         * former.  This allows URIs such as xen://localhost to work.
         */
        if (STREQ (name, "xen://"))
            name = "xen:///";

        ret->uri = xmlParseURI (name);
        if (!ret->uri) {
            virLibConnError (ret, VIR_ERR_INVALID_ARG,
                             _("could not parse connection URI"));
            goto failed;
        }
1206

1207 1208 1209 1210 1211 1212 1213 1214 1215
        DEBUG("name \"%s\" to URI components:\n"
              "  scheme %s\n"
              "  opaque %s\n"
              "  authority %s\n"
              "  server %s\n"
              "  user %s\n"
              "  port %d\n"
              "  path %s\n",
              name,
1216 1217 1218 1219
              NULLSTR(ret->uri->scheme), NULLSTR(ret->uri->opaque),
              NULLSTR(ret->uri->authority), NULLSTR(ret->uri->server),
              NULLSTR(ret->uri->user), ret->uri->port,
              NULLSTR(ret->uri->path));
1220 1221
    } else {
        DEBUG0("no name, allowing driver auto-select");
1222 1223
    }

1224 1225 1226
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1227
    for (i = 0; i < virDriverTabCount; i++) {
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
        /* We're going to probe the remote driver next. So we have already
         * probed all other client-side-only driver before, but none of them
         * accepted the URI.
         * If the scheme corresponds to a known but disabled client-side-only
         * driver then report a useful error, instead of a cryptic one about
         * not being able to connect to libvirtd or not being able to find
         * certificates. */
        if (virDriverTab[i]->no == VIR_DRV_REMOTE &&
            ret->uri != NULL && ret->uri->scheme != NULL &&
            (
#ifndef WITH_PHYP
             STRCASEEQ(ret->uri->scheme, "phyp") ||
#endif
#ifndef WITH_ESX
1242
             STRCASEEQ(ret->uri->scheme, "vpx") ||
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
             STRCASEEQ(ret->uri->scheme, "esx") ||
             STRCASEEQ(ret->uri->scheme, "gsx") ||
#endif
#ifndef WITH_XENAPI
             STRCASEEQ(ret->uri->scheme, "xenapi") ||
#endif
             false)) {
            virReportErrorHelper(NULL, VIR_FROM_NONE, VIR_ERR_INVALID_ARG,
                                 __FILE__, __FUNCTION__, __LINE__,
                                 _("libvirt was built without the '%s' driver"),
                                 ret->uri->scheme);
            goto failed;
        }

1257 1258
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
1259
        res = virDriverTab[i]->open (ret, auth, flags);
1260 1261 1262 1263 1264
        DEBUG("driver %d %s returned %s",
              i, virDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1265 1266 1267 1268 1269
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1270 1271
    }

1272
    if (!ret->driver) {
1273 1274
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
1275
        goto failed;
1276 1277
    }

1278
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1279
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1280 1281 1282 1283 1284
        DEBUG("network driver %d %s returned %s",
              i, virNetworkDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1285
        if (res == VIR_DRV_OPEN_ERROR) {
1286
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
1287
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
1288 1289
                                   "Is the daemon running ?");
            }
1290 1291
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1292 1293 1294
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1295
    }
1296

D
Daniel Veillard 已提交
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
    for (i = 0; i < virInterfaceDriverTabCount; i++) {
        res = virInterfaceDriverTab[i]->open (ret, auth, flags);
        DEBUG("interface driver %d %s returned %s",
              i, virInterfaceDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
            if (STREQ(virInterfaceDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_INTERFACE,
                                   "Is the daemon running ?");
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->interfaceDriver = virInterfaceDriverTab[i];
            break;
        }
    }
1315 1316 1317

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1318
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1319 1320 1321 1322 1323 1324
        DEBUG("storage driver %d %s returned %s",
              i, virStorageDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
1325
            if (STREQ(virStorageDriverTab[i]->name, "remote")) {
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
                virLibConnWarning (NULL, VIR_WAR_NO_STORAGE,
                                   "Is the daemon running ?");
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->storageDriver = virStorageDriverTab[i];
            break;
        }
    }

1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
    /* Node driver (optional) */
    for (i = 0; i < virDeviceMonitorTabCount; i++) {
        res = virDeviceMonitorTab[i]->open (ret, auth, flags);
        DEBUG("node driver %d %s returned %s",
              i, virDeviceMonitorTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
            if (STREQ(virDeviceMonitorTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NODE,
                                   "Is the libvirtd daemon running ?");
            } else {
                char *msg;
1350 1351
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
    /* Secret manipulation driver. Optional */
    for (i = 0; i < virSecretDriverTabCount; i++) {
        res = virSecretDriverTab[i]->open (ret, auth, flags);
        DEBUG("secret driver %d %s returned %s",
              i, virSecretDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
            if (STREQ(virSecretDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_SECRET,
                                   "Is the daemon running ?");
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->secretDriver = virSecretDriverTab[i];
            break;
        }
    }

S
Stefan Berger 已提交
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
    /* Network filter driver. Optional */
    for (i = 0; i < virNWFilterDriverTabCount; i++) {
        res = virNWFilterDriverTab[i]->open (ret, auth, flags);
        DEBUG("nwfilter driver %d %s returned %s",
              i, virNWFilterDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
            if (STREQ(virNWFilterDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NWFILTER,
                                   _("Is the daemon running ?"));
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->nwfilterDriver = virNWFilterDriverTab[i];
            break;
        }
    }

1403
    return ret;
1404 1405

failed:
1406 1407
    virUnrefConnect(ret);

1408
    return NULL;
1409 1410
}

1411 1412
/**
 * virConnectOpen:
1413
 * @name: URI of the hypervisor
1414
 *
1415
 * This function should be called first to get a connection to the
1416 1417 1418
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1419
 *
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
 * If @name is NULL then probing will be done to determine a suitable
 * default driver to activate. This involves trying each hypervisor
 * in turn until one successfully opens. If the LIBVIRT_DEFAULT_URI
 * environment variable is set, then it will be used in preference
 * to probing for a driver.
 *
 * If connecting to an unprivileged hypervisor driver which requires
 * the libvirtd daemon to be active, it will automatically be launched
 * if not already running. This can be prevented by setting the
 * environment variable LIBVIRT_AUTOSTART=0
 *
1431
 * URIs are documented at http://libvirt.org/uri.html
1432 1433 1434 1435
 */
virConnectPtr
virConnectOpen (const char *name)
{
1436
    virConnectPtr ret = NULL;
1437 1438
    if (!initialized)
        if (virInitialize() < 0)
1439
            goto error;
1440

1441
    DEBUG("name=%s", name);
1442 1443 1444 1445 1446 1447 1448 1449
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1450 1451
}

1452
/**
1453
 * virConnectOpenReadOnly:
1454
 * @name: URI of the hypervisor
1455
 *
1456
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1457
 * library functionalities. The set of APIs usable are then restricted
1458
 * on the available methods to control the domains.
1459
 *
1460 1461 1462
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1463
 * Returns a pointer to the hypervisor connection or NULL in case of error
1464 1465
 *
 * URIs are documented at http://libvirt.org/uri.html
1466
 */
1467
virConnectPtr
1468 1469
virConnectOpenReadOnly(const char *name)
{
1470
    virConnectPtr ret = NULL;
1471 1472
    if (!initialized)
        if (virInitialize() < 0)
1473
            goto error;
1474

1475
    DEBUG("name=%s", name);
1476 1477 1478 1479 1480 1481 1482 1483
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1484 1485 1486 1487 1488 1489 1490 1491
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1492
 * This function should be called first to get a connection to the
1493
 * Hypervisor. If necessary, authentication will be performed fetching
1494 1495
 * credentials via the callback
 *
1496 1497 1498
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1499 1500 1501 1502 1503 1504 1505 1506 1507
 * Returns a pointer to the hypervisor connection or NULL in case of error
 *
 * URIs are documented at http://libvirt.org/uri.html
 */
virConnectPtr
virConnectOpenAuth(const char *name,
                   virConnectAuthPtr auth,
                   int flags)
{
1508
    virConnectPtr ret = NULL;
1509 1510
    if (!initialized)
        if (virInitialize() < 0)
1511
            goto error;
1512

1513
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1514 1515 1516 1517 1518 1519 1520 1521
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1522 1523 1524
}

/**
1525
 * virConnectClose:
D
Daniel Veillard 已提交
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
 * @conn: pointer to the hypervisor connection
 *
 * This function closes the connection to the Hypervisor. This should
 * not be called if further interaction with the Hypervisor are needed
 * especially if there is running domain which need further monitoring by
 * the application.
 *
 * Returns 0 in case of success or -1 in case of error.
 */
int
1536 1537
virConnectClose(virConnectPtr conn)
{
1538
    int ret = -1;
1539 1540
    DEBUG("conn=%p", conn);

1541 1542 1543 1544
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1545
        goto error;
1546
    }
1547

1548 1549 1550 1551 1552 1553 1554 1555
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return ret;
D
Daniel Veillard 已提交
1556 1557
}

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
/**
 * virConnectRef:
 * @conn: the connection to hold a reference on
 *
 * Increment the reference count on the connection. For each
 * additional call to this method, there shall be a corresponding
 * call to virConnectClose to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a connection would increment
 * the reference count.
D
Daniel Veillard 已提交
1572 1573
 *
 * Returns 0 in case of success, -1 in case of failure
1574 1575 1576 1577 1578 1579
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
1580
        virDispatchError(NULL);
1581 1582 1583 1584 1585 1586 1587 1588 1589
        return(-1);
    }
    virMutexLock(&conn->lock);
    DEBUG("conn=%p refs=%d", conn, conn->refs);
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1590 1591
/*
 * Not for public use.  This function is part of the internal
1592 1593 1594
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1595
virDrvSupportsFeature (virConnectPtr conn, int feature)
1596
{
1597
    int ret;
1598 1599
    DEBUG("conn=%p, feature=%d", conn, feature);

1600 1601 1602 1603
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1604
        virDispatchError(NULL);
1605
        return (-1);
1606
    }
1607

1608 1609 1610 1611
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1612 1613

    if (ret < 0)
1614
        virDispatchError(conn);
1615

1616
    return ret;
1617 1618
}

1619 1620 1621 1622 1623 1624 1625
/**
 * virConnectGetType:
 * @conn: pointer to the hypervisor connection
 *
 * Get the name of the Hypervisor software used.
 *
 * Returns NULL in case of error, a static zero terminated string otherwise.
1626 1627 1628
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1629 1630
 */
const char *
1631 1632
virConnectGetType(virConnectPtr conn)
{
1633
    const char *ret;
1634
    DEBUG("conn=%p", conn);
1635

1636 1637
    virResetLastError();

D
Daniel Veillard 已提交
1638
    if (!VIR_IS_CONNECT(conn)) {
1639
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1640
        virDispatchError(NULL);
1641
        return (NULL);
D
Daniel Veillard 已提交
1642
    }
1643 1644 1645 1646

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1647
    }
1648
    return conn->driver->name;
1649 1650
}

D
Daniel Veillard 已提交
1651
/**
1652
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1653
 * @conn: pointer to the hypervisor connection
1654
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1655
 *
1656
 * Get the version level of the Hypervisor running. This may work only with
1657
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1658
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1659
 *
1660 1661 1662
 * Returns -1 in case of error, 0 otherwise. if the version can't be
 *    extracted by lack of capacities returns 0 and @hvVer is 0, otherwise
 *    @hvVer value is major * 1,000,000 + minor * 1,000 + release
D
Daniel Veillard 已提交
1663
 */
1664
int
1665 1666
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1667 1668
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

1669 1670
    virResetLastError();

D
Daniel Veillard 已提交
1671
    if (!VIR_IS_CONNECT(conn)) {
1672
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1673
        virDispatchError(NULL);
1674
        return -1;
D
Daniel Veillard 已提交
1675
    }
1676

D
Daniel Veillard 已提交
1677 1678
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1679
        goto error;
D
Daniel Veillard 已提交
1680
    }
1681

1682 1683 1684 1685 1686 1687
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1688

1689
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1690 1691

error:
1692
    virDispatchError(conn);
1693
    return -1;
1694 1695
}

1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
/**
 * virConnectGetLibVersion:
 * @conn: pointer to the hypervisor connection
 * @libVer: returns the libvirt library version used on the connection (OUT)
 *
 * Provides @libVer, which is the version of libvirt used by the
 *   daemon running on the @conn host
 *
 * Returns -1 in case of failure, 0 otherwise, and values for @libVer have
 *      the format major * 1,000,000 + minor * 1,000 + release.
 */
int
virConnectGetLibVersion(virConnectPtr conn, unsigned long *libVer)
{
    int ret = -1;
    DEBUG("conn=%p, libVir=%p", conn, libVer);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1717
        virDispatchError(NULL);
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
        return -1;
    }

    if (libVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->libvirtVersion) {
        ret = conn->driver->libvirtVersion(conn, libVer);
        if (ret < 0)
            goto error;
        return ret;
    }

1733 1734 1735
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1736
error:
1737
    virDispatchError(conn);
1738 1739 1740
    return ret;
}

1741 1742 1743 1744 1745
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
1746
 * running (the result of the gethostname system call).  If
1747 1748 1749 1750 1751 1752 1753 1754 1755
 * we are connected to a remote system, then this returns the
 * hostname of the remote system.
 *
 * Returns the hostname which must be freed by the caller, or
 * NULL if there was an error.
 */
char *
virConnectGetHostname (virConnectPtr conn)
{
1756 1757
    DEBUG("conn=%p", conn);

1758 1759
    virResetLastError();

1760
    if (!VIR_IS_CONNECT(conn)) {
1761
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1762
        virDispatchError(NULL);
1763 1764 1765
        return NULL;
    }

1766 1767 1768 1769 1770 1771
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1772 1773

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1774 1775

error:
1776
    virDispatchError(conn);
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
    return NULL;
}

/**
 * virConnectGetURI:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the URI (name) of the hypervisor connection.
 * Normally this is the same as or similar to the string passed
 * to the virConnectOpen/virConnectOpenReadOnly call, but
 * the driver may make the URI canonical.  If name == NULL
 * was passed to virConnectOpen, then the driver will return
 * a non-NULL URI which can be used to connect to the same
 * hypervisor later.
 *
 * Returns the URI string which must be freed by the caller, or
 * NULL if there was an error.
 */
char *
virConnectGetURI (virConnectPtr conn)
{
1798
    char *name;
1799 1800
    DEBUG("conn=%p", conn);

1801 1802
    virResetLastError();

1803
    if (!VIR_IS_CONNECT(conn)) {
1804
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1805
        virDispatchError(NULL);
1806 1807 1808
        return NULL;
    }

1809
    name = (char *)xmlSaveUri(conn->uri);
1810
    if (!name) {
1811
        virReportOOMError();
1812
        goto error;
1813 1814
    }
    return name;
1815 1816

error:
1817
    virDispatchError(conn);
1818
    return NULL;
1819 1820
}

1821 1822 1823 1824 1825
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1826
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1827 1828 1829 1830 1831 1832 1833 1834 1835
 * specific type. The 'type' parameter here corresponds to the 'type'
 * attribute in the <domain> element of the XML.
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
virConnectGetMaxVcpus(virConnectPtr conn,
                      const char *type)
{
1836 1837
    DEBUG("conn=%p, type=%s", conn, type);

1838 1839
    virResetLastError();

1840
    if (!VIR_IS_CONNECT(conn)) {
1841
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1842
        virDispatchError(NULL);
1843
        return -1;
1844 1845
    }

1846 1847 1848 1849 1850 1851
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1852

1853
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1854
error:
1855
    virDispatchError(conn);
1856
    return -1;
1857 1858
}

1859
/**
1860
 * virConnectListDomains:
1861 1862 1863 1864 1865 1866 1867 1868 1869
 * @conn: pointer to the hypervisor connection
 * @ids: array to collect the list of IDs of active domains
 * @maxids: size of @ids
 *
 * Collect the list of active domains, and store their ID in @maxids
 *
 * Returns the number of domain found or -1 in case of error
 */
int
1870 1871
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1872 1873
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1874 1875
    virResetLastError();

D
Daniel Veillard 已提交
1876
    if (!VIR_IS_CONNECT(conn)) {
1877
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1878
        virDispatchError(NULL);
1879
        return -1;
D
Daniel Veillard 已提交
1880
    }
1881

1882
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1883
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1884
        goto error;
D
Daniel Veillard 已提交
1885
    }
1886

1887 1888 1889 1890 1891 1892
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1893

1894
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1895
error:
1896
    virDispatchError(conn);
1897
    return -1;
D
Daniel Veillard 已提交
1898 1899
}

K
 
Karel Zak 已提交
1900 1901 1902 1903
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1904 1905
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1906 1907 1908
 * Returns the number of domain found or -1 in case of error
 */
int
1909 1910
virConnectNumOfDomains(virConnectPtr conn)
{
1911 1912
    DEBUG("conn=%p", conn);

1913 1914
    virResetLastError();

D
Daniel Veillard 已提交
1915
    if (!VIR_IS_CONNECT(conn)) {
1916
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1917
        virDispatchError(NULL);
1918
        return -1;
D
Daniel Veillard 已提交
1919
    }
K
Karel Zak 已提交
1920

1921 1922 1923 1924 1925 1926
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1927

1928
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1929
error:
1930
    virDispatchError(conn);
1931
    return -1;
K
 
Karel Zak 已提交
1932 1933
}

1934 1935 1936 1937
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1938
 * Provides the connection pointer associated with a domain.  The
1939 1940 1941
 * reference counter on the connection is not increased by this
 * call.
 *
1942 1943 1944 1945
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1946 1947 1948 1949 1950
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1951 1952
    DEBUG("dom=%p", dom);

1953 1954 1955
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1956
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1957
        virDispatchError(NULL);
1958 1959 1960 1961 1962
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1963
/**
1964
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1965
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1966
 * @xmlDesc: string containing an XML description of the domain
1967
 * @flags: bitwise-or of supported virDomainCreateFlags
D
Daniel Veillard 已提交
1968
 *
1969
 * Launch a new guest domain, based on an XML description similar
1970
 * to the one returned by virDomainGetXMLDesc()
1971
 * This function may requires privileged access to the hypervisor.
1972 1973 1974
 * The domain is not persistent, so its definition will disappear when it
 * is destroyed, or if the host is restarted (see virDomainDefineXML() to
 * define persistent domains).
1975
 *
D
Daniel Veillard 已提交
1976 1977
 * Returns a new domain object or NULL in case of failure
 */
1978
virDomainPtr
1979 1980
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1981
{
1982 1983
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

1984 1985
    virResetLastError();

D
Daniel Veillard 已提交
1986
    if (!VIR_IS_CONNECT(conn)) {
1987
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1988
        virDispatchError(NULL);
1989
        return (NULL);
D
Daniel Veillard 已提交
1990 1991 1992
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1993
        goto error;
D
Daniel Veillard 已提交
1994
    }
1995 1996
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1997
        goto error;
1998
    }
D
Daniel Veillard 已提交
1999

2000 2001 2002 2003 2004 2005 2006
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
2007 2008

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2009
error:
2010
    virDispatchError(conn);
2011
    return NULL;
D
Daniel Veillard 已提交
2012 2013
}

2014 2015 2016 2017 2018 2019 2020 2021
/**
 * virDomainCreateLinux:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: string containing an XML description of the domain
 * @flags: callers should always pass 0
 *
 * Deprecated after 0.4.6.
 * Renamed to virDomainCreateXML() providing identical functionality.
2022
 * This existing name will left indefinitely for API compatibility.
2023 2024 2025 2026 2027 2028 2029 2030 2031
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
{
    return(virDomainCreateXML(conn, xmlDesc, flags));
}
2032

2033
/**
2034
 * virDomainLookupByID:
2035 2036 2037 2038
 * @conn: pointer to the hypervisor connection
 * @id: the domain ID number
 *
 * Try to find a domain based on the hypervisor ID number
D
Daniel Veillard 已提交
2039 2040
 * Note that this won't work for inactive domains which have an ID of -1,
 * in that case a lookup based on the Name or UUId need to be done instead.
2041
 *
2042 2043
 * Returns a new domain object or NULL in case of failure.  If the
 * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
2044
 */
2045
virDomainPtr
2046 2047
virDomainLookupByID(virConnectPtr conn, int id)
{
2048 2049
    DEBUG("conn=%p, id=%d", conn, id);

2050 2051
    virResetLastError();

D
Daniel Veillard 已提交
2052
    if (!VIR_IS_CONNECT(conn)) {
2053
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2054
        virDispatchError(NULL);
2055
        return (NULL);
D
Daniel Veillard 已提交
2056 2057 2058
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2059
        goto error;
D
Daniel Veillard 已提交
2060
    }
2061

2062 2063 2064 2065 2066 2067 2068
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
2069

2070
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2071 2072

error:
2073
    virDispatchError(conn);
2074
    return NULL;
2075 2076 2077 2078 2079
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
2080
 * @uuid: the raw UUID for the domain
2081 2082 2083
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
2084 2085
 * Returns a new domain object or NULL in case of failure.  If the
 * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
2086 2087
 */
virDomainPtr
2088 2089
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
2090 2091
    DEBUG("conn=%p, uuid=%s", conn, uuid);

2092 2093
    virResetLastError();

D
Daniel Veillard 已提交
2094
    if (!VIR_IS_CONNECT(conn)) {
2095
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2096
        virDispatchError(NULL);
2097
        return (NULL);
D
Daniel Veillard 已提交
2098 2099 2100
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2101
        goto error;
D
Daniel Veillard 已提交
2102
    }
2103

2104 2105 2106 2107 2108 2109 2110
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
2111

2112
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2113 2114

error:
2115
    virDispatchError(conn);
2116
    return NULL;
2117 2118
}

K
Karel Zak 已提交
2119 2120 2121 2122 2123 2124 2125
/**
 * virDomainLookupByUUIDString:
 * @conn: pointer to the hypervisor connection
 * @uuidstr: the string UUID for the domain
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
2126 2127
 * Returns a new domain object or NULL in case of failure.  If the
 * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
K
Karel Zak 已提交
2128 2129 2130 2131
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
2132
    unsigned char uuid[VIR_UUID_BUFLEN];
2133 2134
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

2135 2136
    virResetLastError();

K
Karel Zak 已提交
2137
    if (!VIR_IS_CONNECT(conn)) {
2138
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2139
        virDispatchError(NULL);
K
Karel Zak 已提交
2140 2141 2142 2143
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2144
        goto error;
K
Karel Zak 已提交
2145
    }
2146 2147

    if (virUUIDParse(uuidstr, uuid) < 0) {
2148
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2149
        goto error;
K
Karel Zak 已提交
2150
    }
2151

K
Karel Zak 已提交
2152
    return virDomainLookupByUUID(conn, &uuid[0]);
2153 2154

error:
2155
    virDispatchError(conn);
2156
    return NULL;
K
Karel Zak 已提交
2157 2158
}

2159 2160 2161 2162 2163
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
2164
 * Try to lookup a domain on the given hypervisor based on its name.
2165
 *
2166 2167
 * Returns a new domain object or NULL in case of failure.  If the
 * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
2168 2169
 */
virDomainPtr
2170 2171
virDomainLookupByName(virConnectPtr conn, const char *name)
{
2172 2173
    DEBUG("conn=%p, name=%s", conn, name);

2174 2175
    virResetLastError();

D
Daniel Veillard 已提交
2176
    if (!VIR_IS_CONNECT(conn)) {
2177
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2178
        virDispatchError(NULL);
2179
        return (NULL);
D
Daniel Veillard 已提交
2180 2181 2182
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2183
        goto error;
D
Daniel Veillard 已提交
2184
    }
2185

2186 2187 2188 2189 2190 2191 2192
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2193 2194

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2195 2196

error:
2197
    virDispatchError(conn);
2198
    return NULL;
2199 2200
}

D
Daniel Veillard 已提交
2201
/**
2202
 * virDomainDestroy:
D
Daniel Veillard 已提交
2203 2204 2205
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
2206 2207 2208
 * already and all resources used by it are given back to the hypervisor. This
 * does not free the associated virDomainPtr object.
 * This function may require privileged access
D
Daniel Veillard 已提交
2209 2210
 *
 * Returns 0 in case of success and -1 in case of failure.
2211
 */
D
Daniel Veillard 已提交
2212
int
2213 2214
virDomainDestroy(virDomainPtr domain)
{
2215
    virConnectPtr conn;
2216

2217 2218
    DEBUG("domain=%p", domain);

2219 2220
    virResetLastError();

D
Daniel Veillard 已提交
2221
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2222
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2223
        virDispatchError(NULL);
2224
        return (-1);
D
Daniel Veillard 已提交
2225
    }
2226

2227
    conn = domain->conn;
2228 2229
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2230
        goto error;
2231
    }
2232

2233 2234 2235 2236 2237 2238 2239
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2240

2241
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2242 2243

error:
2244
    virDispatchError(conn);
2245
    return -1;
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257
}

/**
 * virDomainFree:
 * @domain: a domain object
 *
 * Free the domain object. The running instance is kept alive.
 * The data structure is freed and should not be used thereafter.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2258 2259
virDomainFree(virDomainPtr domain)
{
2260 2261
    DEBUG("domain=%p", domain);

2262 2263 2264
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2265
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2266
        virDispatchError(NULL);
2267
        return (-1);
D
Daniel Veillard 已提交
2268
    }
2269 2270
    if (virUnrefDomain(domain) < 0) {
        virDispatchError(NULL);
2271
        return -1;
2272
    }
2273
    return(0);
D
Daniel Veillard 已提交
2274 2275
}

2276 2277
/**
 * virDomainRef:
D
Daniel Veillard 已提交
2278
 * @domain: the domain to hold a reference on
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
 *
 * Increment the reference count on the domain. For each
 * additional call to this method, there shall be a corresponding
 * call to virDomainFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a domain would increment
 * the reference count.
D
Daniel Veillard 已提交
2290 2291
 *
 * Returns 0 in case of success and -1 in case of failure.
2292 2293 2294 2295 2296 2297
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
2298
        virDispatchError(NULL);
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
        return(-1);
    }
    virMutexLock(&domain->conn->lock);
    DEBUG("domain=%p refs=%d", domain, domain->refs);
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
2309
/**
2310
 * virDomainSuspend:
D
Daniel Veillard 已提交
2311 2312 2313
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
2314
 * to CPU resources and I/O but the memory used by the domain at the
2315
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
2316
 * the domain.
2317
 * This function may requires privileged access.
D
Daniel Veillard 已提交
2318 2319 2320 2321
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2322 2323
virDomainSuspend(virDomainPtr domain)
{
2324
    virConnectPtr conn;
2325
    DEBUG("domain=%p", domain);
2326

2327 2328
    virResetLastError();

D
Daniel Veillard 已提交
2329
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2330
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2331
        virDispatchError(NULL);
2332
        return (-1);
D
Daniel Veillard 已提交
2333
    }
2334 2335
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2336
        goto error;
2337
    }
D
Daniel Veillard 已提交
2338

2339 2340
    conn = domain->conn;

2341 2342 2343 2344 2345 2346 2347
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2348

2349
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2350 2351

error:
2352
    virDispatchError(domain->conn);
2353
    return -1;
D
Daniel Veillard 已提交
2354 2355 2356
}

/**
2357
 * virDomainResume:
D
Daniel Veillard 已提交
2358 2359
 * @domain: a domain object
 *
D
Dan Kenigsberg 已提交
2360
 * Resume a suspended domain, the process is restarted from the state where
2361
 * it was frozen by calling virSuspendDomain().
2362
 * This function may requires privileged access
D
Daniel Veillard 已提交
2363 2364 2365 2366
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2367 2368
virDomainResume(virDomainPtr domain)
{
2369
    virConnectPtr conn;
2370
    DEBUG("domain=%p", domain);
2371

2372 2373
    virResetLastError();

D
Daniel Veillard 已提交
2374
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2375
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2376
        virDispatchError(NULL);
2377
        return (-1);
D
Daniel Veillard 已提交
2378
    }
2379 2380
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2381
        goto error;
2382
    }
D
Daniel Veillard 已提交
2383

2384 2385
    conn = domain->conn;

2386 2387 2388 2389 2390 2391 2392
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2393

2394
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2395 2396

error:
2397
    virDispatchError(domain->conn);
2398
    return -1;
D
Daniel Veillard 已提交
2399 2400
}

2401 2402 2403 2404 2405 2406
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2407 2408 2409
 * a file on disk. After the call, if successful, the domain is not
 * listed as running anymore (this may be a problem).
 * Use virDomainRestore() to restore a domain after saving.
2410 2411 2412 2413
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2414 2415
virDomainSave(virDomainPtr domain, const char *to)
{
2416
    char filepath[4096];
2417
    virConnectPtr conn;
2418
    DEBUG("domain=%p, to=%s", domain, to);
2419

2420 2421
    virResetLastError();

D
Daniel Veillard 已提交
2422
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2423
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2424
        virDispatchError(NULL);
2425
        return (-1);
D
Daniel Veillard 已提交
2426
    }
2427 2428
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2429
        goto error;
2430
    }
2431
    conn = domain->conn;
D
Daniel Veillard 已提交
2432 2433
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2434
        goto error;
D
Daniel Veillard 已提交
2435
    }
2436

2437 2438 2439 2440 2441
    /*
     * We must absolutize the file path as the save is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (to[0] != '/') {
2442
        unsigned int len, t;
2443

2444 2445 2446 2447 2448 2449 2450 2451 2452 2453
        t = strlen(to);
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL)
            return (-1);
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
        if (len > sizeof(filepath) - (t + 3))
            return (-1);
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];
2454 2455 2456

    }

2457 2458 2459 2460 2461 2462 2463
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2464

2465
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2466 2467

error:
2468
    virDispatchError(domain->conn);
2469
    return -1;
2470 2471 2472 2473
}

/**
 * virDomainRestore:
2474
 * @conn: pointer to the hypervisor connection
2475
 * @from: path to the
2476 2477 2478 2479 2480 2481
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2482 2483
virDomainRestore(virConnectPtr conn, const char *from)
{
2484
    char filepath[4096];
2485
    DEBUG("conn=%p, from=%s", conn, from);
2486

2487 2488
    virResetLastError();

D
Daniel Veillard 已提交
2489
    if (!VIR_IS_CONNECT(conn)) {
2490
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2491
        virDispatchError(NULL);
2492
        return (-1);
D
Daniel Veillard 已提交
2493
    }
2494 2495
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2496
        goto error;
2497
    }
D
Daniel Veillard 已提交
2498 2499
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2500
        goto error;
D
Daniel Veillard 已提交
2501 2502
    }

2503 2504 2505 2506 2507
    /*
     * We must absolutize the file path as the restore is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (from[0] != '/') {
2508 2509 2510
        unsigned int len, t;

        t = strlen(from);
2511 2512 2513 2514 2515
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2516 2517
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2518 2519 2520 2521 2522
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2523 2524 2525 2526 2527
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2528 2529 2530 2531 2532 2533 2534
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2535

2536
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2537 2538

error:
2539
    virDispatchError(conn);
2540
    return -1;
D
Daniel Veillard 已提交
2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559
}

/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
 * @flags: extra flags, currently unused
 *
 * This method will dump the core of a domain on a given file for analysis.
 * Note that for remote Xen Daemon the file path will be interpreted in
 * the remote host.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainCoreDump(virDomainPtr domain, const char *to, int flags)
{
    char filepath[4096];
    virConnectPtr conn;
2560
    DEBUG("domain=%p, to=%s, flags=%d", domain, to, flags);
D
Daniel Veillard 已提交
2561

2562 2563
    virResetLastError();

D
Daniel Veillard 已提交
2564
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2565
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2566
        virDispatchError(NULL);
D
Daniel Veillard 已提交
2567 2568 2569 2570
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2571
        goto error;
D
Daniel Veillard 已提交
2572 2573 2574 2575
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2576
        goto error;
D
Daniel Veillard 已提交
2577 2578 2579 2580 2581 2582 2583 2584 2585 2586
    }

    /*
     * We must absolutize the file path as the save is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (to[0] != '/') {
        unsigned int len, t;

        t = strlen(to);
2587 2588 2589 2590 2591
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibDomainError(domain, VIR_ERR_SYSTEM_ERROR,
                              _("cannot get current directory"));
            goto error;
        }
D
Daniel Veillard 已提交
2592 2593
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2594 2595 2596 2597 2598
        if (len > sizeof(filepath) - (t + 3)) {
            virLibDomainError(domain, VIR_ERR_INTERNAL_ERROR,
                              _("path too long"));
            goto error;
        }
D
Daniel Veillard 已提交
2599 2600 2601 2602 2603 2604
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

2605 2606 2607 2608 2609 2610 2611
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2612

2613
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2614 2615

error:
2616
    virDispatchError(domain->conn);
2617
    return -1;
2618 2619
}

2620 2621 2622 2623 2624
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2625 2626
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2627 2628 2629 2630 2631 2632 2633
 *
 * TODO: should we add an option for reboot, knowing it may not be doable
 *       in the general case ?
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2634 2635
virDomainShutdown(virDomainPtr domain)
{
2636
    virConnectPtr conn;
2637
    DEBUG("domain=%p", domain);
2638

2639 2640
    virResetLastError();

D
Daniel Veillard 已提交
2641
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2642
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2643
        virDispatchError(NULL);
2644
        return (-1);
D
Daniel Veillard 已提交
2645
    }
2646 2647
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2648
        goto error;
2649
    }
2650

2651 2652
    conn = domain->conn;

2653 2654 2655 2656 2657 2658 2659
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2660

2661
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2662 2663

error:
2664
    virDispatchError(domain->conn);
2665
    return -1;
2666 2667
}

2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681
/**
 * virDomainReboot:
 * @domain: a domain object
 * @flags: extra flags for the reboot operation, not used yet
 *
 * Reboot a domain, the domain object is still usable there after but
 * the domain OS is being stopped for a restart.
 * Note that the guest OS may ignore the request.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainReboot(virDomainPtr domain, unsigned int flags)
{
2682
    virConnectPtr conn;
2683
    DEBUG("domain=%p, flags=%u", domain, flags);
2684

2685 2686
    virResetLastError();

2687
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2688
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2689
        virDispatchError(NULL);
2690 2691
        return (-1);
    }
2692 2693
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2694
        goto error;
2695
    }
2696

2697 2698
    conn = domain->conn;

2699 2700 2701 2702 2703 2704 2705
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2706

2707
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2708 2709

error:
2710
    virDispatchError(domain->conn);
2711
    return -1;
2712 2713
}

2714
/**
2715
 * virDomainGetName:
2716 2717 2718 2719 2720 2721 2722 2723
 * @domain: a domain object
 *
 * Get the public name for that domain
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * its lifetime will be the same as the domain object.
 */
const char *
2724 2725
virDomainGetName(virDomainPtr domain)
{
2726 2727
    DEBUG("domain=%p", domain);

2728 2729
    virResetLastError();

D
Daniel Veillard 已提交
2730
    if (!VIR_IS_DOMAIN(domain)) {
2731
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2732
        virDispatchError(NULL);
2733
        return (NULL);
D
Daniel Veillard 已提交
2734
    }
2735
    return (domain->name);
2736 2737
}

2738 2739 2740
/**
 * virDomainGetUUID:
 * @domain: a domain object
2741
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2742 2743 2744 2745 2746 2747
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2748 2749
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2750 2751
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2752 2753
    virResetLastError();

D
Daniel Veillard 已提交
2754
    if (!VIR_IS_DOMAIN(domain)) {
2755
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2756
        virDispatchError(NULL);
2757
        return (-1);
D
Daniel Veillard 已提交
2758 2759 2760
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2761
        virDispatchError(domain->conn);
2762
        return (-1);
D
Daniel Veillard 已提交
2763 2764
    }

2765 2766
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2767
    return (0);
2768 2769
}

K
Karel Zak 已提交
2770 2771 2772
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2773
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2774
 *
2775
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2776 2777 2778 2779 2780 2781 2782
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2783
    unsigned char uuid[VIR_UUID_BUFLEN];
2784
    DEBUG("domain=%p, buf=%p", domain, buf);
2785

2786 2787
    virResetLastError();

K
Karel Zak 已提交
2788
    if (!VIR_IS_DOMAIN(domain)) {
2789
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2790
        virDispatchError(NULL);
K
Karel Zak 已提交
2791 2792 2793 2794
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2795
        goto error;
K
Karel Zak 已提交
2796
    }
2797

K
Karel Zak 已提交
2798
    if (virDomainGetUUID(domain, &uuid[0]))
2799
        goto error;
K
Karel Zak 已提交
2800

2801
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2802
    return (0);
2803 2804

error:
2805
    virDispatchError(domain->conn);
2806
    return -1;
K
Karel Zak 已提交
2807 2808
}

2809
/**
2810
 * virDomainGetID:
2811 2812 2813 2814 2815 2816 2817
 * @domain: a domain object
 *
 * Get the hypervisor ID number for the domain
 *
 * Returns the domain ID number or (unsigned int) -1 in case of error
 */
unsigned int
2818 2819
virDomainGetID(virDomainPtr domain)
{
2820 2821
    DEBUG("domain=%p", domain);

2822 2823
    virResetLastError();

D
Daniel Veillard 已提交
2824
    if (!VIR_IS_DOMAIN(domain)) {
2825
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2826
        virDispatchError(NULL);
2827
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2828
    }
2829
    return (domain->id);
2830 2831
}

2832 2833 2834 2835 2836 2837
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2838 2839
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2840 2841
 */
char *
2842 2843
virDomainGetOSType(virDomainPtr domain)
{
2844
    virConnectPtr conn;
2845
    DEBUG("domain=%p", domain);
2846

2847 2848 2849
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2850
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2851
        virDispatchError(NULL);
2852
        return (NULL);
D
Daniel Veillard 已提交
2853
    }
2854

2855 2856
    conn = domain->conn;

2857 2858 2859 2860 2861 2862 2863
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2864

2865
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2866 2867

error:
2868
    virDispatchError(domain->conn);
2869
    return NULL;
2870 2871
}

2872
/**
2873
 * virDomainGetMaxMemory:
2874
 * @domain: a domain object or NULL
2875
 *
2876 2877 2878 2879 2880 2881 2882
 * Retrieve the maximum amount of physical memory allocated to a
 * domain. If domain is NULL, then this get the amount of memory reserved
 * to Domain0 i.e. the domain where the application runs.
 *
 * Returns the memory size in kilobytes or 0 in case of error.
 */
unsigned long
2883 2884
virDomainGetMaxMemory(virDomainPtr domain)
{
2885
    virConnectPtr conn;
2886
    DEBUG("domain=%p", domain);
2887

2888 2889
    virResetLastError();

D
Daniel Veillard 已提交
2890
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2891
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2892
        virDispatchError(NULL);
2893
        return (0);
D
Daniel Veillard 已提交
2894
    }
2895

2896 2897
    conn = domain->conn;

2898 2899 2900 2901 2902 2903 2904
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2905

2906
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2907 2908

error:
2909
    virDispatchError(domain->conn);
2910
    return 0;
2911 2912
}

D
Daniel Veillard 已提交
2913
/**
2914
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2915 2916
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2917
 *
D
Daniel Veillard 已提交
2918 2919 2920
 * Dynamically change the maximum amount of physical memory allocated to a
 * domain. If domain is NULL, then this change the amount of memory reserved
 * to Domain0 i.e. the domain where the application runs.
2921
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2922
 *
2923 2924 2925
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
D
Daniel Veillard 已提交
2926 2927 2928
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2929 2930
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2931
    virConnectPtr conn;
2932
    DEBUG("domain=%p, memory=%lu", domain, memory);
2933

2934 2935
    virResetLastError();

2936
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2937
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2938
        virDispatchError(NULL);
2939
        return (-1);
2940
    }
2941 2942
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2943
        goto error;
2944 2945 2946
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2947
        goto error;
2948
    }
2949
    conn = domain->conn;
2950

2951 2952 2953 2954 2955 2956 2957
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2958

2959
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2960 2961

error:
2962
    virDispatchError(domain->conn);
2963
    return -1;
2964
}
2965

2966 2967 2968 2969
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2970
 *
2971 2972 2973
 * Dynamically change the target amount of physical memory allocated to a
 * domain. If domain is NULL, then this change the amount of memory reserved
 * to Domain0 i.e. the domain where the application runs.
2974
 * This function may requires privileged access to the hypervisor.
2975
 *
2976 2977 2978
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
2979 2980 2981 2982 2983 2984
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2985
    DEBUG("domain=%p, memory=%lu", domain, memory);
2986

2987 2988
    virResetLastError();

2989
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2990
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2991
        virDispatchError(NULL);
2992
        return (-1);
2993
    }
2994 2995
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2996
        goto error;
2997 2998 2999
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
3000
        goto error;
3001 3002 3003
    }

    conn = domain->conn;
3004

3005 3006 3007 3008 3009 3010 3011
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3012

3013
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3014 3015

error:
3016
    virDispatchError(domain->conn);
3017
    return -1;
D
Daniel Veillard 已提交
3018 3019
}

3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
/**
 * virDomainSetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter objects
 * @nparams: number of memory parameter (this value should be same or
 *          less than the number of parameters supported)
 * @flags: currently unused, for future extension
 *
 * Change the memory tunables
 * This function requires privileged access to the hypervisor.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetMemoryParameters(virDomainPtr domain,
                             virMemoryParameterPtr params,
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, params=%p, nparams=%d, flags=%u", domain, params, nparams, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainSetMemoryParameters) {
        int ret;
        ret = conn->driver->domainSetMemoryParameters (domain, params, nparams, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainGetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter object
 *          (return value, allocated by the caller)
 * @nparams: pointer to number of memory parameters
 * @flags: currently unused, for future extension
 *
 * Get the memory parameters, the @params array will be filled with the values
 * equal to the number of parameters suggested by @nparams
 *
3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100
 * As the value of @nparams is dynamic, call the API setting @nparams to 0 and
 * @params as NULL, the API returns the number of parameters supported by the
 * HV by updating @nparams on SUCCESS. The caller should then allocate @params
 * array, i.e. (sizeof(@virMemoryParameter) * @nparams) bytes and call the API
 * again.
 *
 * Here is the sample code snippet:
 *
 * if ((virDomainGetMemoryParameters(dom, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
 *     params = vshMalloc(ctl, sizeof(virMemoryParameter) * nparams);
 *     memset(params, 0, sizeof(virMemoryParameter) * nparams);
 *     if (virDomainGetMemoryParameters(dom, params, &nparams, 0)) {
 *         vshError(ctl, "%s", _("Unable to get memory parameters"));
 *         goto error;
 *     }
 * }
3101 3102
 *
 * This function requires privileged access to the hypervisor. This function
3103
 * expects the caller to allocate the @params.
3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
                             virMemoryParameterPtr params,
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, params=%p, nparams=%d, flags=%u", domain, params, (nparams)?*nparams:-1, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if ((nparams == NULL) || (*nparams < 0)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainGetMemoryParameters) {
        int ret;
        ret = conn->driver->domainGetMemoryParameters (domain, params, nparams, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

3142 3143
/**
 * virDomainGetInfo:
3144
 * @domain: a domain object
3145
 * @info: pointer to a virDomainInfo structure allocated by the user
3146
 *
3147
 * Extract information about a domain. Note that if the connection
3148
 * used to get the domain is limited only a partial set of the information
3149 3150 3151 3152 3153
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3154 3155
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3156
    virConnectPtr conn;
3157
    DEBUG("domain=%p, info=%p", domain, info);
3158

3159 3160
    virResetLastError();

D
Daniel Veillard 已提交
3161
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3162
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3163
        virDispatchError(NULL);
3164
        return (-1);
D
Daniel Veillard 已提交
3165 3166 3167
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
3168
        goto error;
D
Daniel Veillard 已提交
3169
    }
3170

3171
    memset(info, 0, sizeof(virDomainInfo));
3172

3173 3174
    conn = domain->conn;

3175 3176 3177 3178 3179 3180 3181
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3182

3183
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3184 3185

error:
3186
    virDispatchError(domain->conn);
3187
    return -1;
3188
}
3189

3190 3191 3192
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3193
 * @flags: an OR'ed set of virDomainXMLFlags
3194 3195
 *
 * Provide an XML description of the domain. The description may be reused
3196
 * later to relaunch the domain with virDomainCreateXML().
3197 3198 3199 3200 3201
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3202 3203
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
3204
    virConnectPtr conn;
3205
    DEBUG("domain=%p, flags=%d", domain, flags);
3206

3207 3208 3209
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3210
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3211
        virDispatchError(NULL);
3212
        return (NULL);
D
Daniel Veillard 已提交
3213
    }
3214

3215 3216
    conn = domain->conn;

3217 3218 3219 3220 3221 3222
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

3223 3224
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

3225 3226 3227 3228 3229 3230 3231
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
3232

3233
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3234 3235

error:
3236
    virDispatchError(domain->conn);
3237
    return NULL;
3238
}
3239

3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
/**
 * virConnectDomainXMLFromNative:
 * @conn: a connection object
 * @nativeFormat: configuration format importing from
 * @nativeConfig: the configuration data to import
 * @flags: currently unused, pass 0
 *
 * Reads native configuration data  describing a domain, and
 * generates libvirt domain XML. The format of the native
 * data is hypervisor dependant.
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *virConnectDomainXMLFromNative(virConnectPtr conn,
                                    const char *nativeFormat,
                                    const char *nativeConfig,
                                    unsigned int flags)
{
    DEBUG("conn=%p, format=%s config=%s flags=%u", conn, nativeFormat, nativeConfig, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3265
        virDispatchError(NULL);
3266 3267 3268 3269 3270
        return (NULL);
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3271
        goto error;
3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287
    }

    if (conn->driver->domainXMLFromNative) {
        char *ret;
        ret = conn->driver->domainXMLFromNative (conn,
                                                 nativeFormat,
                                                 nativeConfig,
                                                 flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
3288
    virDispatchError(conn);
3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299
    return NULL;
}

/**
 * virConnectDomainXMLToNative:
 * @conn: a connection object
 * @nativeFormat: configuration format exporting to
 * @domainXml: the domain configuration to export
 * @flags: currently unused, pass 0
 *
 * Reads a domain XML configuration document, and generates
E
Eric Blake 已提交
3300
 * a native configuration file describing the domain.
3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316
 * The format of the native data is hypervisor dependant.
 *
 * Returns a 0 terminated UTF-8 encoded native config datafile, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *virConnectDomainXMLToNative(virConnectPtr conn,
                                  const char *nativeFormat,
                                  const char *domainXml,
                                  unsigned int flags)
{
    DEBUG("conn=%p, format=%s xml=%s flags=%u", conn, nativeFormat, domainXml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3317
        virDispatchError(NULL);
3318 3319 3320 3321 3322
        return (NULL);
    }

    if (nativeFormat == NULL || domainXml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3323
        goto error;
3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339
    }

    if (conn->driver->domainXMLToNative) {
        char *ret;
        ret = conn->driver->domainXMLToNative(conn,
                                              nativeFormat,
                                              domainXml,
                                              flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
3340
    virDispatchError(conn);
3341 3342 3343 3344
    return NULL;
}


3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355
static virDomainPtr
virDomainMigrateVersion1 (virDomainPtr domain,
                          virConnectPtr dconn,
                          unsigned long flags,
                          const char *dname,
                          const char *uri,
                          unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookie = NULL;
3356 3357 3358 3359 3360 3361 3362
    int cookielen = 0, ret;
    virDomainInfo info;

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426

    /* Prepare the migration.
     *
     * The destination host may return a cookie, or leave cookie as
     * NULL.
     *
     * The destination host MUST set uri_out if uri_in is NULL.
     *
     * If uri_in is non-NULL, then the destination host may modify
     * the URI by setting uri_out.  If it does not wish to modify
     * the URI, it should leave uri_out as NULL.
     */
    if (dconn->driver->domainMigratePrepare
        (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname,
         bandwidth) == -1)
        goto done;

    if (uri == NULL && uri_out == NULL) {
        virLibConnError (domain->conn, VIR_ERR_INTERNAL_ERROR,
                         _("domainMigratePrepare did not set uri"));
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare change URI? */
    assert (uri != NULL);

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    if (domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth) == -1)
        goto done;

    /* Get the destination domain and return it or error.
     * 'domain' no longer actually exists at this point
     * (or so we hope), but we still use the object in memory
     * in order to get the name.
     */
    dname = dname ? dname : domain->name;
    if (dconn->driver->domainMigrateFinish)
        ddomain = dconn->driver->domainMigrateFinish
            (dconn, dname, cookie, cookielen, uri, flags);
    else
        ddomain = virDomainLookupByName (dconn, dname);

 done:
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

static virDomainPtr
virDomainMigrateVersion2 (virDomainPtr domain,
                          virConnectPtr dconn,
                          unsigned long flags,
                          const char *dname,
                          const char *uri,
                          unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookie = NULL;
    char *dom_xml = NULL;
    int cookielen = 0, ret;
3427
    virDomainInfo info;
3428
    virErrorPtr orig_err = NULL;
3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447

    /* Prepare the migration.
     *
     * The destination host may return a cookie, or leave cookie as
     * NULL.
     *
     * The destination host MUST set uri_out if uri_in is NULL.
     *
     * If uri_in is non-NULL, then the destination host may modify
     * the URI by setting uri_out.  If it does not wish to modify
     * the URI, it should leave uri_out as NULL.
     */

    /* In version 2 of the protocol, the prepare step is slightly
     * different.  We fetch the domain XML of the source domain
     * and pass it to Prepare2.
     */
    if (!domain->conn->driver->domainDumpXML) {
        virLibConnError (domain->conn, VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
3448
        virDispatchError(domain->conn);
3449 3450 3451
        return NULL;
    }
    dom_xml = domain->conn->driver->domainDumpXML (domain,
3452 3453
                                                   VIR_DOMAIN_XML_SECURE |
                                                   VIR_DOMAIN_XML_UPDATE_CPU);
3454 3455 3456
    if (!dom_xml)
        return NULL;

3457 3458 3459 3460 3461
    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }

3462 3463 3464 3465 3466 3467 3468 3469 3470 3471
    ret = dconn->driver->domainMigratePrepare2
        (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname,
         bandwidth, dom_xml);
    VIR_FREE (dom_xml);
    if (ret == -1)
        goto done;

    if (uri == NULL && uri_out == NULL) {
        virLibConnError (domain->conn, VIR_ERR_INTERNAL_ERROR,
                         _("domainMigratePrepare2 did not set uri"));
3472
        virDispatchError(domain->conn);
3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare2 change URI? */
    assert (uri != NULL);

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    ret = domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth);

3485 3486 3487 3488
    /* Perform failed. Make sure Finish doesn't overwrite the error */
    if (ret < 0)
        orig_err = virSaveLastError();

3489 3490 3491 3492 3493 3494 3495 3496 3497
    /* In version 2 of the migration protocol, we pass the
     * status code from the sender to the destination host,
     * so it can do any cleanup if the migration failed.
     */
    dname = dname ? dname : domain->name;
    ddomain = dconn->driver->domainMigrateFinish2
        (dconn, dname, cookie, cookielen, uri, flags, ret);

 done:
3498 3499 3500 3501
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
3502 3503 3504 3505 3506
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524

 /*
  * This is sort of a migration v3
  *
  * In this version, the client does not talk to the destination
  * libvirtd. The source libvirtd will still try to talk to the
  * destination libvirtd though, and will do the prepare/perform/finish
  * steps.
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
                           unsigned long flags,
                           const char *dname,
                           const char *uri,
                           unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
        virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3525
        virDispatchError(domain->conn);
3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541
        return -1;
    }

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
}


C
Chris Lalancette 已提交
3542
/*
3543
 * This is a variation on v1 & 2  migration
C
Chris Lalancette 已提交
3544
 *
3545 3546 3547 3548 3549 3550
 * This is for hypervisors which can directly handshake
 * without any libvirtd involvement on destination either
 * from client, or source libvirt.
 *
 * eg, XenD can talk direct to XenD, so libvirtd on dest
 * does not need to be involved at all, or even running
C
Chris Lalancette 已提交
3551
 */
3552 3553 3554 3555 3556 3557 3558 3559 3560
static int
virDomainMigrateDirect (virDomainPtr domain,
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
        virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3561
        virDispatchError(domain->conn);
3562 3563 3564
        return -1;
    }

C
Chris Lalancette 已提交
3565 3566 3567
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
3568 3569 3570 3571 3572 3573 3574
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
C
Chris Lalancette 已提交
3575 3576
}

3577

3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590
/**
 * virDomainMigrate:
 * @domain: a domain object
 * @dconn: destination host (a connection object)
 * @flags: flags
 * @dname: (optional) rename domain to this at destination
 * @uri: (optional) dest hostname/URI as seen from the source host
 * @bandwidth: (optional) specify migration bandwidth limit in Mbps
 *
 * Migrate the domain object from its current host to the destination
 * host given by dconn (a connection to the destination host).
 *
 * Flags may be one of more of the following:
3591 3592 3593
 *   VIR_MIGRATE_LIVE      Do not pause the VM during migration
 *   VIR_MIGRATE_PEER2PEER Direct connection between source & destination hosts
 *   VIR_MIGRATE_TUNNELLED Tunnel migration data over the libvirt RPC channel
C
Chris Lalancette 已提交
3594 3595 3596 3597
 *   VIR_MIGRATE_PERSIST_DEST If the migration is successful, persist the domain
 *                            on the destination host.
 *   VIR_MIGRATE_UNDEFINE_SOURCE If the migration is successful, undefine the
 *                               domain on the source host.
3598
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
3599 3600 3601 3602 3603
 *
 * VIR_MIGRATE_TUNNELLED requires that VIR_MIGRATE_PEER2PEER be set.
 * Applications using the VIR_MIGRATE_PEER2PEER flag will probably
 * prefer to invoke virDomainMigrateToURI, avoiding the need to
 * open connection to the destination host themselves.
3604 3605 3606 3607 3608 3609
 *
 * If a hypervisor supports renaming domains during migration,
 * then you may set the dname parameter to the new name (otherwise
 * it keeps the same name).  If this is not supported by the
 * hypervisor, dname must be NULL or else you will get an error.
 *
3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620
 * If the VIR_MIGRATE_PEER2PEER flag is set, the uri parameter
 * must be a valid libvirt connection URI, by which the source
 * libvirt driver can connect to the destination libvirt. If
 * omitted, the dconn connection object will be queried for its
 * current URI.
 *
 * If the VIR_MIGRATE_PEER2PEER flag is NOT set, the URI parameter
 * takes a hypervisor specific format. The hypervisor capabilities
 * XML includes details of the support URI schemes. If omitted
 * the dconn will be asked for a default URI.
 *
3621
 * In either case it is typically only necessary to specify a
3622 3623
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652
 *
 * The maximum bandwidth (in Mbps) that will be used to do migration
 * can be specified with the bandwidth parameter.  If set to 0,
 * libvirt will choose a suitable default.  Some hypervisors do
 * not support this feature and will return an error if bandwidth
 * is not 0.
 *
 * To see which features are supported by the current hypervisor,
 * see virConnectGetCapabilities, /capabilities/host/migration_features.
 *
 * There are many limitations on migration imposed by the underlying
 * technology - for example it may not be possible to migrate between
 * different processors even with the same architecture, or between
 * different types of hypervisor.
 *
 * Returns the new domain object if the migration was successful,
 *   or NULL in case of error.  Note that the new domain object
 *   exists in the scope of the destination connection (dconn).
 */
virDomainPtr
virDomainMigrate (virDomainPtr domain,
                  virConnectPtr dconn,
                  unsigned long flags,
                  const char *dname,
                  const char *uri,
                  unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
3653
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
3654

3655 3656
    virResetLastError();

3657
    /* First checkout the source */
3658
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3659
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3660
        virDispatchError(NULL);
3661 3662
        return NULL;
    }
3663 3664
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3665
        goto error;
3666 3667
    }

3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
        virLibConnError(domain->conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

3679 3680 3681 3682 3683 3684
    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
            char *dstURI = NULL;
            if (uri == NULL) {
                dstURI = virConnectGetURI(dconn);
3685
                if (!dstURI)
3686 3687
                    return NULL;
            }
3688

3689 3690 3691 3692 3693
            if (virDomainMigratePeer2Peer(domain, flags, dname, uri ? uri : dstURI, bandwidth) < 0) {
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
3694

3695 3696 3697 3698 3699 3700
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
            virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
3701
    } else {
3702 3703 3704 3705 3706 3707
        if (flags & VIR_MIGRATE_TUNNELLED) {
            virLibConnError(domain->conn, VIR_ERR_OPERATION_INVALID,
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719
        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                     VIR_DRV_FEATURE_MIGRATION_V1) &&
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
                                     VIR_DRV_FEATURE_MIGRATION_V1))
            ddomain = virDomainMigrateVersion1(domain, dconn, flags, dname, uri, bandwidth);
        else if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                          VIR_DRV_FEATURE_MIGRATION_V2) &&
                 VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
                                          VIR_DRV_FEATURE_MIGRATION_V2))
            ddomain = virDomainMigrateVersion2(domain, dconn, flags, dname, uri, bandwidth);
        else {
3720
            /* This driver does not support any migration method */
C
Chris Lalancette 已提交
3721 3722 3723
            virLibConnError(domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
3724 3725
    }

3726 3727
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
3728

3729
    return ddomain;
3730 3731

error:
3732
    virDispatchError(domain->conn);
3733
    return NULL;
3734 3735
}

3736 3737 3738 3739 3740 3741 3742 3743 3744 3745

/**
 * virDomainMigrateToURI:
 * @domain: a domain object
 * @duri: mandatory URI for the destination host
 * @flags: flags
 * @dname: (optional) rename domain to this at destination
 * @bandwidth: (optional) specify migration bandwidth limit in Mbps
 *
 * Migrate the domain object from its current host to the destination
D
Dan Kenigsberg 已提交
3746
 * host given by duri.
3747 3748 3749 3750 3751
 *
 * Flags may be one of more of the following:
 *   VIR_MIGRATE_LIVE      Do not pause the VM during migration
 *   VIR_MIGRATE_PEER2PEER Direct connection between source & destination hosts
 *   VIR_MIGRATE_TUNNELLED Tunnel migration data over the libvirt RPC channel
3752 3753 3754 3755
 *   VIR_MIGRATE_PERSIST_DEST If the migration is successful, persist the domain
 *                            on the destination host.
 *   VIR_MIGRATE_UNDEFINE_SOURCE If the migration is successful, undefine the
 *                               domain on the source host.
3756
 *
3757 3758 3759 3760 3761 3762 3763 3764 3765 3766
 * The operation of this API hinges on the VIR_MIGRATE_PEER2PEER flag.
 * If the VIR_MIGRATE_PEER2PEER flag is NOT set, the duri parameter
 * takes a hypervisor specific format. The uri_transports element of the
 * hypervisor capabilities XML includes details of the supported URI
 * schemes. Not all hypervisors will support this mode of migration, so
 * if the VIR_MIGRATE_PEER2PEER flag is not set, then it may be necessary
 * to use the alternative virDomainMigrate API providing and explicit
 * virConnectPtr for the destination host.
 *
 * If the VIR_MIGRATE_PEER2PEER flag IS set, the duri parameter
3767
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
3768
 * libvirt driver can connect to the destination libvirt.
3769
 *
3770 3771 3772 3773 3774 3775 3776
 * VIR_MIGRATE_TUNNELLED requires that VIR_MIGRATE_PEER2PEER be set.
 *
 * If a hypervisor supports renaming domains during migration,
 * the dname parameter specifies the new name for the domain.
 * Setting dname to NULL keeps the domain name the same.  If domain
 * renaming is not supported by the hypervisor, dname must be NULL or
 * else an error will be returned.
3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808
 *
 * The maximum bandwidth (in Mbps) that will be used to do migration
 * can be specified with the bandwidth parameter.  If set to 0,
 * libvirt will choose a suitable default.  Some hypervisors do
 * not support this feature and will return an error if bandwidth
 * is not 0.
 *
 * To see which features are supported by the current hypervisor,
 * see virConnectGetCapabilities, /capabilities/host/migration_features.
 *
 * There are many limitations on migration imposed by the underlying
 * technology - for example it may not be possible to migrate between
 * different processors even with the same architecture, or between
 * different types of hypervisor.
 *
 * Returns 0 if the migration succeeded, -1 upon error.
 */
int
virDomainMigrateToURI (virDomainPtr domain,
                       const char *duri,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    DEBUG("domain=%p, duri=%p, flags=%lu, dname=%s, bandwidth=%lu",
          domain, NULLSTR(duri), flags, NULLSTR(dname), bandwidth);

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3809
        virDispatchError(NULL);
3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (duri == NULL) {
        virLibConnError (domain->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
            if (virDomainMigratePeer2Peer (domain, flags, dname, duri, bandwidth) < 0)
                goto error;
        } else {
            /* No peer to peer migration supported */
            virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
    } else {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_DIRECT)) {
            if (virDomainMigrateDirect (domain, flags, dname, duri, bandwidth) < 0)
                goto error;
        } else {
            /* Cannot do a migration with only the perform step */
            virLibConnError (domain->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
    }

    return 0;

error:
3847
    virDispatchError(domain->conn);
3848 3849 3850 3851
    return -1;
}


D
Daniel Veillard 已提交
3852 3853
/*
 * Not for public use.  This function is part of the internal
3854 3855 3856
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3857
virDomainMigratePrepare (virConnectPtr dconn,
3858 3859 3860 3861 3862 3863 3864
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
3865
{
J
John Levon 已提交
3866 3867 3868
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, "
              "flags=%lu, dname=%s, bandwidth=%lu", dconn, cookie, cookielen,
              NULLSTR(uri_in), uri_out, flags, NULLSTR(dname), bandwidth);
3869

3870 3871
    virResetLastError();

3872
    if (!VIR_IS_CONNECT (dconn)) {
3873
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3874
        virDispatchError(NULL);
3875 3876 3877
        return -1;
    }

3878 3879
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3880
        goto error;
3881 3882
    }

3883 3884 3885 3886 3887 3888 3889 3890 3891
    if (dconn->driver->domainMigratePrepare) {
        int ret;
        ret = dconn->driver->domainMigratePrepare (dconn, cookie, cookielen,
                                                   uri_in, uri_out,
                                                   flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3892 3893

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3894 3895

error:
3896
    virDispatchError(dconn);
3897 3898 3899
    return -1;
}

D
Daniel Veillard 已提交
3900 3901
/*
 * Not for public use.  This function is part of the internal
3902 3903 3904
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3905
virDomainMigratePerform (virDomainPtr domain,
3906 3907 3908 3909 3910 3911 3912 3913
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
J
John Levon 已提交
3914 3915 3916
    VIR_DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, "
              "dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags,
              NULLSTR(dname), bandwidth);
3917

3918 3919 3920
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3921
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3922
        virDispatchError(NULL);
3923 3924 3925 3926
        return -1;
    }
    conn = domain->conn;

3927 3928
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3929
        goto error;
3930 3931
    }

3932 3933 3934 3935 3936 3937 3938 3939 3940
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3941 3942

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3943 3944

error:
3945
    virDispatchError(domain->conn);
3946 3947 3948
    return -1;
}

D
Daniel Veillard 已提交
3949 3950
/*
 * Not for public use.  This function is part of the internal
3951 3952 3953
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3954
virDomainMigrateFinish (virConnectPtr dconn,
3955 3956 3957 3958 3959 3960
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3961 3962 3963
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3964

3965 3966
    virResetLastError();

3967
    if (!VIR_IS_CONNECT (dconn)) {
3968
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3969
        virDispatchError(NULL);
3970 3971 3972
        return NULL;
    }

3973 3974
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3975
        goto error;
3976 3977
    }

3978 3979 3980 3981 3982 3983 3984 3985 3986
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3987 3988

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3989 3990

error:
3991
    virDispatchError(dconn);
3992
    return NULL;
D
Daniel Veillard 已提交
3993 3994 3995
}


D
Daniel Veillard 已提交
3996 3997
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3998 3999 4000
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
4001 4002 4003 4004 4005 4006 4007 4008 4009
virDomainMigratePrepare2 (virConnectPtr dconn,
                          char **cookie,
                          int *cookielen,
                          const char *uri_in,
                          char **uri_out,
                          unsigned long flags,
                          const char *dname,
                          unsigned long bandwidth,
                          const char *dom_xml)
D
Daniel Veillard 已提交
4010
{
J
John Levon 已提交
4011 4012 4013 4014
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p,"
              "flags=%lu, dname=%s, bandwidth=%lu, dom_xml=%s", dconn,
              cookie, cookielen, uri_in, uri_out, flags, NULLSTR(dname),
              bandwidth, dom_xml);
D
Daniel Veillard 已提交
4015

4016 4017
    virResetLastError();

D
Daniel Veillard 已提交
4018 4019
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4020
        virDispatchError(NULL);
D
Daniel Veillard 已提交
4021 4022 4023
        return -1;
    }

4024 4025
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4026
        goto error;
4027 4028
    }

4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
    if (dconn->driver->domainMigratePrepare2) {
        int ret;
        ret = dconn->driver->domainMigratePrepare2 (dconn, cookie, cookielen,
                                                    uri_in, uri_out,
                                                    flags, dname, bandwidth,
                                                    dom_xml);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel Veillard 已提交
4039 4040

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4041 4042

error:
4043
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4044 4045 4046
    return -1;
}

D
Daniel Veillard 已提交
4047 4048
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
4049 4050 4051
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
4052 4053 4054 4055 4056 4057 4058
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
4059
{
J
John Levon 已提交
4060 4061 4062
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu, retcode=%d", dconn, NULLSTR(dname), cookie,
              cookielen, uri, flags, retcode);
D
Daniel Veillard 已提交
4063

4064 4065
    virResetLastError();

D
Daniel Veillard 已提交
4066 4067
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4068
        virDispatchError(NULL);
D
Daniel Veillard 已提交
4069 4070 4071
        return NULL;
    }

4072 4073
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4074
        goto error;
4075 4076
    }

4077 4078 4079 4080 4081 4082 4083 4084 4085 4086
    if (dconn->driver->domainMigrateFinish2) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish2 (dconn, dname,
                                                   cookie, cookielen,
                                                   uri, flags,
                                                   retcode);
        if (!ret)
            goto error;
        return ret;
    }
D
Daniel Veillard 已提交
4087 4088

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4089 4090

error:
4091
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4092
    return NULL;
4093 4094 4095
}


C
Chris Lalancette 已提交
4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
virDomainMigratePrepareTunnel(virConnectPtr conn,
                              virStreamPtr st,
                              unsigned long flags,
                              const char *dname,
                              unsigned long bandwidth,
                              const char *dom_xml)

{
4109 4110
    VIR_DEBUG("conn=%p, stream=%p, flags=%lu, dname=%s, "
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
4111 4112 4113 4114 4115 4116
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4117
        virDispatchError(NULL);
C
Chris Lalancette 已提交
4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn != st->conn) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
4132
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
4133 4134 4135 4136 4137 4138 4139 4140 4141 4142
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
4143
    virDispatchError(conn);
C
Chris Lalancette 已提交
4144 4145 4146 4147
    return -1;
}


4148 4149 4150 4151
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
4152
 *
4153 4154 4155 4156 4157
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
4158 4159
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
4160 4161
    DEBUG("conn=%p, info=%p", conn, info);

4162 4163
    virResetLastError();

4164
    if (!VIR_IS_CONNECT(conn)) {
4165
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4166
        virDispatchError(NULL);
4167 4168 4169 4170
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4171
        goto error;
4172 4173
    }

4174 4175 4176 4177 4178 4179 4180
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
4181

4182
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4183 4184

error:
4185
    virDispatchError(conn);
4186
    return -1;
4187
}
4188

4189 4190 4191 4192 4193 4194
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
4195 4196
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
4197 4198 4199 4200 4201
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
4202 4203
    DEBUG("conn=%p", conn);

4204 4205
    virResetLastError();

4206
    if (!VIR_IS_CONNECT (conn)) {
4207
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4208
        virDispatchError(NULL);
4209 4210 4211
        return NULL;
    }

4212 4213 4214 4215 4216
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
4217
        DEBUG("conn=%p ret=%s", conn, ret);
4218 4219
        return ret;
    }
4220

4221
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4222 4223

error:
4224
    virDispatchError(conn);
4225 4226 4227
    return NULL;
}

4228 4229 4230
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
4231
 *
D
Daniel Veillard 已提交
4232
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
4233 4234
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
4235
 *
D
Daniel Veillard 已提交
4236
 * Returns the available free memory in bytes or 0 in case of error
4237 4238 4239 4240
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
4241 4242
    DEBUG("conn=%p", conn);

4243 4244
    virResetLastError();

4245 4246
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4247
        virDispatchError(NULL);
4248 4249 4250
        return 0;
    }

4251 4252 4253 4254 4255 4256 4257
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
4258 4259

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4260 4261

error:
4262
    virDispatchError(conn);
4263 4264 4265
    return 0;
}

4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279
/**
 * virDomainGetSchedulerType:
 * @domain: pointer to domain object
 * @nparams: number of scheduler parameters(return value)
 *
 * Get the scheduler type.
 *
 * Returns NULL in case of error. The caller must free the returned string.
 */
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
{
    virConnectPtr conn;
    char *schedtype;
4280
    DEBUG("domain=%p, nparams=%p", domain, nparams);
4281

4282 4283
    virResetLastError();

4284
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4285
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4286
        virDispatchError(NULL);
4287 4288 4289 4290 4291 4292
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
4293 4294
        if (!schedtype)
            goto error;
4295 4296 4297
        return schedtype;
    }

4298
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4299 4300

error:
4301
    virDispatchError(domain->conn);
4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321
    return NULL;
}


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter object
 *          (return value)
 * @nparams: pointer to number of scheduler parameter
 *          (this value should be same than the returned value
 *           nparams of virDomainGetSchedulerType)
 *
 * Get the scheduler parameters, the @params array will be filled with the
 * values.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
4322
                                virSchedParameterPtr params, int *nparams)
4323 4324
{
    virConnectPtr conn;
4325
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
4326

4327 4328
    virResetLastError();

4329
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4330
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4331
        virDispatchError(NULL);
4332 4333 4334 4335
        return -1;
    }
    conn = domain->conn;

4336 4337 4338 4339 4340 4341 4342
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4343

4344
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4345 4346

error:
4347
    virDispatchError(domain->conn);
4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
    return -1;
}

/**
 * virDomainSetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
 * @nparams: number of scheduler parameter
 *          (this value should be same or less than the returned value
 *           nparams of virDomainGetSchedulerType)
 *
 * Change the scheduler parameters
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
4364
virDomainSetSchedulerParameters(virDomainPtr domain,
4365
                                virSchedParameterPtr params, int nparams)
4366 4367
{
    virConnectPtr conn;
4368
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
4369

4370 4371
    virResetLastError();

4372
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4373
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4374
        virDispatchError(NULL);
4375 4376
        return -1;
    }
4377 4378
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4379
        goto error;
4380
    }
4381 4382
    conn = domain->conn;

4383 4384 4385 4386 4387 4388 4389
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4390

4391
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4392 4393

error:
4394
    virDispatchError(domain->conn);
4395 4396 4397 4398
    return -1;
}


4399
/**
4400
 * virDomainBlockStats:
4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429
 * @dom: pointer to the domain object
 * @path: path to the block device
 * @stats: block device stats (returned)
 * @size: size of stats structure
 *
 * This function returns block device (disk) stats for block
 * devices attached to the domain.
 *
 * The path parameter is the name of the block device.  Get this
 * by calling virDomainGetXMLDesc and finding the <target dev='...'>
 * attribute within //domain/devices/disk.  (For example, "xvda").
 *
 * Domains may have more than one block device.  To get stats for
 * each you should make multiple calls to this function.
 *
 * Individual fields within the stats structure may be returned
 * as -1, which indicates that the hypervisor does not support
 * that particular statistic.
 *
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainBlockStats (virDomainPtr dom, const char *path,
                     virDomainBlockStatsPtr stats, size_t size)
{
    virConnectPtr conn;
    struct _virDomainBlockStats stats2 = { -1, -1, -1, -1, -1 };
    DEBUG("domain=%p, path=%s, stats=%p, size=%zi", dom, path, stats, size);

4430 4431
    virResetLastError();

4432
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4433
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4434
        virDispatchError(NULL);
4435 4436
        return -1;
    }
4437
    if (!path || !stats || size > sizeof stats2) {
4438 4439 4440
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
4441 4442 4443 4444
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
4445
            goto error;
4446 4447 4448 4449 4450 4451

        memcpy (stats, &stats2, size);
        return 0;
    }

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4452 4453

error:
4454
    virDispatchError(dom->conn);
4455 4456 4457 4458
    return -1;
}

/**
4459
 * virDomainInterfaceStats:
4460 4461 4462 4463 4464 4465 4466 4467 4468 4469
 * @dom: pointer to the domain object
 * @path: path to the interface
 * @stats: network interface stats (returned)
 * @size: size of stats structure
 *
 * This function returns network interface stats for interfaces
 * attached to the domain.
 *
 * The path parameter is the name of the network interface.
 *
D
Dan Kenigsberg 已提交
4470
 * Domains may have more than one network interface.  To get stats for
4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487
 * each you should make multiple calls to this function.
 *
 * Individual fields within the stats structure may be returned
 * as -1, which indicates that the hypervisor does not support
 * that particular statistic.
 *
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainInterfaceStats (virDomainPtr dom, const char *path,
                         virDomainInterfaceStatsPtr stats, size_t size)
{
    virConnectPtr conn;
    struct _virDomainInterfaceStats stats2 = { -1, -1, -1, -1,
                                               -1, -1, -1, -1 };
    DEBUG("domain=%p, path=%s, stats=%p, size=%zi", dom, path, stats, size);

4488 4489
    virResetLastError();

4490
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4491
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4492
        virDispatchError(NULL);
4493 4494
        return -1;
    }
4495
    if (!path || !stats || size > sizeof stats2) {
4496 4497 4498
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
4499 4500 4501 4502
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
4503
            goto error;
4504 4505 4506 4507 4508 4509

        memcpy (stats, &stats2, size);
        return 0;
    }

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4510 4511

error:
4512
    virDispatchError(dom->conn);
4513 4514 4515
    return -1;
}

4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
/**
 * virDomainMemoryStats:
 * @dom: pointer to the domain object
 * @stats: nr_stats-sized array of stat structures (returned)
 * @nr_stats: number of memory statistics requested
 * @flags: unused, always pass 0
 *
 * This function provides memory statistics for the domain.
 *
 * Up to 'nr_stats' elements of 'stats' will be populated with memory statistics
 * from the domain.  Only statistics supported by the domain, the driver, and
 * this version of libvirt will be returned.
 *
 * Memory Statistics:
 *
 * VIR_DOMAIN_MEMORY_STAT_SWAP_IN:
 *     The total amount of data read from swap space (in kb).
 * VIR_DOMAIN_MEMORY_STAT_SWAP_OUT:
 *     The total amount of memory written out to swap space (in kb).
 * VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT:
 *     The number of page faults that required disk IO to service.
 * VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT:
 *     The number of page faults serviced without disk IO.
 * VIR_DOMAIN_MEMORY_STAT_UNUSED:
 *     The amount of memory which is not being used for any purpose (in kb).
 * VIR_DOMAIN_MEMORY_STAT_AVAILABLE:
 *     The total amount of memory available to the domain's OS (in kb).
 *
 * Returns: The number of stats provided or -1 in case of failure.
 */
int virDomainMemoryStats (virDomainPtr dom, virDomainMemoryStatPtr stats,
                          unsigned int nr_stats, unsigned int flags)
{
    virConnectPtr conn;
    unsigned long nr_stats_ret = 0;
    DEBUG("domain=%p, stats=%p, nr_stats=%u", dom, stats, nr_stats);

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
        goto error;
    }

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4563
        virDispatchError(NULL);
4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582
        return -1;
    }
    if (!stats || nr_stats == 0)
        return 0;

    if (nr_stats > VIR_DOMAIN_MEMORY_STAT_NR)
        nr_stats = VIR_DOMAIN_MEMORY_STAT_NR;

    conn = dom->conn;
    if (conn->driver->domainMemoryStats) {
        nr_stats_ret = conn->driver->domainMemoryStats (dom, stats, nr_stats);
        if (nr_stats_ret == -1)
            goto error;
        return nr_stats_ret;
    }

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
4583
    virDispatchError(dom->conn);
4584 4585 4586
    return -1;
}

R
Richard W.M. Jones 已提交
4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619
/**
 * virDomainBlockPeek:
 * @dom: pointer to the domain object
 * @path: path to the block device
 * @offset: offset within block device
 * @size: size to read
 * @buffer: return buffer (must be at least size bytes)
 * @flags: unused, always pass 0
 *
 * This function allows you to read the contents of a domain's
 * disk device.
 *
 * Typical uses for this are to determine if the domain has
 * written a Master Boot Record (indicating that the domain
 * has completed installation), or to try to work out the state
 * of the domain's filesystems.
 *
 * (Note that in the local case you might try to open the
 * block device or file directly, but that won't work in the
 * remote case, nor if you don't have sufficient permission.
 * Hence the need for this call).
 *
 * 'path' must be a device or file corresponding to the domain.
 * In other words it must be the precise string returned in
 * a <disk><source dev='...'/></disk> from
 * virDomainGetXMLDesc.
 *
 * 'offset' and 'size' represent an area which must lie entirely
 * within the device or file.  'size' may be 0 to test if the
 * call would succeed.
 *
 * 'buffer' is the return buffer and must be at least 'size' bytes.
 *
R
Richard W.M. Jones 已提交
4620 4621 4622 4623
 * NB. The remote driver imposes a 64K byte limit on 'size'.
 * For your program to be able to work reliably over a remote
 * connection you should split large requests to <= 65536 bytes.
 *
R
Richard W.M. Jones 已提交
4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainBlockPeek (virDomainPtr dom,
                    const char *path,
                    unsigned long long offset /* really 64 bits */,
                    size_t size,
                    void *buffer,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, path=%s, offset=%lld, size=%zi, buffer=%p",
          dom, path, offset, size, buffer);

4638 4639
    virResetLastError();

R
Richard W.M. Jones 已提交
4640 4641
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4642
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4643 4644 4645
        return -1;
    }
    conn = dom->conn;
4646

4647 4648
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4649
        goto error;
4650 4651
    }

R
Richard W.M. Jones 已提交
4652 4653 4654
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
4655
        goto error;
R
Richard W.M. Jones 已提交
4656 4657 4658 4659 4660
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
4661
        goto error;
R
Richard W.M. Jones 已提交
4662 4663 4664 4665 4666 4667
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("buffer is NULL"));
4668
        goto error;
R
Richard W.M. Jones 已提交
4669 4670
    }

4671 4672 4673 4674 4675 4676 4677 4678
    if (conn->driver->domainBlockPeek) {
        int ret;
        ret =conn->driver->domainBlockPeek (dom, path, offset, size,
                                            buffer, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
R
Richard W.M. Jones 已提交
4679 4680

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4681 4682

error:
4683
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4684 4685
    return -1;
}
4686

R
Richard W.M. Jones 已提交
4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728
/**
 * virDomainMemoryPeek:
 * @dom: pointer to the domain object
 * @start: start of memory to peek
 * @size: size of memory to peek
 * @buffer: return buffer (must be at least size bytes)
 * @flags: flags, see below
 *
 * This function allows you to read the contents of a domain's
 * memory.
 *
 * The memory which is read is controlled by the 'start', 'size'
 * and 'flags' parameters.
 *
 * If 'flags' is VIR_MEMORY_VIRTUAL then the 'start' and 'size'
 * parameters are interpreted as virtual memory addresses for
 * whichever task happens to be running on the domain at the
 * moment.  Although this sounds haphazard it is in fact what
 * you want in order to read Linux kernel state, because it
 * ensures that pointers in the kernel image can be interpreted
 * coherently.
 *
 * 'buffer' is the return buffer and must be at least 'size' bytes.
 * 'size' may be 0 to test if the call would succeed.
 *
 * NB. The remote driver imposes a 64K byte limit on 'size'.
 * For your program to be able to work reliably over a remote
 * connection you should split large requests to <= 65536 bytes.
 *
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainMemoryPeek (virDomainPtr dom,
                     unsigned long long start /* really 64 bits */,
                     size_t size,
                     void *buffer,
                     unsigned int flags)
{
    virConnectPtr conn;
    DEBUG ("domain=%p, start=%lld, size=%zi, buffer=%p, flags=%d",
           dom, start, size, buffer, flags);

4729 4730
    virResetLastError();

R
Richard W.M. Jones 已提交
4731 4732
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4733
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4734 4735 4736 4737
        return -1;
    }
    conn = dom->conn;

4738 4739
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4740
        goto error;
4741 4742
    }

4743
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
4744 4745 4746 4747 4748 4749
     * a possibility.  However it isn't really useful unless the caller
     * can also access registers, particularly CR3 on x86 in order to
     * get the Page Table Directory.  Since registers are different on
     * every architecture, that would imply another call to get the
     * machine registers.
     *
4750
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
4751 4752 4753
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
4754 4755 4756
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
4757 4758 4759 4760 4761 4762 4763 4764
     * At time of writing there is no Xen driver.  However the Xen
     * hypervisor only lets you map physical pages from other domains,
     * and so the Xen driver would have to do the virtual to physical
     * mapping by chasing 2, 3 or 4-level page tables from the PTD.
     * There is example code in libxc (xc_translate_foreign_address)
     * which does this, although we cannot copy this code directly
     * because of incompatible licensing.
     */
4765 4766

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
R
Richard W.M. Jones 已提交
4767
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
4768
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
4769
        goto error;
R
Richard W.M. Jones 已提交
4770 4771 4772 4773 4774 4775
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("buffer is NULL but size is non-zero"));
4776
        goto error;
R
Richard W.M. Jones 已提交
4777 4778
    }

4779 4780 4781 4782 4783 4784 4785 4786
    if (conn->driver->domainMemoryPeek) {
        int ret;
        ret = conn->driver->domainMemoryPeek (dom, start, size,
                                              buffer, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
R
Richard W.M. Jones 已提交
4787 4788

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4789 4790

error:
4791
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4792 4793 4794
    return -1;
}

4795

4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844
/**
 * virDomainGetBlockInfo:
 * @domain: a domain object
 * @path: path to the block device or file
 * @info: pointer to a virDomainBlockInfo structure allocated by the user
 * @flags: currently unused, pass zero
 *
 * Extract information about a domain's block device.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainGetBlockInfo(virDomainPtr domain, const char *path, virDomainBlockInfoPtr info, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, info=%p flags=%u", domain, info, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    memset(info, 0, sizeof(virDomainBlockInfo));

    conn = domain->conn;

    if (conn->driver->domainGetBlockInfo) {
        int ret;
        ret = conn->driver->domainGetBlockInfo (domain, path, info, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}


4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855
/************************************************************************
 *									*
 *		Handling of defined but not running domains		*
 *									*
 ************************************************************************/

/**
 * virDomainDefineXML:
 * @conn: pointer to the hypervisor connection
 * @xml: the XML description for the domain, preferably in UTF-8
 *
4856 4857
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
4858 4859
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
4860 4861 4862 4863 4864
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
4865 4866
    DEBUG("conn=%p, xml=%s", conn, xml);

4867 4868
    virResetLastError();

4869
    if (!VIR_IS_CONNECT(conn)) {
4870
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4871
        virDispatchError(NULL);
4872 4873
        return (NULL);
    }
4874 4875
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4876
        goto error;
4877
    }
4878 4879
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4880
        goto error;
4881 4882
    }

4883 4884 4885 4886 4887 4888 4889
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4890

4891
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4892 4893

error:
4894
    virDispatchError(conn);
4895
    return NULL;
4896 4897 4898 4899 4900 4901
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
4902
 * Undefine a domain but does not stop it if it is running
4903 4904 4905 4906 4907
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
4908
    virConnectPtr conn;
4909
    DEBUG("domain=%p", domain);
4910

4911 4912
    virResetLastError();

4913
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4914
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4915
        virDispatchError(NULL);
4916 4917
        return (-1);
    }
4918 4919
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4920
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4921
        goto error;
4922 4923
    }

4924 4925 4926 4927 4928 4929 4930
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4931

4932
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4933 4934

error:
4935
    virDispatchError(domain->conn);
4936
    return -1;
4937 4938 4939 4940 4941 4942
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
4943
 * Provides the number of defined but inactive domains.
4944 4945 4946 4947 4948 4949
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
4950 4951
    DEBUG("conn=%p", conn);

4952 4953
    virResetLastError();

4954
    if (!VIR_IS_CONNECT(conn)) {
4955
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4956
        virDispatchError(NULL);
4957 4958 4959
        return (-1);
    }

4960 4961 4962 4963 4964 4965 4966
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4967

4968
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4969 4970

error:
4971
    virDispatchError(conn);
4972
    return -1;
4973 4974 4975 4976 4977 4978 4979 4980
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4981 4982
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
4983
 *
4984 4985 4986
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4987
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
4988
                             int maxnames) {
4989 4990
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4991 4992
    virResetLastError();

4993
    if (!VIR_IS_CONNECT(conn)) {
4994
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4995
        virDispatchError(NULL);
4996 4997 4998
        return (-1);
    }

4999
    if ((names == NULL) || (maxnames < 0)) {
5000
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5001
        goto error;
5002 5003
    }

5004 5005 5006 5007 5008 5009 5010
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5011

5012
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5013 5014

error:
5015
    virDispatchError(conn);
5016
    return -1;
5017 5018 5019 5020 5021 5022
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
5023
 * Launch a defined domain. If the call succeeds the domain moves from the
5024 5025 5026 5027 5028 5029
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
5030
    virConnectPtr conn;
5031
    DEBUG("domain=%p", domain);
5032

5033 5034
    virResetLastError();

5035
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5036
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5037
        virDispatchError(NULL);
5038 5039
        return (-1);
    }
5040 5041
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5042
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5043
        goto error;
5044
    }
5045

5046 5047 5048 5049 5050 5051 5052
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5053

5054
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5055 5056

error:
5057
    virDispatchError(domain->conn);
5058
    return -1;
5059 5060
}

5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103
/**
 * virDomainCreateWithFlags:
 * @domain: pointer to a defined domain
 * @flags: bitwise-or of supported virDomainCreateFlags
 *
 * Launch a defined domain. If the call succeeds the domain moves from the
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) {
    virConnectPtr conn;
    DEBUG("domain=%p, flags=%d", domain, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainCreateWithFlags) {
        int ret;
        ret = conn->driver->domainCreateWithFlags (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

5104 5105 5106
/**
 * virDomainGetAutostart:
 * @domain: a domain object
5107
 * @autostart: the value returned
5108
 *
5109
 * Provides a boolean value indicating whether the domain
5110 5111 5112 5113 5114 5115 5116
 * configured to be automatically started when the host
 * machine boots.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetAutostart(virDomainPtr domain,
5117 5118 5119
                      int *autostart)
{
    virConnectPtr conn;
5120
    DEBUG("domain=%p, autostart=%p", domain, autostart);
5121

5122 5123 5124
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5125
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5126
        virDispatchError(NULL);
5127 5128 5129 5130
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5131
        goto error;
5132 5133
    }

5134 5135
    conn = domain->conn;

5136 5137 5138 5139 5140 5141 5142
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5143

5144
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5145 5146

error:
5147
    virDispatchError(domain->conn);
5148
    return -1;
5149 5150 5151 5152 5153
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
5154
 * @autostart: whether the domain should be automatically started 0 or 1
5155 5156 5157 5158 5159 5160 5161 5162
 *
 * Configure the domain to be automatically started
 * when the host machine boots.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainSetAutostart(virDomainPtr domain,
5163 5164 5165
                      int autostart)
{
    virConnectPtr conn;
5166
    DEBUG("domain=%p, autostart=%d", domain, autostart);
5167

5168 5169 5170
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5171
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5172
        virDispatchError(NULL);
5173 5174 5175
        return (-1);
    }

5176 5177
    conn = domain->conn;

5178 5179
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5180
        goto error;
5181 5182
    }

5183 5184 5185 5186 5187 5188 5189
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5190

5191
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5192 5193

error:
5194
    virDispatchError(domain->conn);
5195
    return -1;
5196 5197
}

5198 5199 5200 5201 5202 5203 5204 5205
/**
 * virDomainSetVcpus:
 * @domain: pointer to domain object, or NULL for Domain0
 * @nvcpus: the new number of virtual CPUs for this domain
 *
 * Dynamically change the number of virtual CPUs used by the domain.
 * Note that this call may fail if the underlying virtualization hypervisor
 * does not support it or if growing the number is arbitrary limited.
5206
 * This function requires privileged access to the hypervisor.
5207
 *
5208
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
5209 5210 5211
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
5212
 *
5213 5214 5215 5216 5217 5218
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
5219
    virConnectPtr conn;
5220
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
5221

5222 5223
    virResetLastError();

5224
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5225
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5226
        virDispatchError(NULL);
5227 5228
        return (-1);
    }
5229 5230
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5231
        goto error;
5232
    }
5233

5234 5235
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5236
        goto error;
5237
    }
5238
    conn = domain->conn;
5239

5240 5241 5242 5243 5244 5245 5246
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
5247

5248
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5249 5250

error:
5251
    virDispatchError(domain->conn);
5252
    return -1;
5253 5254
}

E
Eric Blake 已提交
5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380
/**
 * virDomainSetVcpusFlags:
 * @domain: pointer to domain object, or NULL for Domain0
 * @nvcpus: the new number of virtual CPUs for this domain, must be at least 1
 * @flags: an OR'ed set of virDomainVcpuFlags
 *
 * Dynamically change the number of virtual CPUs used by the domain.
 * Note that this call may fail if the underlying virtualization hypervisor
 * does not support it or if growing the number is arbitrary limited.
 * This function requires privileged access to the hypervisor.
 *
 * @flags must include VIR_DOMAIN_VCPU_LIVE to affect a running
 * domain (which may fail if domain is not active), or
 * VIR_DOMAIN_VCPU_CONFIG to affect the next boot via the XML
 * description of the domain.  Both flags may be set.
 *
 * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then
 * VIR_DOMAIN_VCPU_LIVE must be clear, and only the maximum virtual
 * CPU limit is altered; generally, this value must be less than or
 * equal to virConnectGetMaxVcpus().  Otherwise, this call affects the
 * current virtual CPU limit, which must be less than or equal to the
 * maximum limit.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpusFlags(virDomainPtr domain, unsigned int nvcpus,
                       unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, nvcpus=%u, flags=%u", domain, nvcpus, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    /* Perform some argument validation common to all implementations.  */
    if (nvcpus < 1 || (unsigned short) nvcpus != nvcpus ||
        (flags & (VIR_DOMAIN_VCPU_LIVE | VIR_DOMAIN_VCPU_CONFIG)) == 0) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainSetVcpusFlags) {
        int ret;
        ret = conn->driver->domainSetVcpusFlags (domain, nvcpus, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainGetVcpusFlags:
 * @domain: pointer to domain object, or NULL for Domain0
 * @flags: an OR'ed set of virDomainVcpuFlags
 *
 * Query the number of virtual CPUs used by the domain.  Note that
 * this call may fail if the underlying virtualization hypervisor does
 * not support it.  This function requires privileged access to the
 * hypervisor.
 *
 * @flags must include either VIR_DOMAIN_VCPU_ACTIVE to query a
 * running domain (which will fail if domain is not active), or
 * VIR_DOMAIN_VCPU_PERSISTENT to query the XML description of the
 * domain.  It is an error to set both flags.
 *
 * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then the maximum
 * virtual CPU limit is queried.  Otherwise, this call queries the
 * current virtual CPU limit.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainGetVcpusFlags(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, flags=%u", domain, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }

    /* Exactly one of these two flags should be set.  */
    if (!(flags & VIR_DOMAIN_VCPU_LIVE) == !(flags & VIR_DOMAIN_VCPU_CONFIG)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainGetVcpusFlags) {
        int ret;
        ret = conn->driver->domainGetVcpusFlags (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

5381 5382 5383 5384 5385
/**
 * virDomainPinVcpu:
 * @domain: pointer to domain object, or NULL for Domain0
 * @vcpu: virtual CPU number
 * @cpumap: pointer to a bit map of real CPUs (in 8-bit bytes) (IN)
E
Eric Blake 已提交
5386 5387 5388
 *      Each bit set to 1 means that corresponding CPU is usable.
 *      Bytes are stored in little-endian order: CPU0-7, 8-15...
 *      In each byte, lowest CPU number is least significant bit.
5389 5390 5391 5392
 * @maplen: number of bytes in cpumap, from 1 up to size of CPU map in
 *	underlying virtualization system (Xen...).
 *	If maplen < size, missing bytes are set to zero.
 *	If maplen > size, failure code is returned.
5393
 *
5394
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
5395
 * This function requires privileged access to the hypervisor.
5396
 *
5397 5398 5399
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
5400 5401 5402 5403 5404 5405
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
5406
    virConnectPtr conn;
5407
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
5408

5409 5410
    virResetLastError();

5411
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5412
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5413
        virDispatchError(NULL);
5414 5415
        return (-1);
    }
5416 5417
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5418
        goto error;
5419
    }
5420

5421
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
5422
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5423
       goto error;
5424
    }
5425

5426 5427
    conn = domain->conn;

5428 5429 5430 5431 5432 5433 5434
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5435

5436
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5437 5438

error:
5439
    virDispatchError(domain->conn);
5440
    return -1;
5441 5442 5443 5444 5445 5446 5447
}

/**
 * virDomainGetVcpus:
 * @domain: pointer to domain object, or NULL for Domain0
 * @info: pointer to an array of virVcpuInfo structures (OUT)
 * @maxinfo: number of structures in info array
D
Dan Kenigsberg 已提交
5448
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
5449
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
5450
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
5451 5452 5453 5454 5455 5456 5457
 *	It's assumed there is <maxinfo> cpumap in cpumaps array.
 *	The memory allocated to cpumaps must be (maxinfo * maplen) bytes
 *	(ie: calloc(maxinfo, maplen)).
 *	One cpumap inside cpumaps has the format described in
 *      virDomainPinVcpu() API.
 * @maplen: number of bytes in one cpumap, from 1 up to size of CPU map in
 *	underlying virtualization system (Xen...).
5458
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
5459
 *
5460
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
5461
 * and also in cpumaps if this pointer isn't NULL.
5462 5463 5464 5465 5466
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
5467
                  unsigned char *cpumaps, int maplen)
5468
{
5469
    virConnectPtr conn;
5470
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
5471

5472 5473
    virResetLastError();

5474
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5475
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5476
        virDispatchError(NULL);
5477 5478 5479 5480
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5481
        goto error;
5482
    }
5483 5484 5485 5486 5487

    /* Ensure that domainGetVcpus (aka remoteDomainGetVcpus) does not
       try to memcpy anything into a NULL pointer.  */
    if ((cpumaps == NULL && maplen != 0)
        || (cpumaps && maplen <= 0)) {
5488
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5489
        goto error;
5490
    }
5491

5492 5493
    conn = domain->conn;

5494 5495 5496 5497 5498 5499 5500 5501
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5502

5503
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5504 5505

error:
5506
    virDispatchError(domain->conn);
5507
    return -1;
5508
}
5509

5510 5511 5512
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
5513
 *
5514 5515
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
5516
 * the same as virConnectGetMaxVcpus(). If the guest is running
5517
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
5518
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
5519 5520 5521 5522
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
5523 5524
virDomainGetMaxVcpus(virDomainPtr domain)
{
5525
    virConnectPtr conn;
5526
    DEBUG("domain=%p", domain);
5527

5528 5529
    virResetLastError();

5530
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5531
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5532
        virDispatchError(NULL);
5533 5534 5535 5536 5537
        return (-1);
    }

    conn = domain->conn;

5538 5539 5540 5541 5542 5543 5544
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5545

5546
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5547 5548

error:
5549
    virDispatchError(domain->conn);
5550
    return -1;
5551 5552
}

5553 5554 5555 5556 5557
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
5558 5559 5560
 * Extract security label of an active domain. The 'label' field
 * in the @seclabel argument will be initialized to the empty
 * string if the domain is not running under a security model.
5561
 *
5562
 * Returns 0 in case of success, -1 in case of failure
5563 5564 5565 5566 5567 5568 5569 5570
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5571
        virDispatchError(NULL);
5572 5573 5574 5575 5576
        return -1;
    }

    if (seclabel == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
5577
        goto error;
5578 5579 5580 5581
    }

    conn = domain->conn;

5582 5583 5584 5585 5586 5587 5588 5589 5590
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5591

5592
error:
5593
    virDispatchError(domain->conn);
5594
    return -1;
5595 5596 5597 5598 5599 5600 5601
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
5602 5603 5604
 * Extract the security model of a hypervisor. The 'model' field
 * in the @secmodel argument may be initialized to the empty
 * string if the driver has not activated a security model.
5605
 *
5606
 * Returns 0 in case of success, -1 in case of failure
5607 5608 5609 5610 5611
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
    if (!VIR_IS_CONNECT(conn)) {
5612 5613
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
5614 5615 5616 5617 5618
        return -1;
    }

    if (secmodel == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5619 5620 5621 5622 5623 5624 5625 5626 5627
        goto error;
    }

    if (conn->driver->nodeGetSecurityModel) {
        int ret;
        ret = conn->driver->nodeGetSecurityModel(conn, secmodel);
        if (ret < 0)
            goto error;
        return ret;
5628 5629
    }

5630
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5631

5632
error:
5633
    virDispatchError(conn);
5634
    return -1;
5635
}
5636

5637 5638 5639 5640
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5641
 *
5642 5643
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
5644
 *
5645 5646 5647 5648
 * For compatibility, this method can also be used to change the media
 * in an existing CDROM/Floppy device, however, applications are
 * recommended to use the virDomainUpdateDeviceFlag method instead.
 *
5649 5650 5651
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5652
virDomainAttachDevice(virDomainPtr domain, const char *xml)
5653 5654
{
    virConnectPtr conn;
5655
    DEBUG("domain=%p, xml=%s", domain, xml);
5656

5657 5658
    virResetLastError();

5659
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5660
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5661
        virDispatchError(NULL);
5662 5663 5664 5665
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5666
        goto error;
5667 5668 5669
    }
    conn = domain->conn;

5670
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainAttachDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Attach a virtual device to a domain, using the flags parameter
 * to control how the device is attached.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device allocation is made based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * allocated to the active domain instance only and is not added to the
 * persisted domain configuration.  VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be allocated to the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports modifying the
 * persisted device allocation.
 *
5703 5704 5705 5706
 * For compatibility, this method can also be used to change the media
 * in an existing CDROM/Floppy device, however, applications are
 * recommended to use the virDomainUpdateDeviceFlag method instead.
 *
J
Jim Fehlig 已提交
5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, xml=%s, flags=%d", domain, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
5729
        int ret;
J
Jim Fehlig 已提交
5730
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
5731 5732 5733 5734
        if (ret < 0)
            goto error;
        return ret;
    }
5735

J
Jim Fehlig 已提交
5736
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5737 5738

error:
5739
    virDispatchError(domain->conn);
5740
    return -1;
5741 5742 5743 5744 5745 5746
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5747
 *
5748 5749
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
5750 5751 5752 5753
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5754
virDomainDetachDevice(virDomainPtr domain, const char *xml)
5755 5756
{
    virConnectPtr conn;
5757
    DEBUG("domain=%p, xml=%s", domain, xml);
5758

5759 5760
    virResetLastError();

5761
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5762
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5763
        virDispatchError(NULL);
5764 5765 5766 5767
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5768
        goto error;
5769 5770 5771
    }
    conn = domain->conn;

5772 5773 5774
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828
         if (ret < 0)
             goto error;
         return ret;
     }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainDetachDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Detach a virtual device from a domain, using the flags parameter
 * to control how the device is detached.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device allocation is removed based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * deallocated from the active domain instance only and is not from the
 * persisted domain configuration.  VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be deallocated from the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports removing the
 * persisted device allocation.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainDetachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, xml=%s, flags=%d", domain, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}

/**
 * virDomainUpdateDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Change a virtual device on a domain, using the flags parameter
 * to control how the device is changed.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device change is made based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * changed on the active domain instance only and is not added to the
 * persisted domain configuration. VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be changed on the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports modifying the
 * persisted device allocation.
 *
 * This method is used for actions such changing CDROM/Floppy device
 * media, altering the graphics configuration such as password,
 * reconfiguring the NIC device backend connectivity, etc.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainUpdateDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, xml=%s, flags=%d", domain, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
5887 5888 5889 5890
        if (ret < 0)
            goto error;
        return ret;
    }
5891

J
Jim Fehlig 已提交
5892
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5893 5894

error:
5895
    virDispatchError(domain->conn);
5896
    return -1;
5897
}
5898

5899 5900 5901 5902 5903 5904 5905 5906 5907 5908
/**
 * virNodeGetCellsFreeMemory:
 * @conn: pointer to the hypervisor connection
 * @freeMems: pointer to the array of unsigned long long
 * @startCell: index of first cell to return freeMems info on.
 * @maxCells: Maximum number of cells for which freeMems information can
 *            be returned.
 *
 * This call returns the amount of free memory in one or more NUMA cells.
 * The @freeMems array must be allocated by the caller and will be filled
5909
 * with the amount of free memory in bytes for each cell requested,
5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920
 * starting with startCell (in freeMems[0]), up to either
 * (startCell + maxCells), or the number of additional cells in the node,
 * whichever is smaller.
 *
 * Returns the number of entries filled in freeMems, or -1 in case of error.
 */

int
virNodeGetCellsFreeMemory(virConnectPtr conn, unsigned long long *freeMems,
                          int startCell, int maxCells)
{
5921 5922 5923
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

5924 5925
    virResetLastError();

5926
    if (!VIR_IS_CONNECT(conn)) {
5927 5928
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
5929 5930 5931
        return (-1);
    }

D
Daniel Veillard 已提交
5932
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
5933
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5934
        goto error;
5935 5936
    }

5937 5938 5939 5940 5941 5942 5943
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
5944 5945

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5946 5947

error:
5948
    virDispatchError(conn);
5949 5950 5951
    return -1;
}

5952 5953 5954 5955
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
5956
 * Provides the connection pointer associated with a network.  The
5957 5958 5959
 * reference counter on the connection is not increased by this
 * call.
 *
5960 5961 5962 5963
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
5964 5965 5966 5967 5968
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
5969 5970
    DEBUG("net=%p", net);

5971 5972 5973
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
5974
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5975
        virDispatchError(NULL);
5976 5977 5978 5979 5980
        return NULL;
    }
    return net->conn;
}

5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991
/**
 * virConnectNumOfNetworks:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of active networks.
 *
 * Returns the number of network found or -1 in case of error
 */
int
virConnectNumOfNetworks(virConnectPtr conn)
{
5992 5993
    DEBUG("conn=%p", conn);

5994 5995
    virResetLastError();

5996
    if (!VIR_IS_CONNECT(conn)) {
5997
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5998
        virDispatchError(NULL);
5999 6000 6001
        return (-1);
    }

6002 6003 6004 6005 6006 6007 6008
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6009

6010
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6011 6012

error:
6013
    virDispatchError(conn);
6014
    return -1;
6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027
}

/**
 * virConnectListNetworks:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of active networks
 * @maxnames: size of @names
 *
 * Collect the list of active networks, and store their names in @names
 *
 * Returns the number of networks found or -1 in case of error
 */
int
6028
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
6029
{
6030 6031
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

6032 6033
    virResetLastError();

6034
    if (!VIR_IS_CONNECT(conn)) {
6035
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6036
        virDispatchError(NULL);
6037 6038 6039
        return (-1);
    }

6040
    if ((names == NULL) || (maxnames < 0)) {
6041
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6042
        goto error;
6043 6044
    }

6045 6046 6047 6048 6049 6050 6051
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6052

6053
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6054 6055

error:
6056
    virDispatchError(conn);
6057
    return -1;
6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070
}

/**
 * virConnectNumOfDefinedNetworks:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of inactive networks.
 *
 * Returns the number of networks found or -1 in case of error
 */
int
virConnectNumOfDefinedNetworks(virConnectPtr conn)
{
6071 6072
    DEBUG("conn=%p", conn);

6073 6074
    virResetLastError();

6075
    if (!VIR_IS_CONNECT(conn)) {
6076
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6077
        virDispatchError(NULL);
6078 6079 6080
        return (-1);
    }

6081 6082 6083 6084 6085 6086 6087
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6088

6089
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6090 6091

error:
6092
    virDispatchError(conn);
6093
    return -1;
6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106
}

/**
 * virConnectListDefinedNetworks:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
 * list the inactive networks, stores the pointers to the names in @names
 *
 * Returns the number of names provided in the array or -1 in case of error
 */
int
6107
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
6108 6109
                              int maxnames)
{
6110 6111
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

6112 6113
    virResetLastError();

6114
    if (!VIR_IS_CONNECT(conn)) {
6115
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6116
        virDispatchError(NULL);
6117 6118 6119
        return (-1);
    }

6120
    if ((names == NULL) || (maxnames < 0)) {
6121
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6122
        goto error;
6123 6124
    }

6125 6126 6127 6128 6129 6130 6131 6132
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6133

6134
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6135 6136

error:
6137
    virDispatchError(conn);
6138
    return -1;
6139 6140 6141 6142 6143 6144 6145 6146 6147
}

/**
 * virNetworkLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the network
 *
 * Try to lookup a network on the given hypervisor based on its name.
 *
6148 6149
 * Returns a new network object or NULL in case of failure.  If the
 * network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
6150 6151 6152 6153
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
6154 6155
    DEBUG("conn=%p, name=%s", conn, name);

6156 6157
    virResetLastError();

6158
    if (!VIR_IS_CONNECT(conn)) {
6159
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6160
        virDispatchError(NULL);
6161 6162 6163 6164
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6165
        goto  error;
6166 6167
    }

6168 6169 6170 6171 6172 6173 6174
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6175

6176
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6177 6178

error:
6179
    virDispatchError(conn);
6180
    return NULL;
6181 6182 6183 6184 6185 6186 6187 6188 6189
}

/**
 * virNetworkLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the network
 *
 * Try to lookup a network on the given hypervisor based on its UUID.
 *
6190 6191
 * Returns a new network object or NULL in case of failure.  If the
 * network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
6192 6193 6194 6195
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
6196 6197
    DEBUG("conn=%p, uuid=%s", conn, uuid);

6198 6199
    virResetLastError();

6200
    if (!VIR_IS_CONNECT(conn)) {
6201
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6202
        virDispatchError(NULL);
6203 6204 6205 6206
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6207
        goto error;
6208 6209
    }

6210 6211 6212 6213 6214 6215 6216
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6217

6218
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6219 6220

error:
6221
    virDispatchError(conn);
6222
    return NULL;
6223 6224 6225 6226 6227 6228 6229 6230 6231
}

/**
 * virNetworkLookupByUUIDString:
 * @conn: pointer to the hypervisor connection
 * @uuidstr: the string UUID for the network
 *
 * Try to lookup a network on the given hypervisor based on its UUID.
 *
6232 6233
 * Returns a new network object or NULL in case of failure.  If the
 * network cannot be found, then VIR_ERR_NO_NETWORK error is raised.
6234 6235 6236 6237 6238
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
6239
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
6240

6241 6242
    virResetLastError();

6243
    if (!VIR_IS_CONNECT(conn)) {
6244
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6245
        virDispatchError(NULL);
6246 6247 6248 6249
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6250
        goto error;
6251 6252
    }

6253
    if (virUUIDParse(uuidstr, uuid) < 0) {
6254
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6255
        goto error;
6256 6257 6258
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
6259 6260

error:
6261
    virDispatchError(conn);
6262
    return NULL;
6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277
}

/**
 * virNetworkCreateXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: an XML description of the network
 *
 * Create and start a new virtual network, based on an XML description
 * similar to the one returned by virNetworkGetXMLDesc()
 *
 * Returns a new network object or NULL in case of failure
 */
virNetworkPtr
virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc)
{
6278 6279
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

6280 6281
    virResetLastError();

6282
    if (!VIR_IS_CONNECT(conn)) {
6283
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6284
        virDispatchError(NULL);
6285 6286 6287 6288
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6289
        goto error;
6290 6291 6292
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6293
        goto error;
6294 6295
    }

6296 6297 6298 6299 6300 6301 6302
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
6303

6304
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6305 6306

error:
6307
    virDispatchError(conn);
6308
    return NULL;
6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320
}

/**
 * virNetworkDefineXML:
 * @conn: pointer to the hypervisor connection
 * @xml: the XML description for the network, preferably in UTF-8
 *
 * Define a network, but does not create it
 *
 * Returns NULL in case of error, a pointer to the network otherwise
 */
virNetworkPtr
6321 6322
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
6323 6324
    DEBUG("conn=%p, xml=%s", conn, xml);

6325 6326
    virResetLastError();

6327
    if (!VIR_IS_CONNECT(conn)) {
6328
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6329
        virDispatchError(NULL);
6330 6331 6332 6333
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6334
        goto error;
6335 6336 6337
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6338
        goto error;
6339 6340
    }

6341 6342 6343 6344 6345 6346 6347
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
6348

6349
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6350 6351

error:
6352
    virDispatchError(conn);
6353
    return NULL;
6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366
}

/**
 * virNetworkUndefine:
 * @network: pointer to a defined network
 *
 * Undefine a network but does not stop it if it is running
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virNetworkUndefine(virNetworkPtr network) {
    virConnectPtr conn;
6367
    DEBUG("network=%p", network);
6368

6369 6370
    virResetLastError();

6371
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6372
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6373
        virDispatchError(NULL);
6374 6375 6376 6377 6378
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6379
        goto error;
6380 6381
    }

6382 6383 6384 6385 6386 6387 6388
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6389

6390
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6391 6392

error:
6393
    virDispatchError(network->conn);
6394
    return -1;
6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406
}

/**
 * virNetworkCreate:
 * @network: pointer to a defined network
 *
 * Create and start a defined network. If the call succeed the network
 * moves from the defined to the running networks pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
6407 6408
virNetworkCreate(virNetworkPtr network)
{
6409
    virConnectPtr conn;
6410 6411
    DEBUG("network=%p", network);

6412 6413
    virResetLastError();

6414
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6415
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6416
        virDispatchError(NULL);
6417 6418 6419 6420 6421
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6422
        goto error;
6423 6424
    }

6425 6426 6427 6428 6429 6430 6431
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6432

6433
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6434 6435

error:
6436
    virDispatchError(network->conn);
6437
    return -1;
6438 6439 6440 6441 6442 6443 6444
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
6445 6446 6447
 * already and all resources used by it are given back to the hypervisor. This
 * does not free the associated virNetworkPtr object.
 * This function may require privileged access
6448 6449 6450 6451 6452 6453 6454
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
6455
    DEBUG("network=%p", network);
6456

6457 6458
    virResetLastError();

6459
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6460
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6461
        virDispatchError(NULL);
6462 6463 6464 6465 6466 6467
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6468
        goto error;
6469 6470
    }

6471 6472 6473 6474 6475 6476 6477
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6478

6479
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6480 6481

error:
6482
    virDispatchError(network->conn);
6483
    return -1;
6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497
}

/**
 * virNetworkFree:
 * @network: a network object
 *
 * Free the network object. The running instance is kept alive.
 * The data structure is freed and should not be used thereafter.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkFree(virNetworkPtr network)
{
6498 6499
    DEBUG("network=%p", network);

6500 6501 6502
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6503
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6504
        virDispatchError(NULL);
6505 6506
        return (-1);
    }
6507 6508
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
6509
        return (-1);
6510
    }
6511 6512 6513
    return(0);
}

6514 6515
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
6516
 * @network: the network to hold a reference on
6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527
 *
 * Increment the reference count on the network. For each
 * additional call to this method, there shall be a corresponding
 * call to virNetworkFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a network would increment
 * the reference count.
D
Daniel Veillard 已提交
6528 6529
 *
 * Returns 0 in case of success, -1 in case of failure.
6530 6531 6532 6533 6534 6535
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
6536
        virDispatchError(NULL);
6537 6538 6539 6540 6541 6542 6543 6544 6545
        return(-1);
    }
    virMutexLock(&network->conn->lock);
    DEBUG("network=%p refs=%d", network, network->refs);
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557
/**
 * virNetworkGetName:
 * @network: a network object
 *
 * Get the public name for that network
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * its lifetime will be the same as the network object.
 */
const char *
virNetworkGetName(virNetworkPtr network)
{
6558 6559
    DEBUG("network=%p", network);

6560 6561
    virResetLastError();

6562
    if (!VIR_IS_NETWORK(network)) {
6563
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6564
        virDispatchError(NULL);
6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581
        return (NULL);
    }
    return (network->name);
}

/**
 * virNetworkGetUUID:
 * @network: a network object
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
 *
 * Get the UUID for a network
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNetworkGetUUID(virNetworkPtr network, unsigned char *uuid)
{
6582 6583
    DEBUG("network=%p, uuid=%p", network, uuid);

6584 6585
    virResetLastError();

6586
    if (!VIR_IS_NETWORK(network)) {
6587
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6588
        virDispatchError(NULL);
6589 6590 6591 6592
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6593
        goto error;
6594 6595 6596 6597 6598
    }

    memcpy(uuid, &network->uuid[0], VIR_UUID_BUFLEN);

    return (0);
6599 6600

error:
6601
    virDispatchError(network->conn);
6602
    return -1;
6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618
}

/**
 * virNetworkGetUUIDString:
 * @network: a network object
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
 *
 * Get the UUID for a network as string. For more information about
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNetworkGetUUIDString(virNetworkPtr network, char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
6619
    DEBUG("network=%p, buf=%p", network, buf);
6620

6621 6622
    virResetLastError();

6623
    if (!VIR_IS_NETWORK(network)) {
6624
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6625
        virDispatchError(NULL);
6626 6627 6628 6629
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6630
        goto error;
6631 6632 6633
    }

    if (virNetworkGetUUID(network, &uuid[0]))
6634
        goto error;
6635

6636
    virUUIDFormat(uuid, buf);
6637
    return (0);
6638 6639

error:
6640
    virDispatchError(network->conn);
6641
    return -1;
6642 6643 6644 6645 6646
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
6647
 * @flags: an OR'ed set of extraction flags, not used yet
6648 6649 6650 6651 6652 6653 6654 6655 6656 6657
 *
 * Provide an XML description of the network. The description may be reused
 * later to relaunch the network with virNetworkCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNetworkGetXMLDesc(virNetworkPtr network, int flags)
{
6658
    virConnectPtr conn;
6659
    DEBUG("network=%p, flags=%d", network, flags);
6660

6661 6662 6663
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6664
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6665
        virDispatchError(NULL);
6666 6667 6668 6669
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6670
        goto error;
6671 6672
    }

6673 6674
    conn = network->conn;

6675 6676 6677 6678 6679 6680 6681
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
6682

6683
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6684 6685

error:
6686
    virDispatchError(network->conn);
6687
    return NULL;
6688
}
6689 6690 6691 6692 6693

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
6694
 * Provides a bridge interface name to which a domain may connect
6695 6696 6697 6698 6699 6700 6701 6702
 * a network interface in order to join the network.
 *
 * Returns a 0 terminated interface name, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNetworkGetBridgeName(virNetworkPtr network)
{
6703
    virConnectPtr conn;
6704
    DEBUG("network=%p", network);
6705

6706 6707 6708
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6709
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6710
        virDispatchError(NULL);
6711 6712 6713
        return (NULL);
    }

6714 6715
    conn = network->conn;

6716 6717 6718 6719 6720 6721 6722
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
6723

6724
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6725 6726

error:
6727
    virDispatchError(network->conn);
6728
    return NULL;
6729
}
6730 6731 6732 6733

/**
 * virNetworkGetAutostart:
 * @network: a network object
6734
 * @autostart: the value returned
6735
 *
6736
 * Provides a boolean value indicating whether the network
6737 6738 6739 6740 6741 6742 6743
 * configured to be automatically started when the host
 * machine boots.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNetworkGetAutostart(virNetworkPtr network,
6744 6745 6746
                       int *autostart)
{
    virConnectPtr conn;
6747
    DEBUG("network=%p, autostart=%p", network, autostart);
6748

6749 6750 6751
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6752
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6753
        virDispatchError(NULL);
6754 6755 6756 6757
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
6758
        goto error;
6759 6760
    }

6761 6762
    conn = network->conn;

6763 6764 6765 6766 6767 6768 6769
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6770

6771
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6772 6773

error:
6774
    virDispatchError(network->conn);
6775
    return -1;
6776 6777 6778 6779 6780
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
6781
 * @autostart: whether the network should be automatically started 0 or 1
6782 6783 6784 6785 6786 6787 6788 6789
 *
 * Configure the network to be automatically started
 * when the host machine boots.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNetworkSetAutostart(virNetworkPtr network,
6790 6791 6792
                       int autostart)
{
    virConnectPtr conn;
6793
    DEBUG("network=%p, autostart=%d", network, autostart);
6794

6795 6796 6797
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6798
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6799
        virDispatchError(NULL);
6800 6801 6802
        return (-1);
    }

6803 6804
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6805
        goto error;
6806 6807
    }

6808 6809
    conn = network->conn;

6810 6811 6812 6813 6814 6815 6816
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6817

6818
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6819 6820

error:
6821
    virDispatchError(network->conn);
6822
    return -1;
6823
}
6824

D
Daniel Veillard 已提交
6825 6826
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
6827
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839
 *
 * Provides the connection pointer associated with an interface.  The
 * reference counter on the connection is not increased by this
 * call.
 *
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the interface object together.
 *
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
6840
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
6841
{
6842
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6843 6844 6845

    virResetLastError();

6846
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
D
Daniel Veillard 已提交
6847
        virLibInterfaceError (NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6848
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6849 6850
        return NULL;
    }
6851
    return iface->conn;
D
Daniel Veillard 已提交
6852 6853 6854 6855 6856 6857
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
6858
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
6859
 *
6860
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
6861 6862 6863 6864 6865 6866 6867 6868 6869 6870
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6871
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885
        return (-1);
    }

    if (conn->interfaceDriver && conn->interfaceDriver->numOfInterfaces) {
        int ret;
        ret = conn->interfaceDriver->numOfInterfaces (conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6886
    virDispatchError(conn);
D
Daniel Veillard 已提交
6887 6888 6889 6890 6891 6892 6893 6894 6895
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
6896 6897
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6910
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->listInterfaces) {
        int ret;
        ret = conn->interfaceDriver->listInterfaces (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6930
    virDispatchError(conn);
D
Daniel Veillard 已提交
6931 6932 6933
    return -1;
}

6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950
/**
 * virConnectNumOfDefinedInterfaces:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of defined (inactive) interfaces on the physical host.
 *
 * Returns the number of defined interface found or -1 in case of error
 */
int
virConnectNumOfDefinedInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6951
        virDispatchError(NULL);
6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965
        return (-1);
    }

    if (conn->interfaceDriver && conn->interfaceDriver->numOfDefinedInterfaces) {
        int ret;
        ret = conn->interfaceDriver->numOfDefinedInterfaces (conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
6966
    virDispatchError(conn);
6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991
    return -1;
}

/**
 * virConnectListDefinedInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
 * Collect the list of defined (inactive) physical host interfaces,
 * and store their names in @names.
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListDefinedInterfaces(virConnectPtr conn,
                                char **const names,
                                int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6992
        virDispatchError(NULL);
6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->listDefinedInterfaces) {
        int ret;
        ret = conn->interfaceDriver->listDefinedInterfaces (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7012
    virDispatchError(conn);
7013 7014 7015
    return -1;
}

D
Daniel Veillard 已提交
7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034
/**
 * virInterfaceLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the interface
 *
 * Try to lookup an interface on the given hypervisor based on its name.
 *
 * Returns a new interface object or NULL in case of failure.  If the
 * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
 */
virInterfacePtr
virInterfaceLookupByName(virConnectPtr conn, const char *name)
{
    DEBUG("conn=%p, name=%s", conn, name);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7035
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto  error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceLookupByName) {
        virInterfacePtr ret;
        ret = conn->interfaceDriver->interfaceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7054
    virDispatchError(conn);
D
Daniel Veillard 已提交
7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076
    return NULL;
}

/**
 * virInterfaceLookupByMACString:
 * @conn: pointer to the hypervisor connection
 * @macstr: the MAC for the interface (null-terminated ASCII format)
 *
 * Try to lookup an interface on the given hypervisor based on its MAC.
 *
 * Returns a new interface object or NULL in case of failure.  If the
 * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
 */
virInterfacePtr
virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr)
{
    DEBUG("conn=%p, macstr=%s", conn, macstr);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7077
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095
        return (NULL);
    }
    if (macstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto  error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceLookupByMACString) {
        virInterfacePtr ret;
        ret = conn->interfaceDriver->interfaceLookupByMACString (conn, macstr);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7096
    virDispatchError(conn);
D
Daniel Veillard 已提交
7097 7098 7099 7100 7101
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
7102
 * @iface: an interface object
D
Daniel Veillard 已提交
7103 7104 7105 7106 7107 7108 7109
 *
 * Get the public name for that interface
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * its lifetime will be the same as the interface object.
 */
const char *
7110
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
7111
{
7112
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7113 7114 7115

    virResetLastError();

7116
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7117
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7118
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7119 7120
        return (NULL);
    }
7121
    return (iface->name);
D
Daniel Veillard 已提交
7122 7123 7124 7125
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
7126
 * @iface: an interface object
D
Daniel Veillard 已提交
7127
 *
L
Laine Stump 已提交
7128
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
7129 7130 7131 7132 7133 7134 7135
 * MAC see RFC4122.
 *
 * Returns a pointer to the MAC address (in null-terminated ASCII
 * format) or NULL, the string need not be deallocated its lifetime
 * will be the same as the interface object.
 */
const char *
7136
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
7137
{
7138
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7139 7140 7141

    virResetLastError();

7142
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7143
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7144
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7145 7146
        return (NULL);
    }
7147
    return (iface->mac);
D
Daniel Veillard 已提交
7148 7149 7150 7151
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
7152
 * @iface: an interface object
7153 7154 7155 7156 7157
 * @flags: an OR'ed set of extraction flags. Current valid bits:
 *
 *      VIR_INTERFACE_XML_INACTIVE - return the static configuration,
 *                                   suitable for use redefining the
 *                                   interface via virInterfaceDefineXML()
D
Daniel Veillard 已提交
7158
 *
7159 7160 7161 7162 7163
 * Provide an XML description of the interface. If
 * VIR_INTERFACE_XML_INACTIVE is set, the description may be reused
 * later to redefine the interface with virInterfaceDefineXML(). If it
 * is not set, the ip address and netmask will be the current live
 * setting of the interface, not the settings from the config files.
D
Daniel Veillard 已提交
7164 7165 7166 7167 7168
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
7169
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7170 7171
{
    virConnectPtr conn;
7172
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7173 7174 7175

    virResetLastError();

7176
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7177
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7178
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7179 7180
        return (NULL);
    }
7181
    if ((flags & ~VIR_INTERFACE_XML_INACTIVE) != 0) {
7182
        virLibInterfaceError(iface, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7183 7184 7185
        goto error;
    }

7186
    conn = iface->conn;
D
Daniel Veillard 已提交
7187 7188 7189

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
7190
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
7191 7192 7193 7194 7195 7196 7197 7198
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7199
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221
    return NULL;
}

/**
 * virInterfaceDefineXML:
 * @conn: pointer to the hypervisor connection
 * @xml: the XML description for the interface, preferably in UTF-8
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Define an interface (or modify existing interface configuration)
 *
 * Returns NULL in case of error, a pointer to the interface otherwise
 */
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
    DEBUG("conn=%p, xml=%s, flags=%d", conn, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7222
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDefineXML) {
        virInterfacePtr ret;
        ret = conn->interfaceDriver->interfaceDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7245
    virDispatchError(conn);
D
Daniel Veillard 已提交
7246 7247 7248 7249 7250
    return NULL;
}

/**
 * virInterfaceUndefine:
7251
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
7252 7253 7254 7255 7256 7257 7258
 *
 * Undefine an interface, ie remove it from the config.
 * This does not free the associated virInterfacePtr object.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
7259
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
7260
    virConnectPtr conn;
7261
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7262 7263 7264

    virResetLastError();

7265
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7266
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7267
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7268 7269
        return (-1);
    }
7270
    conn = iface->conn;
D
Daniel Veillard 已提交
7271
    if (conn->flags & VIR_CONNECT_RO) {
7272
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7273 7274 7275 7276 7277
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
7278
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
7279 7280 7281 7282 7283 7284 7285 7286
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7287
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7288 7289 7290 7291 7292
    return -1;
}

/**
 * virInterfaceCreate:
7293
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
7294 7295 7296 7297 7298 7299 7300
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Activate an interface (ie call "ifup")
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
7301
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7302 7303
{
    virConnectPtr conn;
7304
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7305 7306 7307

    virResetLastError();

7308
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7309
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7310
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7311 7312
        return (-1);
    }
7313
    conn = iface->conn;
D
Daniel Veillard 已提交
7314
    if (conn->flags & VIR_CONNECT_RO) {
7315
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7316 7317 7318 7319 7320
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
7321
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
7322 7323 7324 7325 7326 7327 7328 7329
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7330
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7331 7332 7333 7334 7335
    return -1;
}

/**
 * virInterfaceDestroy:
7336
 * @iface: an interface object
D
Daniel Veillard 已提交
7337 7338 7339 7340 7341 7342 7343 7344 7345
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * deactivate an interface (ie call "ifdown")
 * This does not remove the interface from the config, and
 * does not free the associated virInterfacePtr object.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
7346
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7347 7348
{
    virConnectPtr conn;
7349
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7350 7351 7352

    virResetLastError();

7353
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7354
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7355
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7356 7357 7358
        return (-1);
    }

7359
    conn = iface->conn;
D
Daniel Veillard 已提交
7360
    if (conn->flags & VIR_CONNECT_RO) {
7361
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7362 7363 7364 7365 7366
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
7367
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
7368 7369 7370 7371 7372 7373 7374 7375
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
7376
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7377 7378 7379 7380 7381
    return -1;
}

/**
 * virInterfaceRef:
7382
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
7383 7384 7385 7386 7387 7388 7389 7390 7391
 *
 * Increment the reference count on the interface. For each
 * additional call to this method, there shall be a corresponding
 * call to virInterfaceFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
L
Laine Stump 已提交
7392
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
7393 7394 7395 7396 7397
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
7398
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
7399
{
7400
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
D
Daniel Veillard 已提交
7401
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
7402
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7403 7404
        return(-1);
    }
7405 7406 7407 7408
    virMutexLock(&iface->conn->lock);
    DEBUG("iface=%p refs=%d", iface, iface->refs);
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
7409 7410 7411 7412 7413
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
7414
 * @iface: an interface object
D
Daniel Veillard 已提交
7415 7416 7417 7418 7419 7420 7421
 *
 * Free the interface object. The interface itself is unaltered.
 * The data structure is freed and should not be used thereafter.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
7422
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
7423
{
7424
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7425 7426 7427

    virResetLastError();

7428
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
7429
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7430
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7431 7432
        return (-1);
    }
7433 7434
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7435
        return (-1);
7436
    }
D
Daniel Veillard 已提交
7437 7438 7439
    return(0);
}

7440 7441 7442

/**
 * virStoragePoolGetConnect:
7443
 * @pool: pointer to a pool
7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459
 *
 * Provides the connection pointer associated with a storage pool.  The
 * reference counter on the connection is not increased by this
 * call.
 *
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the pool object together.
 *
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virStoragePoolGetConnect (virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

7460 7461 7462
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
7463
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7464
        virDispatchError(NULL);
7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482
        return NULL;
    }
    return pool->conn;
}

/**
 * virConnectNumOfStoragePools:
 * @conn: pointer to hypervisor connection
 *
 * Provides the number of active storage pools
 *
 * Returns the number of pools found, or -1 on error
 */
int
virConnectNumOfStoragePools	(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

7483 7484
    virResetLastError();

7485 7486
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7487
        virDispatchError(NULL);
7488 7489 7490
        return (-1);
    }

7491 7492 7493 7494 7495 7496 7497
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7498 7499

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7500 7501

error:
7502
    virDispatchError(conn);
7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524
    return -1;
}

/**
 * virConnectListStoragePools:
 * @conn: pointer to hypervisor connection
 * @names: array of char * to fill with pool names (allocated by caller)
 * @maxnames: size of the names array
 *
 * Provides the list of names of active storage pools
 * upto maxnames. If there are more than maxnames, the
 * remaining names will be silently ignored.
 *
 * Returns 0 on success, -1 on error
 */
int
virConnectListStoragePools	(virConnectPtr conn,
                             char **const names,
                             int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

7525 7526
    virResetLastError();

7527 7528
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7529
        virDispatchError(NULL);
7530 7531 7532 7533 7534
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7535
        goto error;
7536 7537
    }

7538 7539 7540 7541 7542 7543 7544
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7545 7546 7547

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7548
error:
7549
    virDispatchError(conn);
7550
    return -1;
7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566
}


/**
 * virConnectNumOfDefinedStoragePools:
 * @conn: pointer to hypervisor connection
 *
 * Provides the number of inactive storage pools
 *
 * Returns the number of pools found, or -1 on error
 */
int
virConnectNumOfDefinedStoragePools(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

7567 7568
    virResetLastError();

7569 7570
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7571
        virDispatchError(NULL);
7572 7573 7574
        return (-1);
    }

7575 7576 7577 7578 7579 7580 7581
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7582 7583

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7584 7585

error:
7586
    virDispatchError(conn);
7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609
    return -1;
}


/**
 * virConnectListDefinedStoragePools:
 * @conn: pointer to hypervisor connection
 * @names: array of char * to fill with pool names (allocated by caller)
 * @maxnames: size of the names array
 *
 * Provides the list of names of inactive storage pools
 * upto maxnames. If there are more than maxnames, the
 * remaining names will be silently ignored.
 *
 * Returns 0 on success, -1 on error
 */
int
virConnectListDefinedStoragePools(virConnectPtr conn,
                                  char **const names,
                                  int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

7610 7611
    virResetLastError();

7612 7613
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7614
        virDispatchError(NULL);
7615 7616 7617 7618 7619
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7620
        goto error;
7621 7622
    }

7623 7624 7625 7626 7627 7628 7629
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7630 7631

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7632 7633

error:
7634
    virDispatchError(conn);
7635 7636 7637 7638
    return -1;
}


7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665
/**
 * virConnectFindStoragePoolSources:
 * @conn: pointer to hypervisor connection
 * @type: type of storage pool sources to discover
 * @srcSpec: XML document specifying discovery source
 * @flags: flags for discovery (unused, pass 0)
 *
 * Talks to a storage backend and attempts to auto-discover the set of
 * available storage pool sources. e.g. For iSCSI this would be a set of
 * iSCSI targets. For NFS this would be a list of exported paths.  The
 * srcSpec (optional for some storage pool types, e.g. local ones) is
 * an instance of the storage pool's source element specifying where
 * to look for the pools.
 *
 * srcSpec is not required for some types (e.g., those querying
 * local storage resources only)
 *
 * Returns an xml document consisting of a SourceList element
 * containing a source document appropriate to the given pool
 * type for each discovered source.
 */
char *
virConnectFindStoragePoolSources(virConnectPtr conn,
                                 const char *type,
                                 const char *srcSpec,
                                 unsigned int flags)
{
7666 7667 7668 7669
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

7670 7671
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7672
        virDispatchError(NULL);
7673
        return NULL;
7674 7675 7676
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7677
        goto error;
7678 7679
    }

7680 7681
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7682
        goto error;
7683 7684
    }

7685 7686 7687 7688 7689 7690 7691
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
7692 7693

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7694 7695

error:
7696
    virDispatchError(conn);
7697 7698 7699 7700
    return NULL;
}


7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715
/**
 * virStoragePoolLookupByName:
 * @conn: pointer to hypervisor connection
 * @name: name of pool to fetch
 *
 * Fetch a storage pool based on its unique name
 *
 * Returns a virStoragePoolPtr object, or NULL if no matching pool is found
 */
virStoragePoolPtr
virStoragePoolLookupByName(virConnectPtr conn,
                           const char *name)
{
    DEBUG("conn=%p, name=%s", conn, name);

7716 7717
    virResetLastError();

7718 7719
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7720
        virDispatchError(NULL);
7721 7722 7723 7724
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7725
        goto error;
7726 7727
    }

7728 7729 7730 7731 7732 7733 7734
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7735 7736

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7737 7738

error:
7739
    virDispatchError(conn);
7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758
    return NULL;
}


/**
 * virStoragePoolLookupByUUID:
 * @conn: pointer to hypervisor connection
 * @uuid: globally unique id of pool to fetch
 *
 * Fetch a storage pool based on its globally unique id
 *
 * Returns a virStoragePoolPtr object, or NULL if no matching pool is found
 */
virStoragePoolPtr
virStoragePoolLookupByUUID(virConnectPtr conn,
                           const unsigned char *uuid)
{
    DEBUG("conn=%p, uuid=%s", conn, uuid);

7759 7760
    virResetLastError();

7761 7762
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7763
        virDispatchError(NULL);
7764 7765 7766 7767
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7768
        goto error;
7769 7770
    }

7771 7772 7773 7774 7775 7776 7777
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
7778 7779 7780

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7781
error:
7782
    virDispatchError(conn);
7783
    return NULL;
7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797
}


/**
 * virStoragePoolLookupByUUIDString:
 * @conn: pointer to hypervisor connection
 * @uuidstr: globally unique id of pool to fetch
 *
 * Fetch a storage pool based on its globally unique id
 *
 * Returns a virStoragePoolPtr object, or NULL if no matching pool is found
 */
virStoragePoolPtr
virStoragePoolLookupByUUIDString(virConnectPtr conn,
7798
                                 const char *uuidstr)
7799 7800 7801 7802
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

7803 7804
    virResetLastError();

7805 7806
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7807
        virDispatchError(NULL);
7808 7809 7810 7811
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7812
        goto error;
7813 7814 7815 7816
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7817
        goto error;
7818 7819 7820
    }

    return virStoragePoolLookupByUUID(conn, uuid);
7821 7822

error:
7823
    virDispatchError(conn);
7824
    return NULL;
7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840
}


/**
 * virStoragePoolLookupByVolume:
 * @vol: pointer to storage volume
 *
 * Fetch a storage pool which contains a particular volume
 *
 * Returns a virStoragePoolPtr object, or NULL if no matching pool is found
 */
virStoragePoolPtr
virStoragePoolLookupByVolume(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

7841 7842 7843
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
7844
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7845
        virDispatchError(NULL);
7846 7847 7848
        return (NULL);
    }

7849 7850 7851 7852 7853 7854 7855
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
7856 7857 7858

    virLibConnError (vol->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7859
error:
7860
    virDispatchError(vol->conn);
7861
    return NULL;
7862 7863 7864 7865 7866 7867
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
7868
 * @flags: future flags, use 0 for now
7869 7870
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
7871
 * pool is not persistent, so its definition will disappear
7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882
 * when it is destroyed, or if the host is restarted
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolCreateXML(virConnectPtr conn,
                        const char *xmlDesc,
                        unsigned int flags)
{
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

7883 7884
    virResetLastError();

7885 7886
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7887
        virDispatchError(NULL);
7888 7889 7890 7891
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7892
        goto error;
7893 7894 7895
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7896
        goto error;
7897 7898
    }

7899 7900 7901 7902 7903 7904 7905
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7906 7907

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7908 7909

error:
7910
    virDispatchError(conn);
7911 7912 7913 7914 7915 7916 7917
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
7918
 * @flags: future flags, use 0 for now
7919 7920
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
7921
 * pool is persistent, until explicitly undefined.
7922 7923 7924 7925 7926 7927 7928 7929 7930 7931
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
    DEBUG("conn=%p, xml=%s", conn, xml);

7932 7933
    virResetLastError();

7934 7935
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
7936
        virDispatchError(NULL);
7937 7938 7939 7940
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7941
        goto error;
7942 7943 7944
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7945
        goto error;
7946 7947
    }

7948 7949 7950 7951 7952 7953 7954
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
7955 7956 7957

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7958
error:
7959
    virDispatchError(conn);
7960
    return NULL;
7961 7962 7963 7964 7965
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
7966
 * @flags: future flags, use 0 for now
7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

7979 7980
    virResetLastError();

7981 7982
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7983
        virDispatchError(NULL);
7984 7985 7986 7987 7988
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7989
        goto error;
7990 7991
    }

7992 7993 7994 7995 7996 7997 7998
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7999 8000 8001

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8002
error:
8003
    virDispatchError(pool->conn);
8004
    return -1;
8005 8006 8007 8008 8009 8010 8011 8012 8013
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
8014
 * Returns 0 on success, -1 on failure
8015 8016 8017 8018 8019 8020 8021
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

8022 8023
    virResetLastError();

8024 8025
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8026
        virDispatchError(NULL);
8027 8028 8029 8030 8031
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8032
        goto error;
8033 8034
    }

8035 8036 8037 8038 8039 8040 8041
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8042 8043 8044

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8045
error:
8046
    virDispatchError(pool->conn);
8047
    return -1;
8048 8049 8050 8051 8052 8053
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
8054
 * @flags: future flags, use 0 for now
8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066
 *
 * Starts an inactive storage pool
 *
 * Returns 0 on success, or -1 if it could not be started
 */
int
virStoragePoolCreate(virStoragePoolPtr pool,
                     unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

8067 8068
    virResetLastError();

8069 8070
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8071
        virDispatchError(NULL);
8072 8073 8074 8075 8076
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8077
        goto error;
8078 8079
    }

8080 8081 8082 8083 8084 8085 8086
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8087 8088 8089

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8090
error:
8091
    virDispatchError(pool->conn);
8092
    return -1;
8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113
}


/**
 * virStoragePoolDestroy:
 * @pool: pointer to storage pool
 *
 * Destroy an active storage pool. This will deactivate the
 * pool on the host, but keep any persistent config associated
 * with it. If it has a persistent config it can later be
 * restarted with virStoragePoolCreate(). This does not free
 * the associated virStoragePoolPtr object.
 *
 * Returns 0 on success, or -1 if it could not be destroyed
 */
int
virStoragePoolDestroy(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

8114 8115
    virResetLastError();

8116 8117
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8118
        virDispatchError(NULL);
8119 8120 8121 8122 8123 8124
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8125
        goto error;
8126 8127
    }

8128 8129 8130 8131 8132 8133 8134
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8135 8136

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8137 8138

error:
8139
    virDispatchError(pool->conn);
8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160
    return -1;
}

/**
 * virStoragePoolDelete:
 * @pool: pointer to storage pool
 * @flags: flags for obliteration process
 *
 * Delete the underlying pool resources. This is
 * a non-recoverable operation. The virStoragePoolPtr object
 * itself is not free'd.
 *
 * Returns 0 on success, or -1 if it could not be obliterate
 */
int
virStoragePoolDelete(virStoragePoolPtr pool,
                     unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

8161 8162
    virResetLastError();

8163 8164
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8165
        virDispatchError(NULL);
8166 8167 8168 8169 8170 8171
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8172
        goto error;
8173 8174
    }

8175 8176 8177 8178 8179 8180 8181
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8182 8183

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8184 8185

error:
8186
    virDispatchError(pool->conn);
8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204
    return -1;
}


/**
 * virStoragePoolFree:
 * @pool: pointer to storage pool
 *
 * Free a storage pool object, releasing all memory associated with
 * it. Does not change the state of the pool on the host.
 *
 * Returns 0 on success, or -1 if it could not be free'd.
 */
int
virStoragePoolFree(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

8205 8206 8207
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8208
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8209
        virDispatchError(NULL);
8210 8211
        return (-1);
    }
8212 8213
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
8214
        return (-1);
8215
    }
8216 8217 8218 8219 8220
    return(0);

}


8221 8222
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
8223
 * @pool: the pool to hold a reference on
8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234
 *
 * Increment the reference count on the pool. For each
 * additional call to this method, there shall be a corresponding
 * call to virStoragePoolFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a pool would increment
 * the reference count.
D
Daniel Veillard 已提交
8235 8236
 *
 * Returns 0 in case of success, -1 in case of failure.
8237 8238 8239 8240 8241 8242
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
8243
        virDispatchError(NULL);
8244 8245 8246 8247 8248 8249 8250 8251 8252
        return(-1);
    }
    virMutexLock(&pool->conn->lock);
    DEBUG("pool=%p refs=%d", pool, pool->refs);
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

8253 8254 8255 8256 8257 8258 8259 8260 8261
/**
 * virStoragePoolRefresh:
 * @pool: pointer to storage pool
 * @flags: flags to control refresh behaviour (currently unused, use 0)
 *
 * Request that the pool refresh its list of volumes. This may
 * involve communicating with a remote server, and/or initializing
 * new devices at the OS layer
 *
8262
 * Returns 0 if the volume list was refreshed, -1 on failure
8263 8264 8265 8266 8267 8268 8269 8270
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p flags=%u", pool, flags);

8271 8272
    virResetLastError();

8273 8274
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8275
        virDispatchError(NULL);
8276 8277 8278 8279 8280 8281
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8282
        goto error;
8283 8284
    }

8285 8286 8287 8288 8289 8290 8291
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8292 8293

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8294 8295

error:
8296
    virDispatchError(pool->conn);
8297 8298 8299 8300 8301 8302 8303 8304 8305 8306
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
8307
 * Returns the name of the pool, or NULL on error
8308 8309 8310 8311 8312 8313
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

8314 8315
    virResetLastError();

8316 8317
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8318
        virDispatchError(NULL);
8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331
        return (NULL);
    }
    return (pool->name);
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
8332
 * Returns 0 on success, or -1 on error;
8333 8334 8335 8336 8337 8338 8339
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
    DEBUG("pool=%p, uuid=%p", pool, uuid);

8340 8341
    virResetLastError();

8342 8343
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8344
        virDispatchError(NULL);
8345 8346 8347 8348
        return (-1);
    }
    if (uuid == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8349
        goto error;
8350 8351 8352 8353 8354 8355
    }

    memcpy(uuid, &pool->uuid[0], VIR_UUID_BUFLEN);

    return (0);

8356
error:
8357
    virDispatchError(pool->conn);
8358
    return -1;
8359 8360 8361 8362 8363 8364 8365 8366 8367
}

/**
 * virStoragePoolGetUUIDString:
 * @pool: pointer to storage pool
 * @buf: buffer of VIR_UUID_STRING_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool as a string
 *
8368
 * Returns 0 on success, or -1 on error;
8369 8370 8371 8372 8373 8374 8375 8376
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("pool=%p, buf=%p", pool, buf);

8377 8378
    virResetLastError();

8379 8380
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8381
        virDispatchError(NULL);
8382 8383 8384 8385
        return (-1);
    }
    if (buf == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8386
        goto error;
8387 8388 8389
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
8390
        goto error;
8391 8392 8393 8394

    virUUIDFormat(uuid, buf);
    return (0);

8395
error:
8396
    virDispatchError(pool->conn);
8397
    return -1;
8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408
}


/**
 * virStoragePoolGetInfo:
 * @pool: pointer to storage pool
 * @info: pointer at which to store info
 *
 * Get volatile information about the storage pool
 * such as free space / usage summary
 *
8409
 * Returns 0 on success, or -1 on failure.
8410 8411 8412 8413 8414 8415 8416 8417
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("pool=%p, info=%p", pool, info);

8418 8419
    virResetLastError();

8420 8421
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8422
        virDispatchError(NULL);
8423 8424 8425 8426
        return (-1);
    }
    if (info == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8427
        goto error;
8428 8429 8430 8431 8432 8433
    }

    memset(info, 0, sizeof(virStoragePoolInfo));

    conn = pool->conn;

8434 8435 8436 8437 8438 8439 8440
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
8441 8442 8443

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8444
error:
8445
    virDispatchError(pool->conn);
8446
    return -1;
8447 8448 8449 8450 8451 8452
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
8453
 * @flags: flags for XML format options (set of virDomainXMLFlags)
8454 8455 8456 8457 8458
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
8459
 * Returns a XML document, or NULL on error
8460 8461 8462 8463 8464 8465 8466 8467
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

8468 8469 8470
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8471
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8472
        virDispatchError(NULL);
8473 8474 8475 8476
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8477
        goto error;
8478 8479 8480 8481
    }

    conn = pool->conn;

8482 8483 8484 8485 8486 8487 8488
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
8489 8490 8491

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

8492
error:
8493
    virDispatchError(pool->conn);
8494
    return NULL;
8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505
}


/**
 * virStoragePoolGetAutostart:
 * @pool: pointer to storage pool
 * @autostart: location in which to store autostart flag
 *
 * Fetches the value of the autostart flag, which determines
 * whether the pool is automatically started at boot time
 *
8506
 * Returns 0 on success, -1 on failure
8507 8508 8509 8510 8511 8512 8513 8514
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%p", pool, autostart);

8515 8516 8517
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8518
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8519
        virDispatchError(NULL);
8520 8521 8522 8523
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
8524
        goto error;
8525 8526 8527 8528
    }

    conn = pool->conn;

8529 8530 8531 8532 8533 8534 8535
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8536 8537

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8538 8539

error:
8540
    virDispatchError(pool->conn);
8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
8552
 * Returns 0 on success, -1 on failure
8553 8554 8555 8556 8557 8558 8559 8560
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%d", pool, autostart);

8561 8562 8563
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8564
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8565
        virDispatchError(NULL);
8566
        return -1;
8567 8568
    }

8569 8570
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8571
        goto error;
8572 8573
    }

8574 8575
    conn = pool->conn;

8576 8577 8578 8579 8580 8581 8582
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8583 8584

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8585 8586

error:
8587
    virDispatchError(pool->conn);
8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604
    return -1;
}


/**
 * virStoragePoolNumOfVolumes:
 * @pool: pointer to storage pool
 *
 * Fetch the number of storage volumes within a pool
 *
 * Returns the number of storage pools, or -1 on failure
 */
int
virStoragePoolNumOfVolumes(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

8605 8606
    virResetLastError();

8607 8608
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8609
        virDispatchError(NULL);
8610 8611 8612
        return (-1);
    }

8613 8614 8615 8616 8617 8618 8619
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8620 8621

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8622 8623

error:
8624
    virDispatchError(pool->conn);
8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646
    return -1;
}


/**
 * virStoragePoolListVolumes:
 * @pool: pointer to storage pool
 * @names: array in which to storage volume names
 * @maxnames: size of names array
 *
 * Fetch list of storage volume names, limiting to
 * at most maxnames.
 *
 * Returns the number of names fetched, or -1 on error
 */
int
virStoragePoolListVolumes(virStoragePoolPtr pool,
                          char **const names,
                          int maxnames)
{
    DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);

8647 8648
    virResetLastError();

8649 8650
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8651
        virDispatchError(NULL);
8652 8653 8654 8655 8656
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8657
        goto error;
8658 8659
    }

8660 8661 8662 8663 8664 8665 8666
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolListVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolListVolumes (pool, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8667 8668

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8669 8670

error:
8671
    virDispatchError(pool->conn);
8672 8673 8674 8675 8676 8677
    return -1;
}


/**
 * virStorageVolGetConnect:
8678
 * @vol: pointer to a pool
8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694
 *
 * Provides the connection pointer associated with a storage volume.  The
 * reference counter on the connection is not increased by this
 * call.
 *
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the volume object together.
 *
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virStorageVolGetConnect (virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

8695 8696
    virResetLastError();

8697 8698
    if (!VIR_IS_STORAGE_VOL (vol)) {
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8699
        virDispatchError(NULL);
8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713
        return NULL;
    }
    return vol->conn;
}


/**
 * virStorageVolLookupByName:
 * @pool: pointer to storage pool
 * @name: name of storage volume
 *
 * Fetch a pointer to a storage volume based on its name
 * within a pool
 *
8714
 * Returns a storage volume, or NULL if not found / error
8715 8716 8717 8718 8719 8720 8721
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
    DEBUG("pool=%p, name=%s", pool, name);

8722 8723
    virResetLastError();

8724 8725
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8726
        virDispatchError(NULL);
8727 8728 8729 8730
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8731
        goto error;
8732 8733
    }

8734 8735 8736 8737 8738 8739 8740
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
8741 8742

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8743 8744

error:
8745
    virDispatchError(pool->conn);
8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758
    return NULL;
}



/**
 * virStorageVolLookupByKey:
 * @conn: pointer to hypervisor connection
 * @key: globally unique key
 *
 * Fetch a pointer to a storage volume based on its
 * globally unique key
 *
8759
 * Returns a storage volume, or NULL if not found / error
8760 8761 8762 8763 8764 8765 8766
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
    DEBUG("conn=%p, key=%s", conn, key);

8767 8768
    virResetLastError();

8769 8770
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8771
        virDispatchError(NULL);
8772 8773 8774 8775
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8776
        goto error;
8777 8778
    }

8779 8780 8781 8782 8783 8784 8785
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
8786 8787

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8788 8789

error:
8790
    virDispatchError(conn);
8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801
    return NULL;
}

/**
 * virStorageVolLookupByPath:
 * @conn: pointer to hypervisor connection
 * @path: locally unique path
 *
 * Fetch a pointer to a storage volume based on its
 * locally (host) unique path
 *
8802
 * Returns a storage volume, or NULL if not found / error
8803 8804 8805 8806 8807 8808 8809
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
    DEBUG("conn=%p, path=%s", conn, path);

8810 8811
    virResetLastError();

8812 8813
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
8814
        virDispatchError(NULL);
8815 8816 8817 8818
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8819
        goto error;
8820 8821
    }

8822 8823 8824 8825 8826 8827 8828
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
8829 8830

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8831 8832

error:
8833
    virDispatchError(conn);
8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
8845
 * Returns the volume name, or NULL on error
8846 8847 8848 8849 8850 8851
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

8852 8853
    virResetLastError();

8854 8855
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8856
        virDispatchError(NULL);
8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867
        return (NULL);
    }
    return (vol->name);
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
8868
 * unique, so the same volume will have the same
8869 8870
 * key no matter what host it is accessed from
 *
8871
 * Returns the volume key, or NULL on error
8872 8873 8874 8875 8876 8877
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

8878 8879
    virResetLastError();

8880 8881
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8882
        virDispatchError(NULL);
8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898
        return (NULL);
    }
    return (vol->key);
}


/**
 * virStorageVolCreateXML:
 * @pool: pointer to storage pool
 * @xmldesc: description of volume to create
 * @flags: flags for creation (unused, pass 0)
 *
 * Create a storage volume within a pool based
 * on an XML description. Not all pools support
 * creation of volumes
 *
8899
 * Returns the storage volume, or NULL on error
8900 8901 8902 8903 8904 8905 8906 8907
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
    DEBUG("pool=%p, flags=%u", pool, flags);

8908 8909
    virResetLastError();

8910
    if (!VIR_IS_STORAGE_POOL(pool)) {
8911
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8912
        virDispatchError(NULL);
8913 8914 8915 8916 8917
        return (NULL);
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8918
        goto error;
8919 8920
    }

8921 8922 8923 8924 8925 8926 8927
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
8928 8929

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8930 8931

error:
8932
    virDispatchError(pool->conn);
8933 8934 8935 8936
    return NULL;
}


8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948
/**
 * virStorageVolCreateXMLFrom:
 * @pool: pointer to parent pool for the new volume
 * @xmldesc: description of volume to create
 * @clonevol: storage volume to use as input
 * @flags: flags for creation (unused, pass 0)
 *
 * Create a storage volume in the parent pool, using the
 * 'clonevol' volume as input. Information for the new
 * volume (name, perms)  are passed via a typical volume
 * XML description.
 *
8949
 * Returns the storage volume, or NULL on error
8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
    DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8963
        virDispatchError(NULL);
8964 8965 8966 8967 8968
        return (NULL);
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8969
        goto error;
8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990
    }

    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (pool->conn->storageDriver &&
        pool->conn->storageDriver->volCreateXMLFrom) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXMLFrom (pool, xmldesc,
                                                           clonevol, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
8991
    virDispatchError(pool->conn);
8992 8993 8994 8995
    return NULL;
}


8996 8997 8998
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
8999
 * @flags: future flags, use 0 for now
9000 9001 9002
 *
 * Delete the storage volume from the pool
 *
9003
 * Returns 0 on success, or -1 on error
9004 9005 9006 9007 9008 9009 9010 9011
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

9012 9013
    virResetLastError();

9014 9015
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9016
        virDispatchError(NULL);
9017 9018 9019 9020 9021 9022
        return (-1);
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStorageVolError(vol, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9023
        goto error;
9024 9025
    }

9026 9027 9028 9029 9030 9031 9032
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9033 9034

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9035 9036

error:
9037
    virDispatchError(vol->conn);
9038 9039 9040 9041
    return -1;
}


9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088
/**
 * virStorageVolWipe:
 * @vol: pointer to storage volume
 * @flags: future flags, use 0 for now
 *
 * Ensure data previously on a volume is not accessible to future reads
 *
 * Returns 0 on success, or -1 on error
 */
int
virStorageVolWipe(virStorageVolPtr vol,
                  unsigned int flags)
{
    virConnectPtr conn;
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStorageVolError(vol, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(vol->conn);
    return -1;
}


9089 9090 9091 9092 9093
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
9094
 * storage volume continues to exist.
9095
 *
9096
 * Returns 0 on success, or -1 on error
9097 9098 9099 9100 9101 9102
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

9103 9104
    virResetLastError();

9105 9106
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9107
        virDispatchError(NULL);
9108 9109
        return (-1);
    }
9110 9111
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
9112
        return (-1);
9113
    }
9114 9115 9116 9117
    return(0);
}


9118 9119
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
9120
 * @vol: the vol to hold a reference on
9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131
 *
 * Increment the reference count on the vol. For each
 * additional call to this method, there shall be a corresponding
 * call to virStorageVolFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a vol would increment
 * the reference count.
D
Daniel Veillard 已提交
9132 9133
 *
 * Returns 0 in case of success, -1 in case of failure.
9134 9135 9136 9137 9138 9139
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
9140
        virDispatchError(NULL);
9141 9142 9143 9144 9145 9146 9147 9148 9149
        return(-1);
    }
    virMutexLock(&vol->conn->lock);
    DEBUG("vol=%p refs=%d", vol, vol->refs);
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

9150 9151 9152 9153 9154 9155 9156 9157
/**
 * virStorageVolGetInfo:
 * @vol: pointer to storage volume
 * @info: pointer at which to store info
 *
 * Fetches volatile information about the storage
 * volume such as its current allocation
 *
9158
 * Returns 0 on success, or -1 on failure
9159 9160 9161 9162 9163 9164 9165 9166
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("vol=%p, info=%p", vol, info);

9167 9168
    virResetLastError();

9169 9170
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9171
        virDispatchError(NULL);
9172 9173 9174 9175
        return (-1);
    }
    if (info == NULL) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
9176
        goto error;
9177 9178 9179 9180 9181 9182
    }

    memset(info, 0, sizeof(virStorageVolInfo));

    conn = vol->conn;

9183 9184 9185 9186 9187 9188 9189
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
9190 9191

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9192 9193

error:
9194
    virDispatchError(vol->conn);
9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206
    return -1;
}


/**
 * virStorageVolGetXMLDesc:
 * @vol: pointer to storage volume
 * @flags: flags for XML generation (unused, pass 0)
 *
 * Fetch an XML document describing all aspects of
 * the storage volume
 *
9207
 * Returns the XML document, or NULL on error
9208 9209 9210 9211 9212 9213 9214 9215
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

9216 9217
    virResetLastError();

9218 9219
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9220
        virDispatchError(NULL);
9221 9222 9223 9224
        return (NULL);
    }
    if (flags != 0) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
9225
        goto error;
9226 9227 9228 9229
    }

    conn = vol->conn;

9230 9231 9232 9233 9234 9235 9236
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
9237 9238 9239

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

9240
error:
9241
    virDispatchError(vol->conn);
9242
    return NULL;
9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263
}


/**
 * virStorageVolGetPath:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume path. Depending on the pool
 * configuration this is either persistent across hosts,
 * or dynamically assigned at pool startup. Consult
 * pool documentation for information on getting the
 * persistent naming
 *
 * Returns the storage volume path, or NULL on error
 */
char *
virStorageVolGetPath(virStorageVolPtr vol)
{
    virConnectPtr conn;
    DEBUG("vol=%p", vol);

9264 9265
    virResetLastError();

9266 9267
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9268
        virDispatchError(NULL);
9269 9270 9271 9272 9273
        return (NULL);
    }

    conn = vol->conn;

9274 9275 9276 9277 9278 9279 9280
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
9281 9282

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9283 9284

error:
9285
    virDispatchError(vol->conn);
9286 9287
    return NULL;
}
9288 9289


9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305
/**
 * virNodeNumOfDevices:
 * @conn: pointer to the hypervisor connection
 * @cap: capability name
 * @flags: flags (unused, pass 0)
 *
 * Provides the number of node devices.
 *
 * If the optional 'cap'  argument is non-NULL, then the count
 * will be restricted to devices with the specified capability
 *
 * Returns the number of node devices or -1 in case of error
 */
int
virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags)
{
J
John Levon 已提交
9306
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
9307

9308 9309
    virResetLastError();

9310 9311
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9312
        virDispatchError(NULL);
9313 9314 9315 9316
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9317
        goto error;
9318 9319
    }

9320 9321 9322 9323 9324 9325 9326
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9327 9328

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9329 9330

error:
9331
    virDispatchError(conn);
9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359
    return -1;
}


/**
 * virNodeListDevices:
 * @conn: pointer to the hypervisor connection
 * @cap: capability name
 * @names: array to collect the list of node device names
 * @maxnames: size of @names
 * @flags: flags (unused, pass 0)
 *
 * Collect the list of node devices, and store their names in @names
 *
 * If the optional 'cap'  argument is non-NULL, then the count
 * will be restricted to devices with the specified capability
 *
 * Returns the number of node devices found or -1 in case of error
 */
int
virNodeListDevices(virConnectPtr conn,
                   const char *cap,
                   char **const names, int maxnames,
                   unsigned int flags)
{
    DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%d",
          conn, cap, names, maxnames, flags);

9360 9361
    virResetLastError();

9362 9363
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9364
        virDispatchError(NULL);
9365 9366 9367 9368
        return (-1);
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9369
        goto error;
9370 9371
    }

9372 9373 9374 9375 9376 9377 9378
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9379 9380

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9381 9382

error:
9383
    virDispatchError(conn);
9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400
    return -1;
}


/**
 * virNodeDeviceLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: unique device name
 *
 * Lookup a node device by its name.
 *
 * Returns a virNodeDevicePtr if found, NULL otherwise.
 */
virNodeDevicePtr virNodeDeviceLookupByName(virConnectPtr conn, const char *name)
{
    DEBUG("conn=%p, name=%p", conn, name);

9401 9402
    virResetLastError();

9403 9404
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9405
        virDispatchError(NULL);
9406 9407 9408 9409 9410
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9411
        goto error;
9412 9413
    }

9414 9415 9416 9417 9418 9419 9420
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
9421 9422

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9423 9424

error:
9425
    virDispatchError(conn);
9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437
    return NULL;
}


/**
 * virNodeDeviceGetXMLDesc:
 * @dev: pointer to the node device
 * @flags: flags for XML generation (unused, pass 0)
 *
 * Fetch an XML document describing all aspects of
 * the device.
 *
9438
 * Returns the XML document, or NULL on error
9439 9440 9441 9442 9443
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

9444 9445
    virResetLastError();

9446 9447
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9448
        virDispatchError(NULL);
9449 9450 9451
        return NULL;
    }

9452 9453 9454 9455 9456 9457 9458
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
9459 9460

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9461 9462

error:
9463
    virDispatchError(dev->conn);
9464 9465 9466 9467 9468 9469 9470 9471
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9472 9473 9474
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
9475 9476 9477 9478 9479 9480 9481
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9482
        virDispatchError(NULL);
9483 9484 9485 9486 9487 9488 9489 9490 9491 9492
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9493 9494
 * Accessor for the parent of the device
 *
9495 9496 9497 9498 9499 9500 9501
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

9502 9503
    virResetLastError();

9504 9505
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9506
        virDispatchError(NULL);
9507 9508 9509
        return NULL;
    }

9510 9511 9512 9513 9514
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
            virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9515
            virDispatchError(dev->conn);
9516 9517 9518 9519
            return NULL;
        }
    }
    return dev->parent;
9520 9521 9522 9523 9524 9525
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9526 9527
 * Accessor for the number of capabilities supported by the device.
 *
9528 9529 9530 9531 9532 9533
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

9534 9535
    virResetLastError();

9536 9537
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9538
        virDispatchError(NULL);
9539 9540 9541
        return -1;
    }

9542 9543 9544 9545 9546 9547 9548
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
9549 9550

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9551 9552

error:
9553
    virDispatchError(dev->conn);
9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573
    return -1;
}

/**
 * virNodeDeviceListCaps:
 * @dev: the device
 * @names: array to collect the list of capability names
 * @maxnames: size of @names
 *
 * Lists the names of the capabilities supported by the device.
 *
 * Returns the number of capability names listed in @names.
 */
int virNodeDeviceListCaps(virNodeDevicePtr dev,
                          char **const names,
                          int maxnames)
{
    DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
          dev, dev ? dev->conn : NULL, names, maxnames);

9574 9575
    virResetLastError();

9576 9577
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9578
        virDispatchError(NULL);
9579 9580 9581
        return -1;
    }

9582 9583 9584 9585 9586 9587 9588
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceListCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceListCaps (dev, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
9589 9590

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
9591 9592

error:
9593
    virDispatchError(dev->conn);
9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610
    return -1;
}


/**
 * virNodeDeviceFree:
 * @dev: pointer to the node device
 *
 * Drops a reference to the node device, freeing it if
 * this was the last reference.
 *
 * Returns the 0 for success, -1 for error.
 */
int virNodeDeviceFree(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

9611 9612
    virResetLastError();

9613 9614
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9615
        virDispatchError(NULL);
9616 9617
        return (-1);
    }
9618 9619
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
9620
        return (-1);
9621
    }
9622 9623 9624 9625
    return(0);
}


9626 9627
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
9628
 * @dev: the dev to hold a reference on
9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639
 *
 * Increment the reference count on the dev. For each
 * additional call to this method, there shall be a corresponding
 * call to virNodeDeviceFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a dev would increment
 * the reference count.
D
Daniel Veillard 已提交
9640 9641
 *
 * Returns 0 in case of success, -1 in case of failure.
9642 9643 9644 9645 9646 9647
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
9648
        virDispatchError(NULL);
9649 9650 9651 9652 9653 9654 9655 9656 9657
        return(-1);
    }
    virMutexLock(&dev->conn->lock);
    DEBUG("dev=%p refs=%d", dev, dev->refs);
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

9658
/**
D
Daniel Veillard 已提交
9659
 * virNodeDeviceDettach:
9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673
 * @dev: pointer to the node device
 *
 * Dettach the node device from the node itself so that it may be
 * assigned to a guest domain.
 *
 * Depending on the hypervisor, this may involve operations such
 * as unbinding any device drivers from the device, binding the
 * device to a dummy device driver and resetting the device.
 *
 * If the device is currently in use by the node, this method may
 * fail.
 *
 * Once the device is not assigned to any guest, it may be re-attached
 * to the node using the virNodeDeviceReattach() method.
D
Daniel Veillard 已提交
9674 9675
 *
 * Returns 0 in case of success, -1 in case of failure.
9676 9677 9678 9679 9680 9681 9682 9683 9684 9685
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9686
        virDispatchError(NULL);
9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700
        return (-1);
    }

    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9701
    virDispatchError(dev->conn);
9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716
    return (-1);
}

/**
 * virNodeDeviceReAttach:
 * @dev: pointer to the node device
 *
 * Re-attach a previously dettached node device to the node so that it
 * may be used by the node again.
 *
 * Depending on the hypervisor, this may involve operations such
 * as resetting the device, unbinding it from a dummy device driver
 * and binding it to its appropriate driver.
 *
 * If the device is currently in use by a guest, this method may fail.
D
Daniel Veillard 已提交
9717 9718
 *
 * Returns 0 in case of success, -1 in case of failure.
9719 9720 9721 9722 9723 9724 9725 9726 9727 9728
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9729
        virDispatchError(NULL);
9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743
        return (-1);
    }

    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9744
    virDispatchError(dev->conn);
9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761
    return (-1);
}

/**
 * virNodeDeviceReset:
 * @dev: pointer to the node device
 *
 * Reset a previously dettached node device to the node before or
 * after assigning it to a guest.
 *
 * The exact reset semantics depends on the hypervisor and device
 * type but, for example, KVM will attempt to reset PCI devices with
 * a Function Level Reset, Secondary Bus Reset or a Power Management
 * D-State reset.
 *
 * If the reset will affect other devices which are currently in use,
 * this function may fail.
D
Daniel Veillard 已提交
9762 9763
 *
 * Returns 0 in case of success, -1 in case of failure.
9764 9765 9766 9767 9768 9769 9770 9771 9772 9773
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9774
        virDispatchError(NULL);
9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788
        return (-1);
    }

    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9789
    virDispatchError(dev->conn);
9790 9791 9792
    return (-1);
}

9793

9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815
/**
 * virNodeDeviceCreateXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: string containing an XML description of the device to be created
 * @flags: callers should always pass 0
 *
 * Create a new device on the VM host machine, for example, virtual
 * HBAs created using vport_create.
 *
 * Returns a node device object if successful, NULL in case of failure
 */
virNodeDevicePtr
virNodeDeviceCreateXML(virConnectPtr conn,
                       const char *xmlDesc,
                       unsigned int flags)
{
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9816
        virDispatchError(NULL);
9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9841
    virDispatchError(conn);
9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863
    return NULL;
}


/**
 * virNodeDeviceDestroy:
 * @dev: a device object
 *
 * Destroy the device object. The virtual device is removed from the host operating system.
 * This function may require privileged access
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNodeDeviceDestroy(virNodeDevicePtr dev)
{
    DEBUG("dev=%p", dev);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9864
        virDispatchError(NULL);
9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885
        return (-1);
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(dev->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
9886
    virDispatchError(dev->conn);
9887 9888 9889 9890
    return -1;
}


9891 9892 9893 9894 9895 9896 9897 9898 9899
/*
 * Domain Event Notification
 */

/**
 * virConnectDomainEventRegister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 * @opaque: opaque data to pass on to the callback
D
Daniel Veillard 已提交
9900
 * @freecb: optional function to deallocate opaque when not used anymore
9901
 *
9902 9903 9904 9905 9906 9907
 * Adds a callback to receive notifications of domain lifecycle events
 * occurring on a connection
 *
 * Use of this method is no longer recommended. Instead applications
 * should try virConnectDomainEventRegisterAny which has a more flexible
 * API contract
9908
 *
9909 9910 9911 9912 9913 9914 9915
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
 * If the callback wishes to keep the domain object after the callback
 * returns, it shall take a reference to it, by calling virDomainRef.
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
9916 9917 9918 9919 9920
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
9921 9922
                              void *opaque,
                              virFreeCallback freecb)
9923
{
9924 9925
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
9926 9927 9928

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9929
        virDispatchError(NULL);
9930 9931 9932 9933
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9934
        goto error;
9935 9936
    }

9937 9938 9939 9940 9941 9942 9943 9944 9945 9946
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
9947
    virDispatchError(conn);
9948 9949 9950 9951 9952 9953 9954 9955
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
9956 9957 9958 9959 9960 9961
 * Removes a callback previously registered with the virConnectDomainEventRegister
 * funtion.
 *
 * Use of this method is no longer recommended. Instead applications
 * should try virConnectDomainEventUnregisterAny which has a more flexible
 * API contract
9962 9963 9964 9965 9966 9967 9968
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
9969 9970 9971
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
9972 9973 9974

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
9975
        virDispatchError(NULL);
9976 9977 9978 9979
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
9980 9981 9982 9983 9984 9985 9986 9987
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
9988 9989
    }

9990 9991
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
9992
    virDispatchError(conn);
9993 9994
    return -1;
}
9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016

/**
 * virSecretGetConnect:
 * @secret: A virSecret secret
 *
 * Provides the connection pointer associated with a secret.  The reference
 * counter on the connection is not increased by this call.
 *
 * WARNING: When writing libvirt bindings in other languages, do not use this
 * function.  Instead, store the connection and the secret object together.
 *
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virSecretGetConnect (virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
        virLibSecretError (NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10017
        virDispatchError(NULL);
10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039
        return NULL;
    }
    return secret->conn;
}

/**
 * virConnectNumOfSecrets:
 * @conn: virConnect connection
 *
 * Fetch number of currently defined secrets.
 *
 * Returns the number currently defined secrets.
 */
int
virConnectNumOfSecrets(virConnectPtr conn)
{
    VIR_DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10040
        virDispatchError(NULL);
10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10057
    virDispatchError(conn);
10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079
    return -1;
}

/**
 * virConnectListSecrets:
 * @conn: virConnect connection
 * @uuids: Pointer to an array to store the UUIDs
 * @maxuuids: size of the array.
 *
 * List UUIDs of defined secrets, store pointers to names in uuids.
 *
 * Returns the number of UUIDs provided in the array, or -1 on failure.
 */
int
virConnectListSecrets(virConnectPtr conn, char **uuids, int maxuuids)
{
    VIR_DEBUG("conn=%p, uuids=%p, maxuuids=%d", conn, uuids, maxuuids);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10080
        virDispatchError(NULL);
10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->listSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->listSecrets(conn, uuids, maxuuids);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10100
    virDispatchError(conn);
10101 10102 10103 10104
    return -1;
}

/**
10105 10106 10107
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
10108
 *
10109 10110
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
10111
 *
10112 10113
 * Returns a new secret object or NULL in case of failure.  If the
 * secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
10114 10115
 */
virSecretPtr
10116
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
10117
{
10118
    DEBUG("conn=%p, uuid=%s", conn, uuid);
10119 10120 10121 10122 10123

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10124
        virDispatchError(NULL);
10125
        return (NULL);
10126 10127 10128 10129 10130 10131
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

10132 10133
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
10134
        virSecretPtr ret;
10135 10136
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
10137 10138 10139 10140 10141 10142 10143
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10144
    virDispatchError(conn);
10145 10146 10147
    return NULL;
}

10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168
/**
 * virSecretLookupByUUIDString:
 * @conn: pointer to the hypervisor connection
 * @uuidstr: the string UUID for the secret
 *
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the printable string value to describe the UUID
 *
 * Returns a new secret object or NULL in case of failure.  If the
 * secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
 */
virSecretPtr
virSecretLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10169
        virDispatchError(NULL);
10170 10171 10172 10173 10174 10175
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
10176 10177

    if (virUUIDParse(uuidstr, uuid) < 0) {
10178 10179 10180 10181 10182 10183 10184
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
10185
    virDispatchError(conn);
10186 10187 10188 10189
    return NULL;
}


10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213
/**
 * virSecretLookupByUsage:
 * @conn: pointer to the hypervisor connection
 * @usageType: the type of secret usage
 * @usageID: identifier of the object using the secret
 *
 * Try to lookup a secret on the given hypervisor based on its usage
 * The usageID is unique within the set of secrets sharing the
 * same usageType value.
 *
 * Returns a new secret object or NULL in case of failure.  If the
 * secret cannot be found, then VIR_ERR_NO_SECRET error is raised.
 */
virSecretPtr
virSecretLookupByUsage(virConnectPtr conn,
                       int usageType,
                       const char *usageID)
{
    DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10214
        virDispatchError(NULL);
10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233
        return (NULL);
    }
    if (usageID == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10234
    virDispatchError(conn);
10235 10236 10237 10238
    return NULL;
}


10239 10240 10241 10242 10243 10244
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
10245
 * If XML specifies a UUID, locates the specified secret and replaces all
10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262
 * attributes of the secret specified by UUID by attributes specified in xml
 * (any attributes not specified in xml are discarded).
 *
 * Otherwise, creates a new secret with an automatically chosen UUID, and
 * initializes its attributes from xml.
 *
 * Returns a the secret on success, NULL on failure.
 */
virSecretPtr
virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
    VIR_DEBUG("conn=%p, xml=%s, flags=%u", conn, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10263
        virDispatchError(NULL);
10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->defineXML != NULL) {
        virSecretPtr ret;

        ret = conn->secretDriver->defineXML(conn, xml, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10287
    virDispatchError(conn);
10288 10289 10290 10291
    return NULL;
}

/**
10292
 * virSecretGetUUID:
10293
 * @secret: A virSecret secret
10294
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
10295 10296 10297
 *
 * Fetches the UUID of the secret.
 *
10298 10299
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
10300
 */
10301 10302
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
10303 10304 10305 10306 10307 10308 10309
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10310
        virDispatchError(NULL);
10311 10312 10313 10314
        return -1;
    }
    if (uuid == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
10315
        virDispatchError(secret->conn);
10316
        return -1;
10317 10318
    }

10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340
    memcpy(uuid, &secret->uuid[0], VIR_UUID_BUFLEN);

    return 0;
}

/**
 * virSecretGetUUIDString:
 * @secret: a secret object
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
 *
 * Get the UUID for a secret as string. For more information about
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virSecretGetUUIDString(virSecretPtr secret, char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("secret=%p, buf=%p", secret, buf);

    virResetLastError();
10341

10342 10343
    if (!VIR_IS_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10344
        virDispatchError(NULL);
10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358
        return (-1);
    }
    if (buf == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
    return (0);

error:
10359
    virDispatchError(secret->conn);
10360
    return -1;
10361 10362
}

10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384
/**
 * virSecretGetUsageType:
 * @secret: a secret object
 *
 * Get the type of object which uses this secret. The returned
 * value is one of the constants defined in the virSecretUsageType
 * enumeration. More values may be added to this enumeration in
 * the future, so callers should expect to see usage types they
 * do not explicitly know about.
 *
 * Returns a positive integer identifying the type of object,
 * or -1 upon error.
 */
int
virSecretGetUsageType(virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10385
        virDispatchError(NULL);
10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415
        return (-1);
    }
    return (secret->usageType);
}

/**
 * virSecretGetUsageID:
 * @secret: a secret object
 *
 * Get the unique identifier of the object with which this
 * secret is to be used. The format of the identifier is
 * dependant on the usage type of the secret. For a secret
 * with a usage type of VIR_SECRET_USAGE_TYPE_VOLUME the
 * identifier will be a fully qualfied path name. The
 * identifiers are intended to be unique within the set of
 * all secrets sharing the same usage type. ie, there shall
 * only ever be one secret for each volume path.
 *
 * Returns a string identifying the object using the secret,
 * or NULL upon error
 */
const char *
virSecretGetUsageID(virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10416
        virDispatchError(NULL);
10417 10418 10419 10420 10421
        return (NULL);
    }
    return (secret->usageID);
}

10422

10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443
/**
 * virSecretGetXMLDesc:
 * @secret: A virSecret secret
 * @flags: flags, use 0 for now
 *
 * Fetches an XML document describing attributes of the secret.
 *
 * Returns the XML document on success, NULL on failure.  The caller must
 * free() the XML.
 */
char *
virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, flags=%u", secret, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10444
        virDispatchError(NULL);
10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460
        return NULL;
    }

    conn = secret->conn;
    if (conn->secretDriver != NULL && conn->secretDriver->getXMLDesc != NULL) {
        char *ret;

        ret = conn->secretDriver->getXMLDesc(secret, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10461
    virDispatchError(conn);
10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488
    return NULL;
}

/**
 * virSecretSetValue:
 * @secret: A virSecret secret
 * @value: Value of the secret
 * @value_size: Size of the value
 * @flags: flags, use 0 for now
 *
 * Sets the value of a secret.
 *
 * Returns 0 on success, -1 on failure.
 */
int
virSecretSetValue(virSecretPtr secret, const unsigned char *value,
                  size_t value_size, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, value=%p, value_size=%zu, flags=%u", secret, value,
              value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10489
        virDispatchError(NULL);
10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibSecretError(secret, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (value == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->setValue != NULL) {
        int ret;

        ret = conn->secretDriver->setValue(secret, value, value_size, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10514
    virDispatchError(conn);
10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539
    return -1;
}

/**
 * virSecretGetValue:
 * @secret: A virSecret connection
 * @value_size: Place for storing size of the secret value
 * @flags: flags, use 0 for now
 *
 * Fetches the value of a secret.
 *
 * Returns the secret value on success, NULL on failure.  The caller must
 * free() the secret value.
 */
unsigned char *
virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, value_size=%p, flags=%u", secret, value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10540
        virDispatchError(NULL);
10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibSecretError(secret, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (value_size == NULL) {
        virLibSecretError(secret, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

10553 10554
    flags &= VIR_SECRET_GET_VALUE_FLAGS_MASK;

10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566
    if (conn->secretDriver != NULL && conn->secretDriver->getValue != NULL) {
        unsigned char *ret;

        ret = conn->secretDriver->getValue(secret, value_size, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10567
    virDispatchError(conn);
10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590
    return NULL;
}

/**
 * virSecretUndefine:
 * @secret: A virSecret secret
 *
 * Deletes the specified secret.  This does not free the associated
 * virSecretPtr object.
 *
 * Returns 0 on success, -1 on failure.
 */
int
virSecretUndefine(virSecretPtr secret)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10591
        virDispatchError(NULL);
10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibSecretError(secret, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10612
    virDispatchError(conn);
10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636
    return -1;
}

/**
 * virSecretRef:
 * @secret: the secret to hold a reference on
 *
 * Increment the reference count on the secret. For each additional call to
 * this method, there shall be a corresponding call to virSecretFree to release
 * the reference count, once the caller no longer needs the reference to this
 * object.
 *
 * This method is typically useful for applications where multiple threads are
 * using a connection, and it is required that the connection remain open until
 * all threads have finished using it. ie, each new thread using a secret would
 * increment the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virSecretRef(virSecretPtr secret)
{
    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10637
        virDispatchError(NULL);
10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652
        return -1;
    }
    virMutexLock(&secret->conn->lock);
    DEBUG("secret=%p refs=%d", secret, secret->refs);
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
10653
 * Returns 0 on success, or -1 on error
10654 10655 10656 10657 10658 10659 10660 10661 10662 10663
 */
int
virSecretFree(virSecretPtr secret)
{
    DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
        virLibSecretError(NULL, VIR_ERR_INVALID_SECRET, __FUNCTION__);
10664
        virDispatchError(NULL);
10665 10666
        return -1;
    }
10667 10668
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
10669
        return -1;
10670
    }
10671 10672
    return 0;
}
10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705


/**
 * virStreamNew:
 * @conn: pointer to the connection
 * @flags: control features of the stream
 *
 * Creates a new stream object which can be used to perform
 * streamed I/O with other public API function.
 *
 * When no longer needed, a stream object must be released
 * with virStreamFree. If a data stream has been used,
 * then the application must call virStreamFinish or
 * virStreamAbort before free'ing to, in order to notify
 * the driver of termination.
 *
 * If a non-blocking data stream is required passed
 * VIR_STREAM_NONBLOCK for flags, otherwise pass 0.
 *
 * Returns the new stream, or NULL upon error
 */
virStreamPtr
virStreamNew(virConnectPtr conn,
             unsigned int flags)
{
    virStreamPtr st;

    DEBUG("conn=%p, flags=%u", conn, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10706
        virDispatchError(NULL);
10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733
        return (NULL);
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;

    return st;
}


/**
 * virStreamRef:
 * @stream: pointer to the stream
 *
 * Increment the reference count on the stream. For each
 * additional call to this method, there shall be a corresponding
 * call to virStreamFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * Returns 0 in case of success, -1 in case of failure
 */
int
virStreamRef(virStreamPtr stream)
{
    if ((!VIR_IS_CONNECTED_STREAM(stream))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
10734
        virDispatchError(NULL);
10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753
        return(-1);
    }
    virMutexLock(&stream->conn->lock);
    DEBUG("stream=%p refs=%d", stream, stream->refs);
    stream->refs++;
    virMutexUnlock(&stream->conn->lock);
    return 0;
}


/**
 * virStreamSend:
 * @stream: pointer to the stream object
 * @data: buffer to write to stream
 * @nbytes: size of @data buffer
 *
 * Write a series of bytes to the stream. This method may
 * block the calling application for an arbitrary amount
 * of time. Once an application has finished sending data
10754
 * it should call virStreamFinish to wait for successful
10755 10756 10757 10758 10759 10760 10761 10762 10763
 * confirmation from the driver, or detect any error
 *
 * This method may not be used if a stream source has been
 * registered
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
10764
 * An example using this with a hypothetical file upload
10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818
 * API looks like
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_RDONLY)
 *
 *   virConnectUploadFile(conn, "demo.iso", st);
 *
 *   while (1) {
 *       char buf[1024];
 *       int got = read(fd, buf, 1024);
 *       if (got < 0) {
 *          virStreamAbort(st);
 *          break;
 *       }
 *       if (got == 0) {
 *          virStreamFinish(st);
 *          break;
 *       }
 *       int offset = 0;
 *       while (offset < got) {
 *          int sent = virStreamSend(st, buf+offset, got-offset)
 *          if (sent < 0) {
 *             virStreamAbort(st);
 *             goto done;
 *          }
 *          offset += sent;
 *       }
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ... report an error ....
 * done:
 *   virStreamFree(st);
 *   close(fd);
 *
 * Returns the number of bytes written, which may be less
 * than requested.
 *
 * Returns -1 upon error, at which time the stream will
 * be marked as aborted, and the caller should now release
 * the stream with virStreamFree.
 *
 * Returns -2 if the outgoing transmit buffers are full &
 * the stream is marked as non-blocking.
 */
int virStreamSend(virStreamPtr stream,
                  const char *data,
                  size_t nbytes)
{
    DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10819
        virDispatchError(NULL);
10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamSend) {
        int ret;
        ret = (stream->driver->streamSend)(stream, data, nbytes);
        if (ret == -2)
            return -2;
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10837
    virDispatchError(stream->conn);
10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855
    return -1;
}


/**
 * virStreamRecv:
 * @stream: pointer to the stream object
 * @data: buffer to write to stream
 * @nbytes: size of @data buffer
 *
 * Write a series of bytes to the stream. This method may
 * block the calling application for an arbitrary amount
 * of time.
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
10856
 * An example using this with a hypothetical file download
10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913
 * API looks like
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_WRONLY, 0600)
 *
 *   virConnectDownloadFile(conn, "demo.iso", st);
 *
 *   while (1) {
 *       char buf[1024];
 *       int got = virStreamRecv(st, buf, 1024);
 *       if (got < 0)
 *          break;
 *       if (got == 0) {
 *          virStreamFinish(st);
 *          break;
 *       }
 *       int offset = 0;
 *       while (offset < got) {
 *          int sent = write(fd, buf+offset, got-offset)
 *          if (sent < 0) {
 *             virStreamAbort(st);
 *             goto done;
 *          }
 *          offset += sent;
 *       }
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ... report an error ....
 * done:
 *   virStreamFree(st);
 *   close(fd);
 *
 *
 * Returns the number of bytes read, which may be less
 * than requested.
 *
 * Returns 0 when the end of the stream is reached, at
 * which time the caller should invoke virStreamFinish()
 * to get confirmation of stream completion.
 *
 * Returns -1 upon error, at which time the stream will
 * be marked as aborted, and the caller should now release
 * the stream with virStreamFree.
 *
 * Returns -2 if there is no data pending to be read & the
 * stream is marked as non-blocking.
 */
int virStreamRecv(virStreamPtr stream,
                  char *data,
                  size_t nbytes)
{
    DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10914
        virDispatchError(NULL);
10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamRecv) {
        int ret;
        ret = (stream->driver->streamRecv)(stream, data, nbytes);
        if (ret == -2)
            return -2;
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
10932
    virDispatchError(stream->conn);
10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946
    return -1;
}


/**
 * virStreamSendAll:
 * @stream: pointer to the stream object
 * @handler: source callback for reading data from application
 * @opaque: application defined data
 *
 * Send the entire data stream, reading the data from the
 * requested data source. This is simply a convenient alternative
 * to virStreamSend, for apps that do blocking-I/o.
 *
D
Dan Kenigsberg 已提交
10947
 * An example using this with a hypothetical file upload
10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968
 * API looks like
 *
 *   int mysource(virStreamPtr st, char *buf, int nbytes, void *opaque) {
 *       int *fd = opaque;
 *
 *       return read(*fd, buf, nbytes);
 *   }
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_RDONLY)
 *
 *   virConnectUploadFile(conn, st);
 *   if (virStreamSendAll(st, mysource, &fd) < 0) {
 *      ...report an error ...
 *      goto done;
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ...report an error...
 *   virStreamFree(st);
 *   close(fd);
 *
10969
 * Returns 0 if all the data was successfully sent. The caller
10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989
 * should invoke virStreamFinish(st) to flush the stream upon
 * success and then virStreamFree
 *
 * Returns -1 upon any error, with virStreamAbort() already
 * having been called,  so the caller need only call
 * virStreamFree()
 */
int virStreamSendAll(virStreamPtr stream,
                     virStreamSourceFunc handler,
                     void *opaque)
{
    char *bytes = NULL;
    int want = 1024*64;
    int ret = -1;
    DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
10990
        virDispatchError(NULL);
10991 10992 10993 10994 10995 10996 10997 10998 10999 11000
        return (-1);
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
        virLibConnError(NULL, VIR_ERR_OPERATION_INVALID,
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
11001
        virReportOOMError();
11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027
        goto cleanup;
    }

    for (;;) {
        int got, offset = 0;
        got = (handler)(stream, bytes, want, opaque);
        if (got < 0) {
            virStreamAbort(stream);
            goto cleanup;
        }
        if (got == 0)
            break;
        while (offset < got) {
            int done;
            done = virStreamSend(stream, bytes + offset, got - offset);
            if (done < 0)
                goto cleanup;
            offset += done;
        }
    }
    ret = 0;

cleanup:
    VIR_FREE(bytes);

    if (ret != 0)
11028
        virDispatchError(stream->conn);
11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043

    return ret;
}


/**
 * virStreamRecvAll:
 * @stream: pointer to the stream object
 * @handler: sink callback for writing data to application
 * @opaque: application defined data
 *
 * Receive the entire data stream, sending the data to the
 * requested data sink. This is simply a convenient alternative
 * to virStreamRecv, for apps that do blocking-I/o.
 *
D
Dan Kenigsberg 已提交
11044
 * An example using this with a hypothetical file download
11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065
 * API looks like
 *
 *   int mysink(virStreamPtr st, const char *buf, int nbytes, void *opaque) {
 *       int *fd = opaque;
 *
 *       return write(*fd, buf, nbytes);
 *   }
 *
 *   virStreamPtr st = virStreamNew(conn, 0);
 *   int fd = open("demo.iso", O_WRONLY)
 *
 *   virConnectUploadFile(conn, st);
 *   if (virStreamRecvAll(st, mysink, &fd) < 0) {
 *      ...report an error ...
 *      goto done;
 *   }
 *   if (virStreamFinish(st) < 0)
 *      ...report an error...
 *   virStreamFree(st);
 *   close(fd);
 *
11066
 * Returns 0 if all the data was successfully received. The caller
11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086
 * should invoke virStreamFinish(st) to flush the stream upon
 * success and then virStreamFree
 *
 * Returns -1 upon any error, with virStreamAbort() already
 * having been called,  so the caller need only call
 * virStreamFree()
 */
int virStreamRecvAll(virStreamPtr stream,
                     virStreamSinkFunc handler,
                     void *opaque)
{
    char *bytes = NULL;
    int want = 1024*64;
    int ret = -1;
    DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11087
        virDispatchError(NULL);
11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098
        return (-1);
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
        virLibConnError(NULL, VIR_ERR_OPERATION_INVALID,
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
11099
        virReportOOMError();
11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125
        goto cleanup;
    }

    for (;;) {
        int got, offset = 0;
        got = virStreamRecv(stream, bytes, want);
        if (got < 0)
            goto cleanup;
        if (got == 0)
            break;
        while (offset < got) {
            int done;
            done = (handler)(stream, bytes + offset, got - offset, opaque);
            if (done < 0) {
                virStreamAbort(stream);
                goto cleanup;
            }
            offset += done;
        }
    }
    ret = 0;

cleanup:
    VIR_FREE(bytes);

    if (ret != 0)
11126
        virDispatchError(stream->conn);
11127 11128 11129 11130 11131 11132

    return ret;
}


/**
M
Matthias Bolte 已提交
11133
 * virStreamEventAddCallback:
11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158
 * @stream: pointer to the stream object
 * @events: set of events to monitor
 * @cb: callback to invoke when an event occurs
 * @opaque: application defined data
 * @ff: callback to free @opaque data
 *
 * Register a callback to be notified when a stream
 * becomes writable, or readable. This is most commonly
 * used in conjunction with non-blocking data streams
 * to integrate into an event loop
 *
 * Returns 0 on success, -1 upon error
 */
int virStreamEventAddCallback(virStreamPtr stream,
                              int events,
                              virStreamEventCallback cb,
                              void *opaque,
                              virFreeCallback ff)
{
    DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11159
        virDispatchError(NULL);
11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
11175
    virDispatchError(stream->conn);
11176 11177 11178 11179 11180
    return -1;
}


/**
M
Matthias Bolte 已提交
11181
 * virStreamEventUpdateCallback:
11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200
 * @stream: pointer to the stream object
 * @events: set of events to monitor
 *
 * Changes the set of events to monitor for a stream. This allows
 * for event notification to be changed without having to
 * unregister & register the callback completely. This method
 * is guarenteed to succeed if a callback is already registered
 *
 * Returns 0 on success, -1 if no callback is registered
 */
int virStreamEventUpdateCallback(virStreamPtr stream,
                                 int events)
{
    DEBUG("stream=%p, events=%d", stream, events);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11201
        virDispatchError(NULL);
11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
11217
    virDispatchError(stream->conn);
11218 11219 11220 11221
    return -1;
}

/**
M
Matthias Bolte 已提交
11222
 * virStreamEventRemoveCallback:
11223 11224
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
11225
 * Remove an event callback from the stream
11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11237
        virDispatchError(NULL);
11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
11253
    virDispatchError(stream->conn);
11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279
    return -1;
}

/**
 * virStreamFinish:
 * @stream: pointer to the stream object
 *
 * Indicate that there is no further data is to be transmitted
 * on the stream. For output streams this should be called once
 * all data has been written. For input streams this should be
 * called once virStreamRecv returns end-of-file.
 *
 * This method is a synchronization point for all asynchronous
 * errors, so if this returns a success code the application can
 * be sure that all data has been successfully processed.
 *
 * Returns 0 on success, -1 upon error
 */
int virStreamFinish(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11280
        virDispatchError(NULL);
11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
11296
    virDispatchError(stream->conn);
11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320
    return -1;
}

/**
 * virStreamAbort:
 * @stream: pointer to the stream object
 *
 * Request that the in progress data transfer be cancelled
 * abnormally before the end of the stream has been reached.
 * For output streams this can be used to inform the driver
 * that the stream is being terminated early. For input
 * streams this can be used to inform the driver that it
 * should stop sending data.
 *
 * Returns 0 on success, -1 upon error
 */
int virStreamAbort(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11321
        virDispatchError(NULL);
11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336
        return (-1);
    }

    if (stream->driver &&
        stream->driver->streamAbort) {
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (stream->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
11337
    virDispatchError(stream->conn);
11338 11339 11340 11341 11342 11343 11344 11345 11346 11347
    return -1;
}

/**
 * virStreamFree:
 * @stream: pointer to the stream object
 *
 * Decrement the reference count on a stream, releasing
 * the stream object if the reference count has hit zero.
 *
D
Dan Kenigsberg 已提交
11348
 * There must not be an active data transfer in progress
11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362
 * when releasing the stream. If a stream needs to be
 * disposed of prior to end of stream being reached, then
 * the virStreamAbort function should be called first.
 *
 * Returns 0 upon success, or -1 on error
 */
int virStreamFree(virStreamPtr stream)
{
    DEBUG("stream=%p", stream);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11363
        virDispatchError(NULL);
11364 11365 11366 11367 11368
        return (-1);
    }

    /* XXX Enforce shutdown before free'ing resources ? */

11369 11370
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
11371
        return (-1);
11372
    }
11373 11374
    return (0);
}
11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392


/**
 * virDomainIsActive:
 * @dom: pointer to the domain object
 *
 * Determine if the domain is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virDomainIsActive(virDomainPtr dom)
{
    DEBUG("dom=%p", dom);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11393
        virDispatchError(NULL);
11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405
        return (-1);
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11406
    virDispatchError(dom->conn);
11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426
    return -1;
}

/**
 * virDomainIsPersistent:
 * @dom: pointer to the domain object
 *
 * Determine if the domain has a persistent configuration
 * which means it will still exist after shutting down
 *
 * Returns 1 if persistent, 0 if transient, -1 on error
 */
int virDomainIsPersistent(virDomainPtr dom)
{
    DEBUG("dom=%p", dom);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11427
        virDispatchError(NULL);
11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439
        return (-1);
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11440
    virDispatchError(dom->conn);
11441 11442 11443
    return -1;
}

11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476
/**
 * virDomainIsUpdated:
 * @dom: pointer to the domain object
 *
 * Determine if the domain has been updated.
 *
 * Returns 1 if updated, 0 if not, -1 on error
 */
int virDomainIsUpdated(virDomainPtr dom)
{
    DEBUG("dom=%p", dom);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(dom->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(dom->conn);
    return -1;
}

11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492
/**
 * virNetworkIsActive:
 * @net: pointer to the network object
 *
 * Determine if the network is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virNetworkIsActive(virNetworkPtr net)
{
    DEBUG("net=%p", net);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11493
        virDispatchError(NULL);
11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505
        return (-1);
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(net->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11506
    virDispatchError(net->conn);
11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527
    return -1;
}


/**
 * virNetworkIsPersistent:
 * @net: pointer to the network object
 *
 * Determine if the network has a persistent configuration
 * which means it will still exist after shutting down
 *
 * Returns 1 if persistent, 0 if transient, -1 on error
 */
int virNetworkIsPersistent(virNetworkPtr net)
{
    DEBUG("net=%p", net);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11528
        virDispatchError(NULL);
11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540
        return (-1);
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(net->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11541
    virDispatchError(net->conn);
11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561
    return -1;
}


/**
 * virStoragePoolIsActive:
 * @pool: pointer to the storage pool object
 *
 * Determine if the storage pool is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virStoragePoolIsActive(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11562
        virDispatchError(NULL);
11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574
        return (-1);
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11575
    virDispatchError(pool->conn);
11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596
    return -1;
}


/**
 * virStoragePoolIsPersistent:
 * @pool: pointer to the storage pool object
 *
 * Determine if the storage pool has a persistent configuration
 * which means it will still exist after shutting down
 *
 * Returns 1 if persistent, 0 if transient, -1 on error
 */
int virStoragePoolIsPersistent(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
11597
        virDispatchError(NULL);
11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609
        return (-1);
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
11610
    virDispatchError(pool->conn);
11611 11612 11613 11614
    return -1;
}


S
Stefan Berger 已提交
11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781

/**
 * virConnectNumOfNWFilters:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of nwfilters.
 *
 * Returns the number of nwfilters found or -1 in case of error
 */
int
virConnectNumOfNWFilters(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->numOfNWFilters) {
        int ret;
        ret = conn->nwfilterDriver->numOfNWFilters (conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}


/**
 * virConnectListNWFilters:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of network filters
 * @maxnames: size of @names
 *
 * Collect the list of network filters, and store their names in @names
 *
 * Returns the number of network filters found or -1 in case of error
 */
int
virConnectListNWFilters(virConnectPtr conn, char **const names, int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->listNWFilters) {
        int ret;
        ret = conn->nwfilterDriver->listNWFilters (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}


/**
 * virNWFilterLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the network filter
 *
 * Try to lookup a network filter on the given hypervisor based on its name.
 *
 * Returns a new nwfilter object or NULL in case of failure.  If the
 * network filter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
 */
virNWFilterPtr
virNWFilterLookupByName(virConnectPtr conn, const char *name)
{
    DEBUG("conn=%p, name=%s", conn, name);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virNWFilterLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the network filter
 *
 * Try to lookup a network filter on the given hypervisor based on its UUID.
 *
 * Returns a new nwfilter object or NULL in case of failure.  If the
 * nwfdilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
 */
virNWFilterPtr
virNWFilterLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
    DEBUG("conn=%p, uuid=%s", conn, uuid);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}

/**
11782
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120
 * @conn: pointer to the hypervisor connection
 * @uuidstr: the string UUID for the nwfilter
 *
 * Try to lookup an nwfilter on the given hypervisor based on its UUID.
 *
 * Returns a new nwfilter object or NULL in case of failure.  If the
 * nwfilter cannot be found, then VIR_ERR_NO_NWFILTER error is raised.
 */
virNWFilterPtr
virNWFilterLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    return virNWFilterLookupByUUID(conn, &uuid[0]);

error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virNWFilterFree:
 * @nwfilter: a nwfilter object
 *
 * Free the nwfilter object. The running instance is kept alive.
 * The data structure is freed and should not be used thereafter.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNWFilterFree(virNWFilterPtr nwfilter)
{
    DEBUG("nwfilter=%p", nwfilter);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefNWFilter(nwfilter) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}

/**
 * virNWFilterGetName:
 * @nwfilter: a nwfilter object
 *
 * Get the public name for the network filter
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * its lifetime will be the same as the nwfilter object.
 */
const char *
virNWFilterGetName(virNWFilterPtr nwfilter)
{
    DEBUG("nwfilter=%p", nwfilter);

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    return (nwfilter->name);
}

/**
 * virNWFilterGetUUID:
 * @nwfilter: a nwfilter object
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
 *
 * Get the UUID for a network filter
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNWFilterGetUUID(virNWFilterPtr nwfilter, unsigned char *uuid)
{
    DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
        virLibNWFilterError(nwfilter, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    memcpy(uuid, &nwfilter->uuid[0], VIR_UUID_BUFLEN);

    return 0;

error:
    virDispatchError(nwfilter->conn);
    return -1;
}

/**
 * virNWFilterGetUUIDString:
 * @nwfilter: a nwfilter object
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
 *
 * Get the UUID for a network filter as string. For more information about
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virNWFilterGetUUIDString(virNWFilterPtr nwfilter, char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
        virLibNWFilterError(nwfilter, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (virNWFilterGetUUID(nwfilter, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
    return 0;

error:
    virDispatchError(nwfilter->conn);
    return -1;
}


/**
 * virNWFilterDefineXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: an XML description of the nwfilter
 *
 * Define a new network filter, based on an XML description
 * similar to the one returned by virNWFilterGetXMLDesc()
 *
 * Returns a new nwfilter object or NULL in case of failure
 */
virNWFilterPtr
virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc)
{
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc, 0);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}


/**
 * virNWFilterUndefine:
 * @nwfilter: a nwfilter object
 *
 * Undefine the nwfilter object. This call will not succeed if
 * a running VM is referencing the filter. This does not free the
 * associated virNWFilterPtr object.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNWFilterUndefine(virNWFilterPtr nwfilter)
{
    virConnectPtr conn;
    DEBUG("nwfilter=%p", nwfilter);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNWFilterError(nwfilter, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(nwfilter->conn);
    return -1;
}


/**
 * virNWFilterGetXMLDesc:
 * @nwfilter: a nwfilter object
 * @flags: an OR'ed set of extraction flags, not used yet
 *
 * Provide an XML description of the network filter. The description may be
 * reused later to redefine the network filter with virNWFilterCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, int flags)
{
    virConnectPtr conn;
    DEBUG("nwfilter=%p, flags=%d", nwfilter, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
        virLibNWFilterError(NULL, VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }
    if (flags != 0) {
        virLibNWFilterError(nwfilter, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = nwfilter->conn;

    if (conn->nwfilterDriver && conn->nwfilterDriver->getXMLDesc) {
        char *ret;
        ret = conn->nwfilterDriver->getXMLDesc (nwfilter, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(nwfilter->conn);
    return NULL;
}


/**
 * virNWFilterRef:
 * @nwfilter: the nwfilter to hold a reference on
 *
 * Increment the reference count on the nwfilter. For each
 * additional call to this method, there shall be a corresponding
 * call to virNWFilterFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using an nwfilter would increment
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virNWFilterRef(virNWFilterPtr nwfilter)
{
    if ((!VIR_IS_CONNECTED_NWFILTER(nwfilter))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
    DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136
/**
 * virInterfaceIsActive:
 * @iface: pointer to the interface object
 *
 * Determine if the interface is currently running
 *
 * Returns 1 if running, 0 if inactive, -1 on error
 */
int virInterfaceIsActive(virInterfacePtr iface)
{
    DEBUG("iface=%p", iface);

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
12137
        virDispatchError(NULL);
12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149
        return (-1);
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(iface->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
12150
    virDispatchError(iface->conn);
12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170
    return -1;
}


/**
 * virConnectIsEncrypted:
 * @conn: pointer to the connection object
 *
 * Determine if the connection to the hypervisor is encrypted
 *
 * Returns 1 if encrypted, 0 if not encrypted, -1 on error
 */
int virConnectIsEncrypted(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
12171
        virDispatchError(NULL);
12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183
        return (-1);
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
12184
    virDispatchError(conn);
12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207
    return -1;
}

/**
 * virConnectIsSecure:
 * @conn: pointer to the connection object
 *
 * Determine if the connection to the hypervisor is secure
 *
 * A connection will be classed as secure if it is either
 * encrypted, or running over a channel which is not exposed
 * to eavesdropping (eg a UNIX domain socket, or pipe)
 *
 * Returns 1 if secure, 0 if secure, -1 on error
 */
int virConnectIsSecure(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
12208
        virDispatchError(NULL);
12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220
        return (-1);
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
12221
    virDispatchError(conn);
12222 12223
    return -1;
}
J
Jiri Denemark 已提交
12224 12225 12226 12227 12228


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
12229 12230 12231 12232
 * @xmlDesc: XML describing the CPU to compare with host CPU
 * @flags: currently unused, pass 0
 *
 * Compares the given CPU description with the host CPU
J
Jiri Denemark 已提交
12233 12234 12235 12236 12237 12238 12239 12240
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
12241
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%u", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
12242 12243 12244 12245 12246

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
12247
        virDispatchError(NULL);
J
Jiri Denemark 已提交
12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->cpuCompare) {
        int ret;

        ret = conn->driver->cpuCompare(conn, xmlDesc, flags);
        if (ret == VIR_CPU_COMPARE_ERROR)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
12267
    virDispatchError(conn);
J
Jiri Denemark 已提交
12268 12269
    return VIR_CPU_COMPARE_ERROR;
}
12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326


/**
 * virConnectBaselineCPU:
 *
 * @conn: virConnect connection
 * @xmlCPUs: array of XML descriptions of host CPUs
 * @ncpus: number of CPUs in xmlCPUs
 * @flags: fine-tuning flags, currently unused, pass 0.
 *
 * Computes the most feature-rich CPU which is compatible with all given
 * host CPUs.
 *
 * Returns XML description of the computed CPU or NULL on error.
 */
char *
virConnectBaselineCPU(virConnectPtr conn,
                      const char **xmlCPUs,
                      unsigned int ncpus,
                      unsigned int flags)
{
    unsigned int i;

    VIR_DEBUG("conn=%p, xmlCPUs=%p, ncpus=%u, flags=%u",
              conn, xmlCPUs, ncpus, flags);
    if (xmlCPUs) {
        for (i = 0; i < ncpus; i++)
            VIR_DEBUG("xmlCPUs[%u]=%s", i, NULLSTR(xmlCPUs[i]));
    }

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}
12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374


/**
 * virDomainGetJobInfo:
 * @domain: a domain object
 * @info: pointer to a virDomainJobInfo structure allocated by the user
 *
 * Extract information about progress of a background job on a domain.
 * Will return an error if the domain is not active.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("domain=%p, info=%p", domain, info);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    memset(info, 0, sizeof(virDomainJobInfo));

    conn = domain->conn;

    if (conn->driver->domainGetJobInfo) {
        int ret;
        ret = conn->driver->domainGetJobInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(domain->conn);
    return -1;
}
12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421


/**
 * virDomainAbortJob:
 * @domain: a domain object
 *
 * Requests that the current background job be aborted at the
 * soonest opportunity. This will block until the job has
 * either completed, or aborted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainAbortJob(virDomainPtr domain)
{
    virConnectPtr conn;

    DEBUG("domain=%p", domain);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainAbortJob) {
        int ret;
        ret = conn->driver->domainAbortJob(domain);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}
12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465


/**
 * virDomainMigrateSetMaxDowntime:
 * @domain: a domain object
 * @downtime: maximum tolerable downtime for live migration, in milliseconds
 * @flags: fine-tuning flags, currently unused, use 0
 *
 * Sets maximum tolerable time for which the domain is allowed to be paused
 * at the end of live migration. It's supposed to be called while the domain is
 * being live-migrated as a reaction to migration progress.
 *
 * Returns 0 in case of success, -1 otherwise.
 */
int
virDomainMigrateSetMaxDowntime(virDomainPtr domain,
                               unsigned long long downtime,
                               unsigned int flags)
{
    virConnectPtr conn;

    DEBUG("domain=%p, downtime=%llu, flags=%u", domain, downtime, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virConnectDomainEventRegisterAny:
 * @conn: pointer to the connection
 * @dom: pointer to the domain
 * @eventID: the event type to receive
 * @cb: callback to the function handling domain events
 * @opaque: opaque data to pass on to the callback
 * @freecb: optional function to deallocate opaque when not used anymore
 *
 * Adds a callback to receive notifications of arbitrary domain events
 * occurring on a domain.
 *
 * If dom is NULL, then events will be monitored for any domain. If dom
 * is non-NULL, then only the specific domain will be monitored
 *
 * Most types of event have a callback providing a custom set of parameters
 * for the event. When registering an event, it is thus neccessary to use
 * the VIR_DOMAIN_EVENT_CALLBACK() macro to cast the supplied function pointer
 * to match the signature of this method.
 *
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
 * If the callback wishes to keep the domain object after the callback
 * returns, it shall take a reference to it, by calling virDomainRef.
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
 * The return value from this method is a positive integer identifier
 * for the callback. To unregister a callback, this callback ID should
 * be passed to the virDomainEventUnregisterAny method
 *
 * Returns a callback identifier on success, -1 on failure
 */
int
virConnectDomainEventRegisterAny(virConnectPtr conn,
                                 virDomainPtr dom,
                                 int eventID,
                                 virConnectDomainEventGenericCallback cb,
                                 void *opaque,
                                 virFreeCallback freecb)
{
    DEBUG("conn=%p dom=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p", conn, dom, eventID, cb, opaque, freecb);
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(conn);
        return (-1);
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if ((conn->driver) && (conn->driver->domainEventRegisterAny)) {
        int ret;
        ret = conn->driver->domainEventRegisterAny(conn, dom, eventID, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}
12544

12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580
/**
 * virConnectDomainEventDeregisterAny:
 * @conn: pointer to the connection
 * @callbackID: the callback identifier
 *
 * Removes an event callback. The callbackID parameter should be the
 * vaule obtained from a previous virDomainEventRegisterAny method.
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregisterAny(virConnectPtr conn,
                                   int callbackID)
{
    DEBUG("conn=%p, callbackID=%d", conn, callbackID);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return (-1);
    }
    if (callbackID < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
12581 12582 12583 12584
error:
    virDispatchError(conn);
    return -1;
}
12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685

/**
 * virDomainManagedSave:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
 * This method will suspend a domain and save its memory contents to
 * a file on disk. After the call, if successful, the domain is not
 * listed as running anymore.
 * The difference from virDomainSave() is that libvirt is keeping track of
 * the saved state itself, and will reuse it once the domain is being
 * restarted (automatically or via an explicit libvirt call).
 * As a result any running domain is sure to not have a managed saved image.
 *
 * Returns 0 in case of success or -1 in case of failure
 */
int virDomainManagedSave(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("dom=%p, flags=%u", dom, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainManagedSave) {
        int ret;

        ret = conn->driver->domainManagedSave(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainHasManagedSaveImage:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
 * Check if a domain has a managed save image as created by
 * virDomainManagedSave(). Note that any running domain should not have
 * such an image, as it should have been removed on restart.
 *
 * Returns 0 if no image is present, 1 if an image is present, and
 *         -1 in case of error
 */
int virDomainHasManagedSaveImage(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("dom=%p, flags=%u", dom, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;

    if (conn->driver->domainHasManagedSaveImage) {
        int ret;

        ret = conn->driver->domainHasManagedSaveImage(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
12686
 * Remove any managed save image for this domain.
12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("dom=%p, flags=%u", dom, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainManagedSaveRemove) {
        int ret;

        ret = conn->driver->domainManagedSaveRemove(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039

/**
 * virDomainSnapshotCreateXML:
 * @domain: a domain object
 * @xmlDesc: string containing an XML description of the domain
 * @flags: unused flag parameters; callers should pass 0
 *
 * Creates a new snapshot of a domain based on the snapshot xml
 * contained in xmlDesc.
 *
 * Returns an (opaque) virDomainSnapshotPtr on success, NULL on failure.
 */
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
                           const char *xmlDesc,
                           unsigned int flags)
{
    virConnectPtr conn;

    DEBUG("domain=%p, xmlDesc=%s, flags=%u", domain, xmlDesc, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainSnapshotCreateXML) {
        virDomainSnapshotPtr ret;
        ret = conn->driver->domainSnapshotCreateXML(domain, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotGetXMLDesc:
 * @snapshot: a domain snapshot object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Provide an XML description of the domain snapshot.
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,
                            unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("snapshot=%p, flags=%d", snapshot, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(NULL, VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

    if (conn->driver->domainSnapshotDumpXML) {
        char *ret;
        ret = conn->driver->domainSnapshotDumpXML(snapshot, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotNum:
 * @domain: a domain object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Provides the number of domain snapshots for this domain..
 *
 * Returns the number of domain snapshost found or -1 in case of error.
 */
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p", domain);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->driver->domainSnapshotNum) {
        int ret = conn->driver->domainSnapshotNum(domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotListNames:
 * @domain: a domain object
 * @names: array to collect the list of names of snapshots
 * @nameslen: size of @names
 * @flags: unused flag parameters; callers should pass 0
 *
 * Collect the list of domain snapshots for the given domain, and store
 * their names in @names.  Caller is responsible for freeing each member
 * of the array.
 *
 * Returns the number of domain snapshots found or -1 in case of error.
 */
int
virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen,
                           unsigned int flags)
{
    virConnectPtr conn;

    DEBUG("domain=%p, names=%p, nameslen=%d, flags=%u",
          domain, names, nameslen, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainSnapshotListNames) {
        int ret = conn->driver->domainSnapshotListNames(domain, names,
                                                        nameslen, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotLookupByName:
 * @domain: a domain object
 * @name: name for the domain snapshot
 * @flags: unused flag parameters; callers should pass 0
 *
 * Try to lookup a domain snapshot based on its name.
 *
 * Returns a domain snapshot object or NULL in case of failure.  If the
 * domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
 * error is raised.
 */
virDomainSnapshotPtr
virDomainSnapshotLookupByName(virDomainPtr domain,
                              const char *name,
                              unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, name=%s, flags=%u", domain, name, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }

    conn = domain->conn;

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainSnapshotLookupByName) {
        virDomainSnapshotPtr dom;
        dom = conn->driver->domainSnapshotLookupByName(domain, name, flags);
        if (!dom)
            goto error;
        return dom;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainHasCurrentSnapshot:
 * @domain: pointer to the domain object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Determine if the domain has a current snapshot.
 *
 * Returns 1 if such snapshot exists, 0 if it doesn't, -1 on error.
 */
int
virDomainHasCurrentSnapshot(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, flags=%u", domain, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if (conn->driver->domainHasCurrentSnapshot) {
        int ret = conn->driver->domainHasCurrentSnapshot(domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotCurrent:
 * @domain: a domain object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Get the current snapshot for a domain, if any.
 *
 * Returns a domain snapshot object or NULL in case of failure.  If the
 * current domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
 * error is raised.
 */
virDomainSnapshotPtr
virDomainSnapshotCurrent(virDomainPtr domain,
                         unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("domain=%p, flags=%u", domain, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return (NULL);
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return NULL;
}

/**
13040
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080
 * @snapshot: a domain snapshot object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Revert the domain to a given snapshot.
 *
 * Returns 0 if the creation is successful, -1 on error.
 */
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
                          unsigned int flags)
{
    virConnectPtr conn;

    DEBUG("snapshot=%p, flags=%u", snapshot, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(NULL, VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;

    if (conn->driver->domainRevertToSnapshot) {
        int ret = conn->driver->domainRevertToSnapshot(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
13081
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153
 * @snapshot: a domain snapshot object
 * @flags: flag parameters
 *
 * Delete the snapshot.
 *
 * If @flags is 0, then just this snapshot is deleted, and changes from
 * this snapshot are automatically merged into children snapshots.  If
 * flags is VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN, then this snapshot
 * and any children snapshots are deleted.
 *
 * Returns 0 if the snapshot was successfully deleted, -1 on error.
 */
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
                        unsigned int flags)
{
    virConnectPtr conn;

    DEBUG("snapshot=%p, flags=%u", snapshot, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(NULL, VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;

    if (conn->driver->domainSnapshotDelete) {
        int ret = conn->driver->domainSnapshotDelete(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotFree:
 * @snapshot: a domain snapshot object
 *
 * Free the domain snapshot object.  The snapshot itself is not modified.
 * The data structure is freed and should not be used thereafter.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSnapshotFree(virDomainSnapshotPtr snapshot)
{
    DEBUG("snapshot=%p", snapshot);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(NULL, VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206

/**
 * virDomainOpenConsole:
 * @dom: a domain object
 * @devname: the console, serial or parallel port device alias, or NULL
 * @st: a stream to associate with the console
 * @flags: unused, pass 0
 *
 * This opens the backend associated with a console, serial or
 * parallel port device on a guest, if the backend is supported.
 * If the @devname is omitted, then the first console or serial
 * device is opened. The console is associated with the passed
 * in @st stream, which should have been opened in non-blocking
 * mode for bi-directional I/O.
 *
 * returns 0 if the console was opened, -1 on error
 */
int virDomainOpenConsole(virDomainPtr dom,
                         const char *devname,
                         virStreamPtr st,
                         unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("dom=%p devname=%s, st=%p flags=%u", dom, NULLSTR(devname), st, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
        ret = conn->driver->domainOpenConsole(dom, devname, st, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}