libvirt.c 457.1 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-2011 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>
E
Eric Blake 已提交
20
#include <sys/wait.h>
21
#include <time.h>
D
Daniel P. Berrange 已提交
22
#include <gcrypt.h>
23

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

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

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

38
#include "uuid.h"
39
#include "util.h"
40
#include "memory.h"
41
#include "configmake.h"
42
#include "intprops.h"
43
#include "rpc/virnettlscontext.h"
44

45
#ifndef WITH_DRIVER_MODULES
46 47 48 49 50 51 52 53 54 55 56 57
# 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
58 59 60
# ifdef WITH_VMWARE
#  include "vmware/vmware_driver.h"
# endif
61 62 63 64 65 66 67 68 69
# 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
M
Matthias Bolte 已提交
70 71 72
# ifdef WITH_HYPERV
#  include "hyperv/hyperv_driver.h"
# endif
73 74 75
# ifdef WITH_XENAPI
#  include "xenapi/xenapi_driver.h"
# endif
76
#endif
77

78 79
#define VIR_FROM_THIS VIR_FROM_NONE

D
Daniel Veillard 已提交
80 81 82
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
D
Daniel Veillard 已提交
83
 * - use reference counting to guarantee coherent pointer state ?
D
Daniel Veillard 已提交
84 85
 */

86
#define MAX_DRIVERS 20
87

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

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 134 135 136 137 138 139 140
#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

141 142 143 144 145 146 147 148
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;
149
        size_t len;
150 151

        switch (cred[i].type) {
152 153 154 155
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

156
#if defined(POLKIT_AUTH)
157
            if (virConnectAuthGainPolkit(cred[i].prompt) < 0)
158
                return -1;
159 160 161 162 163 164 165
#else
            /*
             * Ignore & carry on. Although we can't auth
             * directly, the user may have authenticated
             * themselves already outside context of libvirt
             */
#endif
166 167
            break;
        }
168

169 170 171 172
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
173
            if (printf("%s: ", cred[i].prompt) < 0)
174 175 176 177
                return -1;
            if (fflush(stdout) != 0)
                return -1;

178 179 180 181 182 183 184
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
185 186 187
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
188 189 190 191
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
192
            if (printf("%s: ", cred[i].prompt) < 0)
193 194 195 196
                return -1;
            if (fflush(stdout) != 0)
                return -1;

197 198 199 200
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
201 202 203

        default:
            return -1;
204 205
        }

D
Daniel P. Berrange 已提交
206 207 208 209 210 211 212 213 214
        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);
        }
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    }

    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,
230
    VIR_CRED_EXTERNAL,
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
};

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;

252 253 254 255 256 257 258 259 260 261
#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 已提交
262
    return err == 0 ? 0 : -1;
263 264 265
}
#endif

D
Daniel P. Berrange 已提交
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 298 299 300 301 302 303 304
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 = {
305 306
    /* GCRY_THREAD_OPTION_VERSION was added in gcrypt 1.4.2 */
#ifdef GCRY_THREAD_OPTION_VERSION
D
Daniel P. Berrange 已提交
307
    (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8)),
308 309 310
#else
    GCRY_THREAD_OPTION_PTHREAD,
#endif
D
Daniel P. Berrange 已提交
311 312 313 314 315 316 317 318
    NULL,
    virTLSMutexInit,
    virTLSMutexDestroy,
    virTLSMutexLock,
    virTLSMutexUnlock,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
};

319
/* Helper macros to implement VIR_DOMAIN_DEBUG using just C99.  This
320
 * assumes you pass fewer than 15 arguments to VIR_DOMAIN_DEBUG, but
321 322 323 324 325 326
 * can easily be expanded if needed.
 *
 * Note that gcc provides extensions of "define a(b...) b" or
 * "define a(b,...) b,##__VA_ARGS__" as a means of eliding a comma
 * when no var-args are present, but we don't want to require gcc.
 */
327 328
#define VIR_ARG15(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, ...) _15
#define VIR_HAS_COMMA(...) VIR_ARG15(__VA_ARGS__, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0)
329 330 331 332 333 334 335 336 337 338 339

/* Form the name VIR_DOMAIN_DEBUG_[01], then call that macro,
 * according to how many arguments are present.  Two-phase due to
 * macro expansion rules.  */
#define VIR_DOMAIN_DEBUG_EXPAND(a, b, ...)      \
    VIR_DOMAIN_DEBUG_PASTE(a, b, __VA_ARGS__)
#define VIR_DOMAIN_DEBUG_PASTE(a, b, ...)       \
    a##b(__VA_ARGS__)

/* Internal use only, when VIR_DOMAIN_DEBUG has one argument.  */
#define VIR_DOMAIN_DEBUG_0(dom)                 \
E
Eric Blake 已提交
340
    VIR_DOMAIN_DEBUG_2(dom, "%s", "")
341 342

/* Internal use only, when VIR_DOMAIN_DEBUG has three or more arguments.  */
E
Eric Blake 已提交
343 344 345 346 347
#define VIR_DOMAIN_DEBUG_1(dom, fmt, ...)       \
    VIR_DOMAIN_DEBUG_2(dom, ", " fmt, __VA_ARGS__)

/* Internal use only, with final format.  */
#define VIR_DOMAIN_DEBUG_2(dom, fmt, ...)                               \
348 349 350 351 352 353 354 355 356 357 358
    do {                                                                \
        char _uuidstr[VIR_UUID_STRING_BUFLEN];                          \
        const char *_domname = NULL;                                    \
                                                                        \
        if (!VIR_IS_DOMAIN(dom)) {                                      \
            memset(_uuidstr, 0, sizeof(_uuidstr));                      \
        } else {                                                        \
            virUUIDFormat((dom)->uuid, _uuidstr);                       \
            _domname = (dom)->name;                                     \
        }                                                               \
                                                                        \
E
Eric Blake 已提交
359
        VIR_DEBUG("dom=%p, (VM: name=%s, uuid=%s)" fmt,                 \
360 361
                  dom, NULLSTR(_domname), _uuidstr, __VA_ARGS__);       \
    } while (0)
362

363 364 365 366 367 368 369 370 371 372
/**
 * VIR_DOMAIN_DEBUG:
 * @dom: domain
 * @fmt: optional format for additional information
 * @...: optional arguments corresponding to @fmt.
 */
#define VIR_DOMAIN_DEBUG(...)                           \
    VIR_DOMAIN_DEBUG_EXPAND(VIR_DOMAIN_DEBUG_,          \
                            VIR_HAS_COMMA(__VA_ARGS__), \
                            __VA_ARGS__)
D
Daniel P. Berrange 已提交
373

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
/**
 * VIR_UUID_DEBUG:
 * @conn: connection
 * @uuid: possibly null UUID array
 */
#define VIR_UUID_DEBUG(conn, uuid)                              \
    do {                                                        \
        if (uuid) {                                             \
            char _uuidstr[VIR_UUID_STRING_BUFLEN];              \
            virUUIDFormat(uuid, _uuidstr);                      \
            VIR_DEBUG("conn=%p, uuid=%s", conn, _uuidstr);      \
        } else {                                                \
            VIR_DEBUG("conn=%p, uuid=(null)", conn);            \
        }                                                       \
    } while (0)

390 391 392 393 394 395 396
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
397 398 399
 * Calling virInitialize is mandatory, unless your first API call is one of
 * virConnectOpen*.
 *
400 401 402 403 404 405
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
    if (initialized)
406
        return 0;
407

408
    initialized = 1;
409

410
    if (virThreadInitialize() < 0 ||
411 412
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
413 414
        return -1;

D
Daniel P. Berrange 已提交
415 416 417
    gcry_control(GCRYCTL_SET_THREAD_CBS, &virTLSThreadImpl);
    gcry_check_version(NULL);

418
    virLogSetFromEnv();
419

420 421
    virNetTLSInit();

422
    VIR_DEBUG("register drivers");
423

424 425 426 427
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

428
    if (!bindtextdomain(PACKAGE, LOCALEDIR))
429
        return -1;
430

431
    /*
432 433
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
434
     */
435 436 437
#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 已提交
438
     * If they try to open a connection for a module that
439 440
     * is not loaded they'll get a suitable error at that point
     */
441
# ifdef WITH_TEST
442
    virDriverLoadModule("test");
443 444
# endif
# ifdef WITH_XEN
445
    virDriverLoadModule("xen");
446 447
# endif
# ifdef WITH_OPENVZ
448
    virDriverLoadModule("openvz");
449
# endif
450 451 452
# ifdef WITH_VMWARE
    virDriverLoadModule("vmware");
# endif
453
# ifdef WITH_VBOX
454
    virDriverLoadModule("vbox");
455 456
# endif
# ifdef WITH_ESX
457
    virDriverLoadModule("esx");
458
# endif
M
Matthias Bolte 已提交
459 460 461
# ifdef WITH_HYPERV
    virDriverLoadModule("hyperv");
# endif
462
# ifdef WITH_XENAPI
463
    virDriverLoadModule("xenapi");
464 465
# endif
# ifdef WITH_REMOTE
466
    virDriverLoadModule("remote");
467
# endif
468
#else
469
# ifdef WITH_TEST
470
    if (testRegister() == -1) return -1;
471 472
# endif
# ifdef WITH_XEN
473
    if (xenRegister () == -1) return -1;
474 475
# endif
# ifdef WITH_OPENVZ
476
    if (openvzRegister() == -1) return -1;
477
# endif
478 479 480
# ifdef WITH_VMWARE
    if (vmwareRegister() == -1) return -1;
# endif
481
# ifdef WITH_PHYP
482
    if (phypRegister() == -1) return -1;
483 484
# endif
# ifdef WITH_VBOX
485
    if (vboxRegister() == -1) return -1;
486 487
# endif
# ifdef WITH_ESX
488
    if (esxRegister() == -1) return -1;
489
# endif
M
Matthias Bolte 已提交
490 491 492
# ifdef WITH_HYPERV
    if (hypervRegister() == -1) return -1;
# endif
493 494 495
# ifdef WITH_XENAPI
    if (xenapiRegister() == -1) return -1;
# endif
496
# ifdef WITH_REMOTE
497
    if (remoteRegister () == -1) return -1;
498
# endif
499
#endif
D
Daniel P. Berrange 已提交
500

501
    return 0;
502 503
}

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
#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
537

538
#define virLibConnError(code, ...)                                \
539
    virReportErrorHelper(VIR_FROM_NONE, code, __FILE__,           \
540 541
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibDomainError(code, ...)                              \
542
    virReportErrorHelper(VIR_FROM_DOM, code, __FILE__,            \
543 544
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNetworkError(code, ...)                             \
545
    virReportErrorHelper(VIR_FROM_NETWORK, code, __FILE__,        \
546 547
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStoragePoolError(code, ...)                         \
548
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
549 550
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStorageVolError(code, ...)                          \
551
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
552 553
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibInterfaceError(code, ...)                           \
554
    virReportErrorHelper(VIR_FROM_INTERFACE, code, __FILE__,      \
555 556
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNodeDeviceError(code, ...)                          \
557
    virReportErrorHelper(VIR_FROM_NODEDEV, code, __FILE__,        \
558 559
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibSecretError(code, ...)                              \
560
    virReportErrorHelper(VIR_FROM_SECRET, code, __FILE__,         \
561 562
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStreamError(code, ...)                              \
563
    virReportErrorHelper(VIR_FROM_STREAMS, code, __FILE__,        \
564 565
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNWFilterError(code, ...)                            \
566
    virReportErrorHelper(VIR_FROM_NWFILTER, code, __FILE__,       \
567
                         __FUNCTION__, __LINE__, __VA_ARGS__)
568 569
#define virLibDomainSnapshotError(code, ...)                       \
    virReportErrorHelper(VIR_FROM_DOMAIN_SNAPSHOT, code, __FILE__, \
570
                         __FUNCTION__, __LINE__, __VA_ARGS__)
571

C
Chris Lalancette 已提交
572

573 574 575 576 577 578 579 580 581 582 583
/**
 * 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)
{
584 585 586 587
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
588
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
589
        return -1;
590 591 592
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
593 594 595
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
596
        return -1;
597 598
    }

599
    VIR_DEBUG ("registering %s as network driver %d",
600 601
           driver->name, virNetworkDriverTabCount);

602 603
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
604 605
}

D
Daniel Veillard 已提交
606 607
/**
 * virRegisterInterfaceDriver:
L
Laine Stump 已提交
608
 * @driver: pointer to an interface driver block
D
Daniel Veillard 已提交
609
 *
L
Laine Stump 已提交
610
 * Register an interface virtualization driver
D
Daniel Veillard 已提交
611 612 613 614 615 616 617 618 619 620
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterInterfaceDriver(virInterfaceDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
621
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
622
        return -1;
D
Daniel Veillard 已提交
623 624 625
    }

    if (virInterfaceDriverTabCount >= MAX_DRIVERS) {
626 627 628
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
629
        return -1;
D
Daniel Veillard 已提交
630 631
    }

632
    VIR_DEBUG ("registering %s as interface driver %d",
D
Daniel Veillard 已提交
633 634 635 636 637 638
           driver->name, virInterfaceDriverTabCount);

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

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
/**
 * 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) {
654
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
655
        return -1;
656 657 658
    }

    if (virStorageDriverTabCount >= MAX_DRIVERS) {
659 660 661
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
662
        return -1;
663 664
    }

665
    VIR_DEBUG ("registering %s as storage driver %d",
666 667
           driver->name, virStorageDriverTabCount);

668 669 670 671
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
/**
 * 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) {
687
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
688
        return -1;
689 690 691
    }

    if (virDeviceMonitorTabCount >= MAX_DRIVERS) {
692 693 694
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
695
        return -1;
696 697
    }

698
    VIR_DEBUG ("registering %s as device driver %d",
699 700
           driver->name, virDeviceMonitorTabCount);

701 702 703 704
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
/**
 * 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) {
720
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
721
        return -1;
722 723 724
    }

    if (virSecretDriverTabCount >= MAX_DRIVERS) {
725 726 727
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
728
        return -1;
729 730
    }

731
    VIR_DEBUG ("registering %s as secret driver %d",
732 733 734 735 736 737
           driver->name, virSecretDriverTabCount);

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

S
Stefan Berger 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
/**
 * 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) {
753
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
754 755 756 757
        return -1;
    }

    if (virNWFilterDriverTabCount >= MAX_DRIVERS) {
758 759 760
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
S
Stefan Berger 已提交
761 762 763
        return -1;
    }

764
    VIR_DEBUG ("registering %s as network filter driver %d",
S
Stefan Berger 已提交
765 766 767 768 769 770 771
           driver->name, virNWFilterDriverTabCount);

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


772 773 774 775 776 777 778 779 780 781 782
/**
 * 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)
{
783
    VIR_DEBUG("driver=%p name=%s", driver, driver ? NULLSTR(driver->name) : "(null)");
784

785
    if (virInitialize() < 0)
786
        return -1;
787 788

    if (driver == NULL) {
789
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
790
        return -1;
791 792 793
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
794 795 796
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
797
        return -1;
798 799
    }

800
    if (driver->no < 0) {
801 802
        virLibConnError(VIR_ERR_INVALID_ARG,
                        _("Tried to register an internal Xen driver"));
803 804 805
        return -1;
    }

806
    VIR_DEBUG ("registering %s as driver %d",
807 808
           driver->name, virDriverTabCount);

809 810
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
811 812
}

A
Atsushi SAKAI 已提交
813
#ifdef WITH_LIBVIRTD
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
/**
 * 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) {
829
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
830
        return -1;
831 832 833
    }

    if (virStateDriverTabCount >= MAX_DRIVERS) {
834 835 836
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
837
        return -1;
838 839 840 841 842 843
    }

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

844 845
/**
 * virStateInitialize:
E
Eric Blake 已提交
846
 * @privileged: set to 1 if running with root privilege, 0 otherwise
847 848 849
 *
 * Initialize all virtualization drivers.
 *
850
 * Returns 0 if all succeed, -1 upon any failure.
851
 */
852
int virStateInitialize(int privileged) {
853 854 855 856 857 858
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
859
        if (virStateDriverTab[i]->initialize &&
860
            virStateDriverTab[i]->initialize(privileged) < 0) {
861
            VIR_ERROR(_("Initialization of %s state driver failed"),
862
                      virStateDriverTab[i]->name);
863
            ret = -1;
864
        }
865 866 867 868
    }
    return ret;
}

869 870 871 872 873
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
874
 * Returns 0 if all succeed, -1 upon any failure.
875
 */
D
Daniel P. Berrange 已提交
876
int virStateCleanup(void) {
877 878 879
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
880 881
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
882 883 884 885 886
            ret = -1;
    }
    return ret;
}

887 888 889 890 891
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
892
 * Returns 0 if all succeed, -1 upon any failure.
893
 */
D
Daniel P. Berrange 已提交
894
int virStateReload(void) {
895 896 897
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
898 899
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
900 901 902 903 904
            ret = -1;
    }
    return ret;
}

905 906 907 908 909
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
910
 * Returns 0 if none are active, 1 if at least one is.
911
 */
D
Daniel P. Berrange 已提交
912
int virStateActive(void) {
913 914 915
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
916 917
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
918 919 920 921 922
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
923
#endif
924

925 926


927 928 929
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
930 931 932 933 934 935 936 937 938 939 940 941 942
 * @type: ignored; pass NULL
 * @typeVer: pass NULL; for historical purposes duplicates @libVer if
 * non-NULL
 *
 * Provides version information. @libVer is the version of the
 * library and will always be set unless an error occurs, in which case
 * an error code will be returned. @typeVer exists for historical
 * compatibility; if it is not NULL it will duplicate @libVer (it was
 * originally intended to return hypervisor information based on @type,
 * but due to the design of remote clients this is not reliable). To
 * get the version of the running hypervisor use the virConnectGetVersion
 * function instead. To get the libvirt library version used by a
 * connection use the virConnectGetLibVersion instead.
943 944 945 946 947
 *
 * 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
948
virGetVersion(unsigned long *libVer, const char *type ATTRIBUTE_UNUSED,
949 950
              unsigned long *typeVer)
{
951
    VIR_DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
952

953
    if (!initialized)
954
        if (virInitialize() < 0)
955
            goto error;
956

957
    if (libVer == NULL)
958
        goto error;
959 960
    *libVer = LIBVIR_VERSION_NUMBER;

961
    if (typeVer != NULL)
962 963
        *typeVer = LIBVIR_VERSION_NUMBER;

964
    return 0;
965 966 967 968

error:
    virDispatchError(NULL);
    return -1;
969 970
}

971
static virConnectPtr
972 973
do_open (const char *name,
         virConnectAuthPtr auth,
974
         unsigned int flags)
975
{
976
    int i, res;
977 978
    virConnectPtr ret;

979 980
    virResetLastError();

981 982 983
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
984

985 986 987 988 989 990 991 992
    /*
     *  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) {
993
            VIR_DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
994 995
            name = defname;
        } else {
996
            name = NULL;
997
        }
998
    }
999

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
    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) {
1013 1014
            virLibConnError(VIR_ERR_INVALID_ARG,
                            _("could not parse connection URI"));
1015 1016
            goto failed;
        }
1017

1018
        VIR_DEBUG("name \"%s\" to URI components:\n"
1019 1020 1021 1022 1023 1024 1025 1026
              "  scheme %s\n"
              "  opaque %s\n"
              "  authority %s\n"
              "  server %s\n"
              "  user %s\n"
              "  port %d\n"
              "  path %s\n",
              name,
1027 1028 1029 1030
              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));
1031
    } else {
1032
        VIR_DEBUG("no name, allowing driver auto-select");
1033 1034
    }

1035 1036 1037
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1038
    for (i = 0; i < virDriverTabCount; i++) {
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
        /* 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
1053
             STRCASEEQ(ret->uri->scheme, "vpx") ||
1054 1055
             STRCASEEQ(ret->uri->scheme, "esx") ||
             STRCASEEQ(ret->uri->scheme, "gsx") ||
M
Matthias Bolte 已提交
1056 1057 1058
#endif
#ifndef WITH_HYPERV
             STRCASEEQ(ret->uri->scheme, "hyperv") ||
1059 1060 1061 1062 1063
#endif
#ifndef WITH_XENAPI
             STRCASEEQ(ret->uri->scheme, "xenapi") ||
#endif
             false)) {
1064
            virReportErrorHelper(VIR_FROM_NONE, VIR_ERR_INVALID_ARG,
1065 1066 1067 1068 1069 1070
                                 __FILE__, __FUNCTION__, __LINE__,
                                 _("libvirt was built without the '%s' driver"),
                                 ret->uri->scheme);
            goto failed;
        }

1071
        VIR_DEBUG("trying driver %d (%s) ...",
1072
              i, virDriverTab[i]->name);
1073
        res = virDriverTab[i]->open (ret, auth, flags);
1074
        VIR_DEBUG("driver %d %s returned %s",
1075 1076 1077 1078
              i, virDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1079 1080 1081 1082 1083
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1084 1085
    }

1086
    if (!ret->driver) {
1087
        /* If we reach here, then all drivers declined the connection. */
1088 1089 1090
        virLibConnError(VIR_ERR_NO_CONNECT,
                        _("No connection for URI %s"),
                        NULLSTR(name));
1091
        goto failed;
1092 1093
    }

1094
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1095
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1096
        VIR_DEBUG("network driver %d %s returned %s",
1097 1098 1099 1100
              i, virNetworkDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1101 1102 1103
        if (res == VIR_DRV_OPEN_ERROR) {
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1104 1105 1106
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1107
    }
1108

D
Daniel Veillard 已提交
1109 1110
    for (i = 0; i < virInterfaceDriverTabCount; i++) {
        res = virInterfaceDriverTab[i]->open (ret, auth, flags);
1111
        VIR_DEBUG("interface driver %d %s returned %s",
D
Daniel Veillard 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
              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) {
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->interfaceDriver = virInterfaceDriverTab[i];
            break;
        }
    }
1123 1124 1125

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1126
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1127
        VIR_DEBUG("storage driver %d %s returned %s",
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
              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) {
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->storageDriver = virStorageDriverTab[i];
            break;
        }
    }

1140 1141 1142
    /* Node driver (optional) */
    for (i = 0; i < virDeviceMonitorTabCount; i++) {
        res = virDeviceMonitorTab[i]->open (ret, auth, flags);
1143
        VIR_DEBUG("node driver %d %s returned %s",
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
              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) {
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1156 1157 1158
    /* Secret manipulation driver. Optional */
    for (i = 0; i < virSecretDriverTabCount; i++) {
        res = virSecretDriverTab[i]->open (ret, auth, flags);
1159
        VIR_DEBUG("secret driver %d %s returned %s",
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
              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) {
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->secretDriver = virSecretDriverTab[i];
            break;
        }
    }

S
Stefan Berger 已提交
1172 1173 1174
    /* Network filter driver. Optional */
    for (i = 0; i < virNWFilterDriverTabCount; i++) {
        res = virNWFilterDriverTab[i]->open (ret, auth, flags);
1175
        VIR_DEBUG("nwfilter driver %d %s returned %s",
S
Stefan Berger 已提交
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
              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) {
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->nwfilterDriver = virNWFilterDriverTab[i];
            break;
        }
    }

1188
    return ret;
1189 1190

failed:
1191 1192
    virUnrefConnect(ret);

1193
    return NULL;
1194 1195
}

1196 1197
/**
 * virConnectOpen:
1198
 * @name: URI of the hypervisor
1199
 *
1200
 * This function should be called first to get a connection to the
1201 1202 1203
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1204
 *
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
 * 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
 *
1216
 * URIs are documented at http://libvirt.org/uri.html
1217 1218 1219 1220
 */
virConnectPtr
virConnectOpen (const char *name)
{
1221
    virConnectPtr ret = NULL;
1222 1223
    if (!initialized)
        if (virInitialize() < 0)
1224
            goto error;
1225

1226
    VIR_DEBUG("name=%s", name);
1227 1228 1229 1230 1231 1232 1233 1234
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1235 1236
}

1237
/**
1238
 * virConnectOpenReadOnly:
1239
 * @name: URI of the hypervisor
1240
 *
1241
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1242
 * library functionalities. The set of APIs usable are then restricted
1243
 * on the available methods to control the domains.
1244
 *
1245 1246 1247
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1248
 * Returns a pointer to the hypervisor connection or NULL in case of error
1249 1250
 *
 * URIs are documented at http://libvirt.org/uri.html
1251
 */
1252
virConnectPtr
1253 1254
virConnectOpenReadOnly(const char *name)
{
1255
    virConnectPtr ret = NULL;
1256 1257
    if (!initialized)
        if (virInitialize() < 0)
1258
            goto error;
1259

1260
    VIR_DEBUG("name=%s", name);
1261 1262 1263 1264 1265 1266 1267 1268
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1269 1270 1271 1272 1273 1274 1275 1276
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1277
 * This function should be called first to get a connection to the
1278
 * Hypervisor. If necessary, authentication will be performed fetching
1279 1280
 * credentials via the callback
 *
1281 1282 1283
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1284 1285 1286 1287 1288 1289 1290
 * 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,
1291
                   unsigned int flags)
1292
{
1293
    virConnectPtr ret = NULL;
1294 1295
    if (!initialized)
        if (virInitialize() < 0)
1296
            goto error;
1297

1298
    VIR_DEBUG("name=%s, auth=%p, flags=%x", NULLSTR(name), auth, flags);
1299 1300 1301 1302 1303 1304 1305 1306
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1307 1308 1309
}

/**
1310
 * virConnectClose:
D
Daniel Veillard 已提交
1311 1312 1313 1314 1315 1316 1317
 * @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.
 *
1318 1319 1320 1321 1322 1323 1324 1325
 * Connections are reference counted; the count is explicitly
 * increased by the initial open (virConnectOpen, virConnectOpenAuth,
 * and the like) as well as virConnectRef; it is also temporarily
 * increased by other API that depend on the connection remaining
 * alive.  The open and every virConnectRef call should have a
 * matching virConnectClose, and all other references will be released
 * after the corresponding operation completes.
 *
1326
 * Returns the number of remaining references on success
1327 1328 1329 1330 1331 1332 1333
 * (positive implies that some other call still has a reference open,
 * 0 implies that no references remain and the connection is closed),
 * or -1 on failure.  It is possible for the last virConnectClose to
 * return a positive value if some other object still has a temporary
 * reference to the connection, but the application should not try to
 * further use a connection after the virConnectClose that matches the
 * initial open.
D
Daniel Veillard 已提交
1334 1335
 */
int
1336 1337
virConnectClose(virConnectPtr conn)
{
1338
    int ret = -1;
1339
    VIR_DEBUG("conn=%p", conn);
1340

1341 1342 1343
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1344
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1345
        goto error;
1346
    }
1347

1348 1349 1350 1351 1352 1353 1354 1355
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

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

1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
/**
 * 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 已提交
1372 1373
 *
 * Returns 0 in case of success, -1 in case of failure
1374 1375 1376 1377 1378
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
1379
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1380
        virDispatchError(NULL);
1381
        return -1;
1382 1383
    }
    virMutexLock(&conn->lock);
1384
    VIR_DEBUG("conn=%p refs=%d", conn, conn->refs);
1385 1386 1387 1388 1389
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1390 1391
/*
 * Not for public use.  This function is part of the internal
1392 1393 1394
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1395
virDrvSupportsFeature (virConnectPtr conn, int feature)
1396
{
1397
    int ret;
1398
    VIR_DEBUG("conn=%p, feature=%d", conn, feature);
1399

1400 1401 1402
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1403
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1404
        virDispatchError(NULL);
1405
        return -1;
1406
    }
1407

1408 1409 1410 1411
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1412 1413

    if (ret < 0)
1414
        virDispatchError(conn);
1415

1416
    return ret;
1417 1418
}

1419 1420 1421 1422 1423 1424 1425
/**
 * 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.
1426 1427 1428
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1429 1430
 */
const char *
1431 1432
virConnectGetType(virConnectPtr conn)
{
1433
    const char *ret;
1434
    VIR_DEBUG("conn=%p", conn);
1435

1436 1437
    virResetLastError();

D
Daniel Veillard 已提交
1438
    if (!VIR_IS_CONNECT(conn)) {
1439
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1440
        virDispatchError(NULL);
1441
        return NULL;
D
Daniel Veillard 已提交
1442
    }
1443 1444 1445 1446

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1447
    }
1448
    return conn->driver->name;
1449 1450
}

D
Daniel Veillard 已提交
1451
/**
1452
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1453
 * @conn: pointer to the hypervisor connection
1454
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1455
 *
1456
 * Get the version level of the Hypervisor running. This may work only with
1457
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1458
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1459
 *
1460 1461 1462
 * 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 已提交
1463
 */
1464
int
1465 1466
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1467
    VIR_DEBUG("conn=%p, hvVer=%p", conn, hvVer);
1468

1469 1470
    virResetLastError();

D
Daniel Veillard 已提交
1471
    if (!VIR_IS_CONNECT(conn)) {
1472
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1473
        virDispatchError(NULL);
1474
        return -1;
D
Daniel Veillard 已提交
1475
    }
1476

D
Daniel Veillard 已提交
1477
    if (hvVer == NULL) {
1478
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1479
        goto error;
D
Daniel Veillard 已提交
1480
    }
1481

1482 1483 1484 1485 1486 1487
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1488

1489
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1490 1491

error:
1492
    virDispatchError(conn);
1493
    return -1;
1494 1495
}

1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
/**
 * 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;
1511
    VIR_DEBUG("conn=%p, libVir=%p", conn, libVer);
1512 1513 1514 1515

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1516
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1517
        virDispatchError(NULL);
1518 1519 1520 1521
        return -1;
    }

    if (libVer == NULL) {
1522
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
        goto error;
    }

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

1533 1534 1535
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1536
error:
1537
    virDispatchError(conn);
1538 1539 1540
    return ret;
}

1541 1542 1543 1544 1545
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
1546
 * running (the result of the gethostname system call).  If
1547 1548 1549 1550 1551 1552 1553 1554 1555
 * 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)
{
1556
    VIR_DEBUG("conn=%p", conn);
1557

1558 1559
    virResetLastError();

1560
    if (!VIR_IS_CONNECT(conn)) {
1561
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1562
        virDispatchError(NULL);
1563 1564 1565
        return NULL;
    }

1566 1567 1568 1569 1570 1571
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1572

1573
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1574 1575

error:
1576
    virDispatchError(conn);
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
    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)
{
1598
    char *name;
1599
    VIR_DEBUG("conn=%p", conn);
1600

1601 1602
    virResetLastError();

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

1609
    name = (char *)xmlSaveUri(conn->uri);
1610
    if (!name) {
1611
        virReportOOMError();
1612
        goto error;
1613 1614
    }
    return name;
1615 1616

error:
1617
    virDispatchError(conn);
1618
    return NULL;
1619 1620
}

E
Eric Blake 已提交
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
/**
 * virConnectGetSysinfo:
 * @conn: pointer to a hypervisor connection
 * @flags: callers should always pass 0
 *
 * This returns the XML description of the sysinfo details for the
 * host on which the hypervisor is running, in the same format as the
 * <sysinfo> element of a domain XML.  This information is generally
 * available only for hypervisors running with root privileges.
 *
 * Returns the XML string which must be freed by the caller, or
 * NULL if there was an error.
 */
char *
virConnectGetSysinfo (virConnectPtr conn, unsigned int flags)
{
E
Eric Blake 已提交
1637
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
E
Eric Blake 已提交
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}

1661 1662 1663 1664 1665
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1666
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1667 1668 1669 1670 1671 1672 1673 1674 1675
 * 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)
{
1676
    VIR_DEBUG("conn=%p, type=%s", conn, type);
1677

1678 1679
    virResetLastError();

1680
    if (!VIR_IS_CONNECT(conn)) {
1681
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1682
        virDispatchError(NULL);
1683
        return -1;
1684 1685
    }

1686 1687 1688 1689 1690 1691
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1692

1693
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1694
error:
1695
    virDispatchError(conn);
1696
    return -1;
1697 1698
}

1699
/**
1700
 * virConnectListDomains:
1701 1702 1703 1704 1705 1706 1707 1708 1709
 * @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
1710 1711
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1712
    VIR_DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);
1713

1714 1715
    virResetLastError();

D
Daniel Veillard 已提交
1716
    if (!VIR_IS_CONNECT(conn)) {
1717
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1718
        virDispatchError(NULL);
1719
        return -1;
D
Daniel Veillard 已提交
1720
    }
1721

1722
    if ((ids == NULL) || (maxids < 0)) {
1723
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1724
        goto error;
D
Daniel Veillard 已提交
1725
    }
1726

1727 1728 1729 1730 1731 1732
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1733

1734
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1735
error:
1736
    virDispatchError(conn);
1737
    return -1;
D
Daniel Veillard 已提交
1738 1739
}

K
 
Karel Zak 已提交
1740 1741 1742 1743
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1744 1745
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1746 1747 1748
 * Returns the number of domain found or -1 in case of error
 */
int
1749 1750
virConnectNumOfDomains(virConnectPtr conn)
{
1751
    VIR_DEBUG("conn=%p", conn);
1752

1753 1754
    virResetLastError();

D
Daniel Veillard 已提交
1755
    if (!VIR_IS_CONNECT(conn)) {
1756
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1757
        virDispatchError(NULL);
1758
        return -1;
D
Daniel Veillard 已提交
1759
    }
K
Karel Zak 已提交
1760

1761 1762 1763 1764 1765 1766
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1767

1768
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1769
error:
1770
    virDispatchError(conn);
1771
    return -1;
K
 
Karel Zak 已提交
1772 1773
}

1774 1775 1776 1777
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1778
 * Provides the connection pointer associated with a domain.  The
1779 1780 1781
 * reference counter on the connection is not increased by this
 * call.
 *
1782 1783 1784 1785
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1786 1787 1788 1789 1790
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1791
    VIR_DOMAIN_DEBUG(dom);
1792

1793 1794 1795
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1796
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1797
        virDispatchError(NULL);
1798 1799 1800 1801 1802
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1803
/**
1804
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1805
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1806
 * @xmlDesc: string containing an XML description of the domain
1807
 * @flags: bitwise-or of supported virDomainCreateFlags
D
Daniel Veillard 已提交
1808
 *
1809
 * Launch a new guest domain, based on an XML description similar
1810
 * to the one returned by virDomainGetXMLDesc()
1811
 * This function may require privileged access to the hypervisor.
1812 1813 1814
 * 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).
1815
 *
1816 1817 1818 1819 1820 1821 1822
 * If the VIR_DOMAIN_START_PAUSED flag is set, the guest domain
 * will be started, but its CPUs will remain paused. The CPUs
 * can later be manually started using virDomainResume.
 *
 * If the VIR_DOMAIN_START_AUTODESTROY flag is set, the guest
 * domain will be automatically destroyed when the virConnectPtr
 * object is finally released. This will also happen if the
E
Eric Blake 已提交
1823
 * client application crashes / loses its connection to the
1824
 * libvirtd daemon. Any domains marked for auto destroy will
1825
 * block attempts at migration, save-to-file, or snapshots.
1826
 *
D
Daniel Veillard 已提交
1827 1828
 * Returns a new domain object or NULL in case of failure
 */
1829
virDomainPtr
1830 1831
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1832
{
1833
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
1834

1835 1836
    virResetLastError();

D
Daniel Veillard 已提交
1837
    if (!VIR_IS_CONNECT(conn)) {
1838
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1839
        virDispatchError(NULL);
1840
        return NULL;
D
Daniel Veillard 已提交
1841 1842
    }
    if (xmlDesc == NULL) {
1843
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1844
        goto error;
D
Daniel Veillard 已提交
1845
    }
1846
    if (conn->flags & VIR_CONNECT_RO) {
1847
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1848
        goto error;
1849
    }
D
Daniel Veillard 已提交
1850

1851 1852 1853 1854 1855 1856 1857
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1858

1859
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1860
error:
1861
    virDispatchError(conn);
1862
    return NULL;
D
Daniel Veillard 已提交
1863 1864
}

1865 1866 1867 1868 1869 1870 1871 1872
/**
 * 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.
1873
 * This existing name will left indefinitely for API compatibility.
1874 1875 1876 1877 1878 1879 1880
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
{
1881
    return virDomainCreateXML(conn, xmlDesc, flags);
1882
}
1883

1884
/**
1885
 * virDomainLookupByID:
1886 1887 1888 1889
 * @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 已提交
1890 1891
 * 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.
1892
 *
1893 1894
 * 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.
1895
 */
1896
virDomainPtr
1897 1898
virDomainLookupByID(virConnectPtr conn, int id)
{
1899
    VIR_DEBUG("conn=%p, id=%d", conn, id);
1900

1901 1902
    virResetLastError();

D
Daniel Veillard 已提交
1903
    if (!VIR_IS_CONNECT(conn)) {
1904
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1905
        virDispatchError(NULL);
1906
        return NULL;
D
Daniel Veillard 已提交
1907 1908
    }
    if (id < 0) {
1909
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1910
        goto error;
D
Daniel Veillard 已提交
1911
    }
1912

1913 1914 1915 1916 1917 1918 1919
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1920

1921
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1922 1923

error:
1924
    virDispatchError(conn);
1925
    return NULL;
1926 1927 1928 1929 1930
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1931
 * @uuid: the raw UUID for the domain
1932 1933 1934
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1935 1936
 * 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.
1937 1938
 */
virDomainPtr
1939 1940
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1941
    VIR_UUID_DEBUG(conn, uuid);
1942

1943 1944
    virResetLastError();

D
Daniel Veillard 已提交
1945
    if (!VIR_IS_CONNECT(conn)) {
1946
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1947
        virDispatchError(NULL);
1948
        return NULL;
D
Daniel Veillard 已提交
1949 1950
    }
    if (uuid == NULL) {
1951
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1952
        goto error;
D
Daniel Veillard 已提交
1953
    }
1954

1955 1956 1957 1958 1959 1960 1961
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1962

1963
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1964 1965

error:
1966
    virDispatchError(conn);
1967
    return NULL;
1968 1969
}

K
Karel Zak 已提交
1970 1971 1972 1973 1974 1975 1976
/**
 * 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.
 *
1977 1978
 * 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 已提交
1979 1980 1981 1982
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1983
    unsigned char uuid[VIR_UUID_BUFLEN];
1984
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
1985

1986 1987
    virResetLastError();

K
Karel Zak 已提交
1988
    if (!VIR_IS_CONNECT(conn)) {
1989
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1990
        virDispatchError(NULL);
1991
        return NULL;
K
Karel Zak 已提交
1992 1993
    }
    if (uuidstr == NULL) {
1994
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1995
        goto error;
K
Karel Zak 已提交
1996
    }
1997 1998

    if (virUUIDParse(uuidstr, uuid) < 0) {
1999
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2000
        goto error;
K
Karel Zak 已提交
2001
    }
2002

K
Karel Zak 已提交
2003
    return virDomainLookupByUUID(conn, &uuid[0]);
2004 2005

error:
2006
    virDispatchError(conn);
2007
    return NULL;
K
Karel Zak 已提交
2008 2009
}

2010 2011 2012 2013 2014
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
2015
 * Try to lookup a domain on the given hypervisor based on its name.
2016
 *
2017 2018
 * 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.
2019 2020
 */
virDomainPtr
2021 2022
virDomainLookupByName(virConnectPtr conn, const char *name)
{
2023
    VIR_DEBUG("conn=%p, name=%s", conn, name);
2024

2025 2026
    virResetLastError();

D
Daniel Veillard 已提交
2027
    if (!VIR_IS_CONNECT(conn)) {
2028
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2029
        virDispatchError(NULL);
2030
        return NULL;
D
Daniel Veillard 已提交
2031 2032
    }
    if (name == NULL) {
2033
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2034
        goto error;
D
Daniel Veillard 已提交
2035
    }
2036

2037 2038 2039 2040 2041 2042 2043
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2044

2045
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2046 2047

error:
2048
    virDispatchError(conn);
2049
    return NULL;
2050 2051
}

D
Daniel Veillard 已提交
2052
/**
2053
 * virDomainDestroy:
D
Daniel Veillard 已提交
2054 2055 2056
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
2057 2058 2059
 * 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 已提交
2060 2061
 *
 * Returns 0 in case of success and -1 in case of failure.
2062
 */
D
Daniel Veillard 已提交
2063
int
2064 2065
virDomainDestroy(virDomainPtr domain)
{
2066
    virConnectPtr conn;
2067

2068
    VIR_DOMAIN_DEBUG(domain);
2069

2070 2071
    virResetLastError();

D
Daniel Veillard 已提交
2072
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2073
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2074
        virDispatchError(NULL);
2075
        return -1;
D
Daniel Veillard 已提交
2076
    }
2077

2078
    conn = domain->conn;
2079
    if (conn->flags & VIR_CONNECT_RO) {
2080
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2081
        goto error;
2082
    }
2083

2084 2085 2086 2087 2088 2089 2090
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2091

2092
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2093 2094

error:
2095
    virDispatchError(conn);
2096
    return -1;
2097 2098
}

2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119
/**
 * virDomainDestroyFlags:
 * @domain: a domain object
 * @flags: an OR'ed set of virDomainDestroyFlagsValues
 *
 * Destroy the domain object. The running instance is shutdown if not down
 * 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.
 *
 * Calling this function with no @flags set (equal to zero)
 * is equivalent to calling virDomainDestroy.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainDestroyFlags(virDomainPtr domain,
                      unsigned int flags)
{
    virConnectPtr conn;

E
Eric Blake 已提交
2120
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150

    virResetLastError();

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

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

2151 2152 2153 2154 2155 2156 2157 2158 2159 2160
/**
 * 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
2161 2162
virDomainFree(virDomainPtr domain)
{
2163
    VIR_DOMAIN_DEBUG(domain);
2164

2165 2166 2167
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2168
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2169
        virDispatchError(NULL);
2170
        return -1;
D
Daniel Veillard 已提交
2171
    }
2172 2173
    if (virUnrefDomain(domain) < 0) {
        virDispatchError(NULL);
2174
        return -1;
2175
    }
2176
    return 0;
D
Daniel Veillard 已提交
2177 2178
}

2179 2180
/**
 * virDomainRef:
D
Daniel Veillard 已提交
2181
 * @domain: the domain to hold a reference on
2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192
 *
 * 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 已提交
2193 2194
 *
 * Returns 0 in case of success and -1 in case of failure.
2195 2196 2197 2198 2199
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
2200
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2201
        virDispatchError(NULL);
2202
        return -1;
2203 2204
    }
    virMutexLock(&domain->conn->lock);
2205
    VIR_DOMAIN_DEBUG(domain, "refs=%d", domain->refs);
2206 2207 2208 2209 2210 2211
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
2212
/**
2213
 * virDomainSuspend:
D
Daniel Veillard 已提交
2214 2215 2216
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
2217
 * to CPU resources and I/O but the memory used by the domain at the
2218
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
2219
 * the domain.
2220
 * This function may require privileged access.
D
Daniel Veillard 已提交
2221 2222 2223 2224
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2225 2226
virDomainSuspend(virDomainPtr domain)
{
2227
    virConnectPtr conn;
2228

2229
    VIR_DOMAIN_DEBUG(domain);
2230

2231 2232
    virResetLastError();

D
Daniel Veillard 已提交
2233
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2234
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2235
        virDispatchError(NULL);
2236
        return -1;
D
Daniel Veillard 已提交
2237
    }
2238
    if (domain->conn->flags & VIR_CONNECT_RO) {
2239
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2240
        goto error;
2241
    }
D
Daniel Veillard 已提交
2242

2243 2244
    conn = domain->conn;

2245 2246 2247 2248 2249 2250 2251
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2252

2253
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2254 2255

error:
2256
    virDispatchError(domain->conn);
2257
    return -1;
D
Daniel Veillard 已提交
2258 2259 2260
}

/**
2261
 * virDomainResume:
D
Daniel Veillard 已提交
2262 2263
 * @domain: a domain object
 *
D
Dan Kenigsberg 已提交
2264
 * Resume a suspended domain, the process is restarted from the state where
2265
 * it was frozen by calling virSuspendDomain().
2266
 * This function may require privileged access
D
Daniel Veillard 已提交
2267 2268 2269 2270
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2271 2272
virDomainResume(virDomainPtr domain)
{
2273
    virConnectPtr conn;
2274

2275
    VIR_DOMAIN_DEBUG(domain);
2276

2277 2278
    virResetLastError();

D
Daniel Veillard 已提交
2279
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2280
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2281
        virDispatchError(NULL);
2282
        return -1;
D
Daniel Veillard 已提交
2283
    }
2284
    if (domain->conn->flags & VIR_CONNECT_RO) {
2285
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2286
        goto error;
2287
    }
D
Daniel Veillard 已提交
2288

2289 2290
    conn = domain->conn;

2291 2292 2293 2294 2295 2296 2297
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2298

2299
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2300 2301

error:
2302
    virDispatchError(domain->conn);
2303
    return -1;
D
Daniel Veillard 已提交
2304 2305
}

2306 2307 2308 2309 2310 2311
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2312
 * a file on disk. After the call, if successful, the domain is not
2313
 * listed as running anymore (this ends the life of a transient domain).
2314
 * Use virDomainRestore() to restore a domain after saving.
2315
 *
2316 2317 2318
 * See virDomainSaveFlags() for more control.  Also, a save file can
 * be inspected or modified slightly with virDomainSaveImageGetXMLDesc()
 * and virDomainSaveImageDefineXML().
2319
 *
2320 2321 2322
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2323 2324
virDomainSave(virDomainPtr domain, const char *to)
{
2325
    virConnectPtr conn;
2326 2327

    VIR_DOMAIN_DEBUG(domain, "to=%s", to);
2328

2329 2330
    virResetLastError();

D
Daniel Veillard 已提交
2331
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2332
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2333
        virDispatchError(NULL);
2334
        return -1;
D
Daniel Veillard 已提交
2335
    }
2336
    if (domain->conn->flags & VIR_CONNECT_RO) {
2337
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2338
        goto error;
2339
    }
2340
    conn = domain->conn;
D
Daniel Veillard 已提交
2341
    if (to == NULL) {
2342
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2343
        goto error;
D
Daniel Veillard 已提交
2344
    }
2345

2346 2347 2348
    if (conn->driver->domainSave) {
        int ret;
        char *absolute_to;
2349

2350 2351 2352 2353 2354 2355
        /* We must absolutize the file path as the save is done out of process */
        if (virFileAbsPath(to, &absolute_to) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute output file path"));
            goto error;
        }
2356

2357 2358 2359
        ret = conn->driver->domainSave(domain, absolute_to);

        VIR_FREE(absolute_to);
2360

2361 2362 2363 2364
        if (ret < 0)
            goto error;
        return ret;
    }
2365

2366
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2367 2368

error:
2369
    virDispatchError(domain->conn);
2370
    return -1;
2371 2372
}

2373 2374 2375 2376 2377 2378 2379 2380 2381
/**
 * virDomainSaveFlags:
 * @domain: a domain object
 * @to: path for the output file
 * @dxml: (optional) XML config for adjusting guest xml used on restore
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
 *
 * 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
2382
 * listed as running anymore (this ends the life of a transient domain).
2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
 * Use virDomainRestore() to restore a domain after saving.
 *
 * If the hypervisor supports it, @dxml can be used to alter
 * host-specific portions of the domain XML that will be used when
 * restoring an image.  For example, it is possible to alter the
 * backing filename that is associated with a disk device, in order to
 * prepare for file renaming done as part of backing up the disk
 * device while the domain is stopped.
 *
 * If @flags includes VIR_DOMAIN_SAVE_BYPASS_CACHE, then libvirt will
 * attempt to bypass the file system cache while creating the file, or
 * fail if it cannot do so for the given system; this can allow less
 * pressure on file system cache, but also risks slowing saves to NFS.
 *
2397 2398 2399 2400 2401 2402
 * Normally, the saved state file will remember whether the domain was
 * running or paused, and restore defaults to the same state.
 * Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in
 * @flags will override what state gets saved into the file.  These
 * two flags are mutually exclusive.
 *
2403 2404 2405
 * A save file can be inspected or modified slightly with
 * virDomainSaveImageGetXMLDesc() and virDomainSaveImageDefineXML().
 *
2406 2407 2408 2409 2410 2411 2412 2413
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSaveFlags(virDomainPtr domain, const char *to,
                   const char *dxml, unsigned int flags)
{
    virConnectPtr conn;

E
Eric Blake 已提交
2414
    VIR_DOMAIN_DEBUG(domain, "to=%s, dxml=%s, flags=%x",
2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433
                     to, NULLSTR(dxml), flags);

    virResetLastError();

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

2434 2435 2436 2437 2438 2439
    if ((flags & VIR_DOMAIN_SAVE_RUNNING) && (flags & VIR_DOMAIN_SAVE_PAUSED)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("running and paused flags are mutually exclusive"));
        goto error;
    }

2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466
    if (conn->driver->domainSaveFlags) {
        int ret;
        char *absolute_to;

        /* We must absolutize the file path as the save is done out of process */
        if (virFileAbsPath(to, &absolute_to) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute output file path"));
            goto error;
        }

        ret = conn->driver->domainSaveFlags(domain, absolute_to, dxml, flags);

        VIR_FREE(absolute_to);

        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

2467 2468
/**
 * virDomainRestore:
2469
 * @conn: pointer to the hypervisor connection
2470
 * @from: path to the input file
2471 2472 2473
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
2474 2475
 * See virDomainRestoreFlags() for more control.
 *
2476 2477 2478
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2479 2480
virDomainRestore(virConnectPtr conn, const char *from)
{
2481
    VIR_DEBUG("conn=%p, from=%s", conn, from);
2482

2483 2484
    virResetLastError();

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

2499 2500 2501
    if (conn->driver->domainRestore) {
        int ret;
        char *absolute_from;
2502

2503 2504
        /* We must absolutize the file path as the restore is done out of process */
        if (virFileAbsPath(from, &absolute_from) < 0) {
2505
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
2506
                            _("could not build absolute input file path"));
2507 2508
            goto error;
        }
2509

2510 2511 2512 2513
        ret = conn->driver->domainRestore(conn, absolute_from);

        VIR_FREE(absolute_from);

2514 2515 2516 2517
        if (ret < 0)
            goto error;
        return ret;
    }
2518

2519
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2520 2521

error:
2522
    virDispatchError(conn);
2523
    return -1;
D
Daniel Veillard 已提交
2524 2525
}

2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546
/**
 * virDomainRestoreFlags:
 * @conn: pointer to the hypervisor connection
 * @from: path to the input file
 * @dxml: (optional) XML config for adjusting guest xml used on restore
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * If the hypervisor supports it, @dxml can be used to alter
 * host-specific portions of the domain XML that will be used when
 * restoring an image.  For example, it is possible to alter the
 * backing filename that is associated with a disk device, in order to
 * prepare for file renaming done as part of backing up the disk
 * device while the domain is stopped.
 *
 * If @flags includes VIR_DOMAIN_SAVE_BYPASS_CACHE, then libvirt will
 * attempt to bypass the file system cache while restoring the file, or
 * fail if it cannot do so for the given system; this can allow less
 * pressure on file system cache, but also risks slowing saves to NFS.
 *
2547 2548 2549 2550 2551 2552
 * Normally, the saved state file will remember whether the domain was
 * running or paused, and restore defaults to the same state.
 * Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in
 * @flags will override the default read from the file.  These two
 * flags are mutually exclusive.
 *
2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainRestoreFlags(virConnectPtr conn, const char *from, const char *dxml,
    unsigned int flags)
{
    VIR_DEBUG("conn=%p, from=%s, dxml=%s, flags=%x",
              conn, from, NULLSTR(dxml), flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (from == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

2578 2579 2580 2581 2582 2583
    if ((flags & VIR_DOMAIN_SAVE_RUNNING) && (flags & VIR_DOMAIN_SAVE_PAUSED)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("running and paused flags are mutually exclusive"));
        goto error;
    }

2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611
    if (conn->driver->domainRestoreFlags) {
        int ret;
        char *absolute_from;

        /* We must absolutize the file path as the restore is done out of process */
        if (virFileAbsPath(from, &absolute_from) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute input file path"));
            goto error;
        }

        ret = conn->driver->domainRestoreFlags(conn, absolute_from, dxml,
                                               flags);

        VIR_FREE(absolute_from);

        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687
/**
 * virDomainSaveImageGetXMLDesc:
 * @conn: pointer to the hypervisor connection
 * @file: path to saved state file
 * @flags: bitwise-OR of subset of virDomainXMLFlags
 *
 * This method will extract the XML describing the domain at the time
 * a saved state file was created.  @file must be a file created
 * previously by virDomainSave() or virDomainSaveFlags().
 *
 * No security-sensitive data will be included unless @flags contains
 * VIR_DOMAIN_XML_SECURE; this flag is rejected on read-only
 * connections.  For this API, @flags should not contain either
 * VIR_DOMAIN_XML_INACTIVE or VIR_DOMAIN_XML_UPDATE_CPU.
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of
 * error.  The caller must free() the returned value.
 */
char *
virDomainSaveImageGetXMLDesc(virConnectPtr conn, const char *file,
                             unsigned int flags)
{
    VIR_DEBUG("conn=%p, file=%s, flags=%x",
              conn, file, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }
    if (file == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(VIR_ERR_OPERATION_DENIED,
                        _("virDomainSaveImageGetXMLDesc with secure flag"));
        goto error;
    }

    if (conn->driver->domainSaveImageGetXMLDesc) {
        char *ret;
        char *absolute_file;

        /* We must absolutize the file path as the read is done out of process */
        if (virFileAbsPath(file, &absolute_file) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute input file path"));
            goto error;
        }

        ret = conn->driver->domainSaveImageGetXMLDesc(conn, absolute_file,
                                                      flags);

        VIR_FREE(absolute_file);

        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSaveImageDefineXML:
 * @conn: pointer to the hypervisor connection
 * @file: path to saved state file
 * @dxml: XML config for adjusting guest xml used on restore
2688
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699
 *
 * This updates the definition of a domain stored in a saved state
 * file.  @file must be a file created previously by virDomainSave()
 * or virDomainSaveFlags().
 *
 * @dxml can be used to alter host-specific portions of the domain XML
 * that will be used when restoring an image.  For example, it is
 * possible to alter the backing filename that is associated with a
 * disk device, to match renaming done as part of backing up the disk
 * device while the domain is stopped.
 *
2700 2701 2702 2703 2704 2705 2706
 * Normally, the saved state file will remember whether the domain was
 * running or paused, and restore defaults to the same state.
 * Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in
 * @flags will override the default saved into the file; omitting both
 * leaves the file's default unchanged.  These two flags are mutually
 * exclusive.
 *
2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSaveImageDefineXML(virConnectPtr conn, const char *file,
                            const char *dxml, unsigned int flags)
{
    VIR_DEBUG("conn=%p, file=%s, dxml=%s, flags=%x",
              conn, file, dxml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    if (!file || !dxml) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

2732 2733 2734 2735 2736 2737
    if ((flags & VIR_DOMAIN_SAVE_RUNNING) && (flags & VIR_DOMAIN_SAVE_PAUSED)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("running and paused flags are mutually exclusive"));
        goto error;
    }

2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765
    if (conn->driver->domainSaveImageDefineXML) {
        int ret;
        char *absolute_file;

        /* We must absolutize the file path as the read is done out of process */
        if (virFileAbsPath(file, &absolute_file) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute input file path"));
            goto error;
        }

        ret = conn->driver->domainSaveImageDefineXML(conn, absolute_file,
                                                     dxml, flags);

        VIR_FREE(absolute_file);

        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

D
Daniel Veillard 已提交
2766 2767 2768 2769
/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
2770
 * @flags: an OR'ed set of virDomainCoreDumpFlags
D
Daniel Veillard 已提交
2771 2772 2773 2774 2775
 *
 * 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.
 *
2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786
 * If @flags includes VIR_DUMP_CRASH, then leave the guest shut off with
 * a crashed state after the dump completes.  If @flags includes
 * VIR_DUMP_LIVE, then make the core dump while continuing to allow
 * the guest to run; otherwise, the guest is suspended during the dump.
 * The above two flags are mutually exclusive.
 *
 * Additionally, if @flags includes VIR_DUMP_BYPASS_CACHE, then libvirt
 * will attempt to bypass the file system cache while creating the file,
 * or fail if it cannot do so for the given system; this can allow less
 * pressure on file system cache, but also risks slowing saves to NFS.
 *
D
Daniel Veillard 已提交
2787 2788 2789
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2790
virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags)
D
Daniel Veillard 已提交
2791 2792
{
    virConnectPtr conn;
2793

2794
    VIR_DOMAIN_DEBUG(domain, "to=%s, flags=%x", to, flags);
D
Daniel Veillard 已提交
2795

2796 2797
    virResetLastError();

D
Daniel Veillard 已提交
2798
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2799
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2800
        virDispatchError(NULL);
2801
        return -1;
D
Daniel Veillard 已提交
2802 2803
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
2804
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2805
        goto error;
D
Daniel Veillard 已提交
2806 2807 2808
    }
    conn = domain->conn;
    if (to == NULL) {
2809
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2810
        goto error;
D
Daniel Veillard 已提交
2811 2812
    }

2813 2814 2815 2816 2817 2818
    if ((flags & VIR_DUMP_CRASH) && (flags & VIR_DUMP_LIVE)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("crash and live flags are mutually exclusive"));
        goto error;
    }

2819 2820 2821
    if (conn->driver->domainCoreDump) {
        int ret;
        char *absolute_to;
D
Daniel Veillard 已提交
2822

2823 2824 2825 2826
        /* We must absolutize the file path as the save is done out of process */
        if (virFileAbsPath(to, &absolute_to) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute core file path"));
2827 2828
            goto error;
        }
D
Daniel Veillard 已提交
2829

2830 2831 2832
        ret = conn->driver->domainCoreDump(domain, absolute_to, flags);

        VIR_FREE(absolute_to);
D
Daniel Veillard 已提交
2833

2834 2835 2836 2837
        if (ret < 0)
            goto error;
        return ret;
    }
2838

2839
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2840 2841

error:
2842
    virDispatchError(domain->conn);
2843
    return -1;
2844 2845
}

2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
/**
 * virDomainScreenshot:
 * @domain: a domain object
 * @stream: stream to use as output
 * @screen: monitor ID to take screenshot from
 * @flags: extra flags, currently unused
 *
 * Take a screenshot of current domain console as a stream. The image format
 * is hypervisor specific. Moreover, some hypervisors supports multiple
 * displays per domain. These can be distinguished by @screen argument.
 *
 * This call sets up a stream; subsequent use of stream API is necessary
 * to transfer actual data, determine how much data is successfully
 * transfered, and detect any errors.
 *
 * The screen ID is the sequential number of screen. In case of multiple
 * graphics cards, heads are enumerated before devices, e.g. having
 * two graphics cards, both with four heads, screen ID 5 addresses
2864
 * the second head on the second card.
2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
 *
 * Returns a string representing the mime-type of the image format, or
 * NULL upon error. The caller must free() the returned value.
 */
char *
virDomainScreenshot(virDomainPtr domain,
                    virStreamPtr stream,
                    unsigned int screen,
                    unsigned int flags)
{
E
Eric Blake 已提交
2875
    VIR_DOMAIN_DEBUG(domain, "stream=%p, flags=%x", stream, flags);
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910

    virResetLastError();

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

    if (domain->conn->driver->domainScreenshot) {
        char * ret;
        ret = domain->conn->driver->domainScreenshot(domain, stream,
                                                     screen, flags);

        if (ret == NULL)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

2911 2912 2913 2914 2915
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2916 2917
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2918 2919 2920 2921 2922 2923 2924
 *
 * 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
2925 2926
virDomainShutdown(virDomainPtr domain)
{
2927
    virConnectPtr conn;
2928

2929
    VIR_DOMAIN_DEBUG(domain);
2930

2931 2932
    virResetLastError();

D
Daniel Veillard 已提交
2933
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2934
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2935
        virDispatchError(NULL);
2936
        return -1;
D
Daniel Veillard 已提交
2937
    }
2938
    if (domain->conn->flags & VIR_CONNECT_RO) {
2939
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2940
        goto error;
2941
    }
2942

2943 2944
    conn = domain->conn;

2945 2946 2947 2948 2949 2950 2951
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2952

2953
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2954 2955

error:
2956
    virDispatchError(domain->conn);
2957
    return -1;
2958 2959
}

2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
/**
 * 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)
{
2974
    virConnectPtr conn;
2975

2976
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
2977

2978 2979
    virResetLastError();

2980
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2981
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2982
        virDispatchError(NULL);
2983
        return -1;
2984
    }
2985
    if (domain->conn->flags & VIR_CONNECT_RO) {
2986
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2987
        goto error;
2988
    }
2989

2990 2991
    conn = domain->conn;

2992 2993 2994 2995 2996 2997 2998
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2999

3000
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3001 3002

error:
3003
    virDispatchError(domain->conn);
3004
    return -1;
3005 3006
}

3007
/**
3008
 * virDomainGetName:
3009 3010 3011 3012 3013 3014 3015 3016
 * @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 *
3017 3018
virDomainGetName(virDomainPtr domain)
{
3019
    VIR_DEBUG("domain=%p", domain);
3020

3021 3022
    virResetLastError();

D
Daniel Veillard 已提交
3023
    if (!VIR_IS_DOMAIN(domain)) {
3024
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3025
        virDispatchError(NULL);
3026
        return NULL;
D
Daniel Veillard 已提交
3027
    }
3028
    return domain->name;
3029 3030
}

3031 3032 3033
/**
 * virDomainGetUUID:
 * @domain: a domain object
3034
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
3035 3036 3037 3038 3039 3040
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
3041 3042
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
3043
    VIR_DOMAIN_DEBUG(domain, "uuid=%p", uuid);
3044

3045 3046
    virResetLastError();

D
Daniel Veillard 已提交
3047
    if (!VIR_IS_DOMAIN(domain)) {
3048
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3049
        virDispatchError(NULL);
3050
        return -1;
D
Daniel Veillard 已提交
3051 3052
    }
    if (uuid == NULL) {
3053
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3054
        virDispatchError(domain->conn);
3055
        return -1;
D
Daniel Veillard 已提交
3056 3057
    }

3058 3059
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

3060
    return 0;
3061 3062
}

K
Karel Zak 已提交
3063 3064 3065
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
3066
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
3067
 *
3068
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
3069 3070 3071 3072 3073 3074 3075
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
3076
    unsigned char uuid[VIR_UUID_BUFLEN];
3077 3078

    VIR_DOMAIN_DEBUG(domain, "buf=%p", buf);
3079

3080 3081
    virResetLastError();

K
Karel Zak 已提交
3082
    if (!VIR_IS_DOMAIN(domain)) {
3083
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3084
        virDispatchError(NULL);
3085
        return -1;
K
Karel Zak 已提交
3086 3087
    }
    if (buf == NULL) {
3088
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3089
        goto error;
K
Karel Zak 已提交
3090
    }
3091

K
Karel Zak 已提交
3092
    if (virDomainGetUUID(domain, &uuid[0]))
3093
        goto error;
K
Karel Zak 已提交
3094

3095
    virUUIDFormat(uuid, buf);
3096
    return 0;
3097 3098

error:
3099
    virDispatchError(domain->conn);
3100
    return -1;
K
Karel Zak 已提交
3101 3102
}

3103
/**
3104
 * virDomainGetID:
3105 3106 3107 3108 3109 3110 3111
 * @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
3112 3113
virDomainGetID(virDomainPtr domain)
{
3114
    VIR_DOMAIN_DEBUG(domain);
3115

3116 3117
    virResetLastError();

D
Daniel Veillard 已提交
3118
    if (!VIR_IS_DOMAIN(domain)) {
3119
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3120
        virDispatchError(NULL);
3121
        return (unsigned int)-1;
D
Daniel Veillard 已提交
3122
    }
3123
    return domain->id;
3124 3125
}

3126 3127 3128 3129 3130 3131
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
3132 3133
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
3134 3135
 */
char *
3136 3137
virDomainGetOSType(virDomainPtr domain)
{
3138
    virConnectPtr conn;
3139

3140
    VIR_DOMAIN_DEBUG(domain);
3141

3142 3143 3144
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3145
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3146
        virDispatchError(NULL);
3147
        return NULL;
D
Daniel Veillard 已提交
3148
    }
3149

3150 3151
    conn = domain->conn;

3152 3153 3154 3155 3156 3157 3158
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
3159

3160
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3161 3162

error:
3163
    virDispatchError(domain->conn);
3164
    return NULL;
3165 3166
}

3167
/**
3168
 * virDomainGetMaxMemory:
3169
 * @domain: a domain object or NULL
3170
 *
3171 3172 3173 3174 3175 3176 3177
 * 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
3178 3179
virDomainGetMaxMemory(virDomainPtr domain)
{
3180
    virConnectPtr conn;
3181

3182
    VIR_DOMAIN_DEBUG(domain);
3183

3184 3185
    virResetLastError();

D
Daniel Veillard 已提交
3186
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3187
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3188
        virDispatchError(NULL);
3189
        return 0;
D
Daniel Veillard 已提交
3190
    }
3191

3192 3193
    conn = domain->conn;

3194 3195 3196 3197 3198 3199 3200
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
3201

3202
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3203 3204

error:
3205
    virDispatchError(domain->conn);
3206
    return 0;
3207 3208
}

D
Daniel Veillard 已提交
3209
/**
3210
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
3211 3212
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
3213
 *
D
Daniel Veillard 已提交
3214 3215 3216
 * 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.
3217
 * This function may require privileged access to the hypervisor.
D
Daniel Veillard 已提交
3218
 *
3219 3220 3221
 * This command is hypervisor-specific for whether active, persistent,
 * or both configurations are changed; for more control, use
 * virDomainSetMemoryFlags().
3222
 *
D
Daniel Veillard 已提交
3223 3224 3225
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3226 3227
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
3228
    virConnectPtr conn;
3229 3230

    VIR_DOMAIN_DEBUG(domain, "memory=%lu", memory);
3231

3232 3233
    virResetLastError();

3234
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3235
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3236
        virDispatchError(NULL);
3237
        return -1;
3238
    }
3239
    if (domain->conn->flags & VIR_CONNECT_RO) {
3240
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3241
        goto error;
3242
    }
3243
    if (!memory) {
3244
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3245
        goto error;
3246
    }
3247
    conn = domain->conn;
3248

3249 3250 3251 3252 3253 3254 3255
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3256

3257
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3258 3259

error:
3260
    virDispatchError(domain->conn);
3261
    return -1;
3262
}
3263

3264 3265 3266 3267
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
3268
 *
3269 3270 3271
 * 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.
3272
 * This function may require privileged access to the hypervisor.
3273
 *
3274 3275 3276
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
3277 3278 3279 3280 3281 3282
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
3283 3284

    VIR_DOMAIN_DEBUG(domain, "memory=%lu", memory);
3285

3286 3287
    virResetLastError();

3288
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3289
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3290
        virDispatchError(NULL);
3291
        return -1;
3292
    }
3293
    if (domain->conn->flags & VIR_CONNECT_RO) {
3294
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3295
        goto error;
3296
    }
3297
    if (!memory) {
3298
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3299
        goto error;
3300 3301 3302
    }

    conn = domain->conn;
3303

3304 3305 3306 3307 3308 3309 3310
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3311

3312
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3313 3314

error:
3315
    virDispatchError(domain->conn);
3316
    return -1;
D
Daniel Veillard 已提交
3317 3318
}

3319
/*
3320
 * virDomainSetMemoryFlags:
3321 3322 3323 3324 3325 3326 3327
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
 * @flags: an OR'ed set of virDomainMemoryModFlags
 *
 * 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.
3328
 * This function may require privileged access to the hypervisor.
3329
 *
3330 3331
 * @flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG.
 * Both flags may be set. If VIR_DOMAIN_AFFECT_LIVE is set, the change affects
3332
 * a running domain and will fail if domain is not active.
3333
 * If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state,
3334
 * and will fail for transient domains. If neither flag is specified
3335
 * (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain
3336 3337
 * modifies persistent setup, while an active domain is hypervisor-dependent
 * on whether just live or both live and persistent state is changed.
3338 3339
 * If VIR_DOMAIN_MEM_MAXIMUM is set, the change affects domain's maximum memory
 * size rather than current memory size.
3340
 * Not all hypervisors can support all flag combinations.
3341 3342 3343 3344 3345 3346 3347 3348 3349 3350
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetMemoryFlags(virDomainPtr domain, unsigned long memory,
                        unsigned int flags)
{
    virConnectPtr conn;

E
Eric Blake 已提交
3351
    VIR_DOMAIN_DEBUG(domain, "memory=%lu, flags=%x", memory, flags);
3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365

    virResetLastError();

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

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

3366
    if (!memory) {
3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;

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

3381 3382
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

3383 3384 3385 3386 3387
error:
    virDispatchError(domain->conn);
    return -1;
}

3388 3389 3390 3391
/**
 * virDomainSetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter objects
3392
 * @nparams: number of memory parameter (this value can be the same or
3393
 *          less than the number of parameters supported)
3394
 * @flags: bitwise-OR of virDomainModificationImpact
3395
 *
3396
 * Change all or a subset of the memory tunables.
3397
 * This function may require privileged access to the hypervisor.
3398 3399 3400 3401 3402
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetMemoryParameters(virDomainPtr domain,
3403
                             virTypedParameterPtr params,
3404 3405 3406
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;
3407

3408
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3409
                     params, nparams, flags);
3410 3411 3412 3413

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3414
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3415 3416 3417 3418
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
3419
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3420 3421 3422
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
3423
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435
        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;
    }

3436
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448

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
3449
 * @flags: one of virDomainModificationImpact
3450
 *
3451
 * Get all memory parameters, the @params array will be filled with the values
3452 3453
 * equal to the number of parameters suggested by @nparams
 *
3454 3455 3456
 * 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
3457
 * array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
3458 3459
 * again.
 *
3460
 * Here is a sample code snippet:
3461 3462 3463
 *
 * if ((virDomainGetMemoryParameters(dom, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
3464 3465
 *     if ((params = malloc(sizeof(*params) * nparams)) == NULL)
 *         goto error;
3466
 *     memset(params, 0, sizeof(*params) * nparams);
3467
 *     if (virDomainGetMemoryParameters(dom, params, &nparams, 0))
3468 3469
 *         goto error;
 * }
3470
 *
3471
 * This function may require privileged access to the hypervisor. This function
3472
 * expects the caller to allocate the @params.
3473 3474 3475 3476 3477
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
3478
                             virTypedParameterPtr params,
3479 3480 3481
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
3482

3483
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3484
                     params, (nparams) ? *nparams : -1, flags);
3485 3486 3487 3488

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3489
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3490 3491 3492
        virDispatchError(NULL);
        return -1;
    }
3493 3494
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3495
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506
        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;
    }
3507
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3508 3509 3510 3511 3512 3513

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

3514 3515 3516 3517
/**
 * virDomainSetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter objects
3518
 * @nparams: number of blkio parameters (this value can be the same or
3519
 *          less than the number of parameters supported)
3520
 * @flags: an OR'ed set of virDomainModificationImpact
3521
 *
3522
 * Change all or a subset of the blkio tunables.
3523
 * This function may require privileged access to the hypervisor.
3524 3525 3526 3527 3528
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetBlkioParameters(virDomainPtr domain,
3529
                             virTypedParameterPtr params,
3530 3531 3532 3533
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;

3534
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574
                     params, nparams, flags);

    virResetLastError();

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainGetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter object
 *          (return value, allocated by the caller)
 * @nparams: pointer to number of blkio parameters
3575
 * @flags: an OR'ed set of virDomainModificationImpact
3576
 *
3577 3578 3579
 * Get all blkio parameters, the @params array will be filled with the values
 * equal to the number of parameters suggested by @nparams.
 * See virDomainGetMemoryParameters for an equivalent usage example.
3580
 *
3581
 * This function may require privileged access to the hypervisor. This function
3582 3583 3584 3585 3586 3587
 * expects the caller to allocate the @params.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetBlkioParameters(virDomainPtr domain,
3588
                             virTypedParameterPtr params,
3589 3590 3591 3592
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;

3593
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3594 3595 3596 3597 3598 3599 3600 3601 3602
                     params, (nparams) ? *nparams : -1, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
3603 3604
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

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

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

3624 3625
/**
 * virDomainGetInfo:
3626
 * @domain: a domain object
3627
 * @info: pointer to a virDomainInfo structure allocated by the user
3628
 *
3629
 * Extract information about a domain. Note that if the connection
3630
 * used to get the domain is limited only a partial set of the information
3631 3632 3633 3634 3635
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3636 3637
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3638
    virConnectPtr conn;
3639 3640

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
3641

3642 3643
    virResetLastError();

D
Daniel Veillard 已提交
3644
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3645
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3646
        virDispatchError(NULL);
3647
        return -1;
D
Daniel Veillard 已提交
3648 3649
    }
    if (info == NULL) {
3650
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3651
        goto error;
D
Daniel Veillard 已提交
3652
    }
3653

3654
    memset(info, 0, sizeof(virDomainInfo));
3655

3656 3657
    conn = domain->conn;

3658 3659 3660 3661 3662 3663 3664
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3665

3666
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3667 3668

error:
3669
    virDispatchError(domain->conn);
3670
    return -1;
3671
}
3672

3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693
/**
 * virDomainGetState:
 * @domain: a domain object
 * @state: returned state of the domain (one of virDomainState)
 * @reason: returned reason which led to @state (one of virDomain*Reason
 * corresponding to the current state); it is allowed to be NULL
 * @flags: additional flags, 0 for now.
 *
 * Extract domain state. Each state can be accompanied with a reason (if known)
 * which led to the state.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainGetState(virDomainPtr domain,
                  int *state,
                  int *reason,
                  unsigned int flags)
{
    virConnectPtr conn;

E
Eric Blake 已提交
3694 3695
    VIR_DOMAIN_DEBUG(domain, "state=%p, reason=%p, flags=%x",
                     state, reason, flags);
3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713

    virResetLastError();

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

    conn = domain->conn;
    if (conn->driver->domainGetState) {
        int ret;
        ret = conn->driver->domainGetState(domain, state, reason, flags);
        if (ret < 0)
3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainGetControlInfo:
 * @domain: a domain object
 * @info: pointer to a virDomainControlInfo structure allocated by the user
 * @flags: additional flags, 0 for now
 *
 * Extract details about current state of control interface to a domain.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainGetControlInfo(virDomainPtr domain,
                        virDomainControlInfoPtr info,
                        unsigned int flags)
{
    virConnectPtr conn;

E
Eric Blake 已提交
3742
    VIR_DOMAIN_DEBUG(domain, "info=%p, flags=%x", info, flags);
3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761

    virResetLastError();

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

    if (!info) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;
    if (conn->driver->domainGetControlInfo) {
        int ret;
        ret = conn->driver->domainGetControlInfo(domain, info, flags);
        if (ret < 0)
3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

3773 3774 3775
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3776
 * @flags: an OR'ed set of virDomainXMLFlags
3777 3778
 *
 * Provide an XML description of the domain. The description may be reused
3779
 * later to relaunch the domain with virDomainCreateXML().
3780
 *
3781 3782 3783 3784 3785 3786 3787 3788 3789 3790
 * No security-sensitive data will be included unless @flags contains
 * VIR_DOMAIN_XML_SECURE; this flag is rejected on read-only
 * connections.  If @flags includes VIR_DOMAIN_XML_INACTIVE, then the
 * XML represents the configuration that will be used on the next boot
 * of a persistent domain; otherwise, the configuration represents the
 * currently running domain.  If @flags contains
 * VIR_DOMAIN_XML_UPDATE_CPU, then the portion of the domain XML
 * describing CPU capabilities is modified to match actual
 * capabilities of the host.
 *
3791 3792 3793 3794
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3795
virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)
3796
{
3797
    virConnectPtr conn;
3798

3799
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
3800

3801 3802 3803
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3804
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3805
        virDispatchError(NULL);
3806
        return NULL;
D
Daniel Veillard 已提交
3807
    }
3808

3809 3810
    conn = domain->conn;

3811
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
3812
        virLibConnError(VIR_ERR_OPERATION_DENIED,
3813 3814 3815 3816
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

3817
    if (conn->driver->domainGetXMLDesc) {
3818
        char *ret;
3819
        ret = conn->driver->domainGetXMLDesc(domain, flags);
3820 3821 3822 3823
        if (!ret)
            goto error;
        return ret;
    }
3824

3825
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3826 3827

error:
3828
    virDispatchError(domain->conn);
3829
    return NULL;
3830
}
3831

3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
/**
 * 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)
{
E
Eric Blake 已提交
3851
    VIR_DEBUG("conn=%p, format=%s, config=%s, flags=%x",
3852
              conn, nativeFormat, nativeConfig, flags);
3853 3854 3855 3856

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3857
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3858
        virDispatchError(NULL);
3859
        return NULL;
3860 3861 3862
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
3863
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3864
        goto error;
3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877
    }

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

3878
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3879 3880

error:
3881
    virDispatchError(conn);
3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892
    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 已提交
3893
 * a native configuration file describing the domain.
3894 3895 3896 3897 3898 3899 3900 3901 3902 3903
 * 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)
{
E
Eric Blake 已提交
3904
    VIR_DEBUG("conn=%p, format=%s, xml=%s, flags=%x",
3905
              conn, nativeFormat, domainXml, flags);
3906 3907 3908 3909

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3910
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3911
        virDispatchError(NULL);
3912
        return NULL;
3913
    }
3914 3915 3916 3917
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
3918 3919

    if (nativeFormat == NULL || domainXml == NULL) {
3920
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3921
        goto error;
3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934
    }

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

3935
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3936 3937

error:
3938
    virDispatchError(conn);
3939 3940 3941 3942
    return NULL;
}


3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958
/*
 * Sequence v1:
 *
 *  Dst: Prepare
 *        - Get ready to accept incoming VM
 *        - Generate optional cookie to pass to src
 *
 *  Src: Perform
 *        - Start migration and wait for send completion
 *        - Kill off VM if successful, resume if failed
 *
 *  Dst: Finish
 *        - Wait for recv completion and check status
 *        - Kill off VM if unsuccessful
 *
 */
3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969
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;
3970 3971
    int cookielen = 0, ret;
    virDomainInfo info;
3972
    VIR_DOMAIN_DEBUG(domain,
E
Eric Blake 已提交
3973
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
3974
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
3975 3976 3977 3978 3979

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997

    /* 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) {
3998
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029
                         _("domainMigratePrepare did not set uri"));
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare change URI? */

    /* 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;
}

4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048
/*
 * Sequence v2:
 *
 *  Src: DumpXML
 *        - Generate XML to pass to dst
 *
 *  Dst: Prepare
 *        - Get ready to accept incoming VM
 *        - Generate optional cookie to pass to src
 *
 *  Src: Perform
 *        - Start migration and wait for send completion
 *        - Kill off VM if successful, resume if failed
 *
 *  Dst: Finish
 *        - Wait for recv completion and check status
 *        - Kill off VM if unsuccessful
 *
 */
4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061
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;
4062
    virDomainInfo info;
4063
    virErrorPtr orig_err = NULL;
4064
    int cancelled;
4065
    VIR_DOMAIN_DEBUG(domain,
E
Eric Blake 已提交
4066
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4067
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084

    /* 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.
     */
4085
    if (!domain->conn->driver->domainGetXMLDesc) {
4086
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
4087
        virDispatchError(domain->conn);
4088 4089
        return NULL;
    }
4090 4091 4092
    dom_xml = domain->conn->driver->domainGetXMLDesc(domain,
                                                     VIR_DOMAIN_XML_SECURE |
                                                     VIR_DOMAIN_XML_UPDATE_CPU);
4093 4094 4095
    if (!dom_xml)
        return NULL;

4096 4097 4098 4099 4100
    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }

4101
    VIR_DEBUG("Prepare2 %p flags=%lx", dconn, flags);
4102 4103 4104 4105 4106 4107 4108 4109
    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) {
4110
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
4111
                         _("domainMigratePrepare2 did not set uri"));
4112
        virDispatchError(domain->conn);
4113 4114
        cancelled = 1;
        goto finish;
4115 4116 4117 4118 4119 4120 4121
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare2 change URI? */

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

4126 4127 4128 4129
    /* Perform failed. Make sure Finish doesn't overwrite the error */
    if (ret < 0)
        orig_err = virSaveLastError();

4130 4131 4132 4133 4134 4135
    /* If Perform returns < 0, then we need to cancel the VM
     * startup on the destination
     */
    cancelled = ret < 0 ? 1 : 0;

finish:
4136 4137 4138 4139 4140
    /* 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;
4141
    VIR_DEBUG("Finish2 %p ret=%d", dconn, ret);
4142
    ddomain = dconn->driver->domainMigrateFinish2
4143
        (dconn, dname, cookie, cookielen, uri, flags, cancelled);
4144 4145

 done:
4146 4147 4148 4149
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
4150 4151 4152 4153 4154
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

4155

4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182
/*
 * Sequence v3:
 *
 *  Src: Begin
 *        - Generate XML to pass to dst
 *        - Generate optional cookie to pass to dst
 *
 *  Dst: Prepare
 *        - Get ready to accept incoming VM
 *        - Generate optional cookie to pass to src
 *
 *  Src: Perform
 *        - Start migration and wait for send completion
 *        - Generate optional cookie to pass to dst
 *
 *  Dst: Finish
 *        - Wait for recv completion and check status
 *        - Kill off VM if failed, resume if success
 *        - Generate optional cookie to pass to src
 *
 *  Src: Confirm
 *        - Kill off VM if success, resume if failed
 *
 */
static virDomainPtr
virDomainMigrateVersion3(virDomainPtr domain,
                         virConnectPtr dconn,
4183
                         const char *xmlin,
4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198
                         unsigned long flags,
                         const char *dname,
                         const char *uri,
                         unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookiein = NULL;
    char *cookieout = NULL;
    char *dom_xml = NULL;
    int cookieinlen = 0;
    int cookieoutlen = 0;
    int ret;
    virDomainInfo info;
    virErrorPtr orig_err = NULL;
4199 4200
    int cancelled = 1;
    unsigned long protection = 0;
4201
    bool notify_source = true;
4202

4203
    VIR_DOMAIN_DEBUG(domain, "dconn=%p xmlin=%s, flags=%lx, "
4204 4205 4206
                     "dname=%s, uri=%s, bandwidth=%lu",
                     dconn, NULLSTR(xmlin), flags,
                     NULLSTR(dname), NULLSTR(uri), bandwidth);
4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217

    if (!domain->conn->driver->domainMigrateBegin3 ||
        !domain->conn->driver->domainMigratePerform3 ||
        !domain->conn->driver->domainMigrateConfirm3 ||
        !dconn->driver->domainMigratePrepare3 ||
        !dconn->driver->domainMigrateFinish3) {
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
        virDispatchError(domain->conn);
        return NULL;
    }

4218 4219 4220 4221
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATE_CHANGE_PROTECTION))
        protection = VIR_MIGRATE_CHANGE_PROTECTION;

4222 4223
    VIR_DEBUG("Begin3 %p", domain->conn);
    dom_xml = domain->conn->driver->domainMigrateBegin3
4224
        (domain, xmlin, &cookieout, &cookieoutlen,
4225
         flags | protection, dname, bandwidth);
4226 4227 4228 4229 4230 4231 4232 4233
    if (!dom_xml)
        goto done;

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

4234
    VIR_DEBUG("Prepare3 %p flags=%lx", dconn, flags);
4235 4236 4237 4238 4239 4240 4241 4242
    cookiein = cookieout;
    cookieinlen = cookieoutlen;
    cookieout = NULL;
    cookieoutlen = 0;
    ret = dconn->driver->domainMigratePrepare3
        (dconn, cookiein, cookieinlen, &cookieout, &cookieoutlen,
         uri, &uri_out, flags, dname, bandwidth, dom_xml);
    VIR_FREE (dom_xml);
4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253
    if (ret == -1) {
        if (protection) {
            /* Begin already started a migration job so we need to cancel it by
             * calling Confirm while making sure it doesn't overwrite the error
             */
            orig_err = virSaveLastError();
            goto confirm;
        } else {
            goto done;
        }
    }
4254 4255 4256 4257 4258

    if (uri == NULL && uri_out == NULL) {
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("domainMigratePrepare3 did not set uri"));
        virDispatchError(domain->conn);
4259
        goto finish;
4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare3 change URI? */

    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete. The src VM should remain
     * running, but in paused state until the destination can
     * confirm migration completion.
     */
    VIR_DEBUG("Perform3 %p uri=%s", domain->conn, uri);
    VIR_FREE(cookiein);
    cookiein = cookieout;
    cookieinlen = cookieoutlen;
    cookieout = NULL;
    cookieoutlen = 0;
4275
    /* dconnuri not relevant in non-P2P modes, so left NULL here */
4276
    ret = domain->conn->driver->domainMigratePerform3
4277
        (domain, NULL, cookiein, cookieinlen,
4278
         &cookieout, &cookieoutlen, NULL,
4279
         uri, flags | protection, dname, bandwidth);
4280 4281

    /* Perform failed. Make sure Finish doesn't overwrite the error */
4282
    if (ret < 0) {
4283
        orig_err = virSaveLastError();
4284 4285 4286 4287 4288
        /* Perform failed so we don't need to call confirm to let source know
         * about the failure.
         */
        notify_source = false;
    }
4289 4290 4291 4292 4293 4294

    /* If Perform returns < 0, then we need to cancel the VM
     * startup on the destination
     */
    cancelled = ret < 0 ? 1 : 0;

4295
finish:
4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308
    /*
     * The status code from the source is passed to the destination.
     * The dest can cleanup if the source indicated it failed to
     * send all migration data. Returns NULL for ddomain if
     * the dest was unable to complete migration.
     */
    VIR_DEBUG("Finish3 %p ret=%d", dconn, ret);
    VIR_FREE(cookiein);
    cookiein = cookieout;
    cookieinlen = cookieoutlen;
    cookieout = NULL;
    cookieoutlen = 0;
    dname = dname ? dname : domain->name;
4309
    ddomain = dconn->driver->domainMigrateFinish3
4310
        (dconn, dname, cookiein, cookieinlen, &cookieout, &cookieoutlen,
4311 4312 4313 4314 4315 4316 4317 4318 4319
         NULL, uri, flags, cancelled);

    /* If ddomain is NULL, then we were unable to start
     * the guest on the target, and must restart on the
     * source. There is a small chance that the ddomain
     * is NULL due to an RPC failure, in which case
     * ddomain could in fact be running on the dest.
     * The lock manager plugins should take care of
     * safety in this scenario.
4320
     */
4321
    cancelled = ddomain == NULL ? 1 : 0;
4322

4323 4324 4325 4326 4327 4328
    /* If finish3 set an error, and we don't have an earlier
     * one we need to preserve it in case confirm3 overwrites
     */
    if (!orig_err)
        orig_err = virSaveLastError();

4329
confirm:
4330
    /*
4331 4332 4333
     * If cancelled, then src VM will be restarted, else it will be killed.
     * Don't do this if migration failed on source and thus it was already
     * cancelled there.
4334
     */
4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353
    if (notify_source) {
        VIR_DEBUG("Confirm3 %p ret=%d domain=%p", domain->conn, ret, domain);
        VIR_FREE(cookiein);
        cookiein = cookieout;
        cookieinlen = cookieoutlen;
        cookieout = NULL;
        cookieoutlen = 0;
        ret = domain->conn->driver->domainMigrateConfirm3
            (domain, cookiein, cookieinlen,
             flags | protection, cancelled);
        /* If Confirm3 returns -1, there's nothing more we can
         * do, but fortunately worst case is that there is a
         * domain left in 'paused' state on source.
         */
        if (ret < 0) {
            VIR_WARN("Guest %s probably left in 'paused' state on source",
                     domain->name);
        }
    }
4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366

 done:
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
    VIR_FREE(uri_out);
    VIR_FREE(cookiein);
    VIR_FREE(cookieout);
    return ddomain;
}


4367
 /*
4368
  * In normal migration, the libvirt client co-ordinates communication
4369
  * between the 2 libvirtd instances on source & dest hosts.
4370
  *
4371 4372 4373 4374
  * In this peer-2-peer migration alternative, the libvirt client
  * only talks to the source libvirtd instance. The source libvirtd
  * then opens its own connection to the destination and co-ordinates
  * migration itself.
4375 4376 4377
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
4378
                           const char *xmlin,
4379 4380
                           unsigned long flags,
                           const char *dname,
4381
                           const char *dconnuri,
4382 4383 4384
                           const char *uri,
                           unsigned long bandwidth)
{
4385
    xmlURIPtr tempuri = NULL;
4386
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s, flags=%lx, dname=%s, "
4387 4388 4389
                     "dconnuri=%s, uri=%s, bandwidth=%lu",
                     NULLSTR(xmlin), flags, NULLSTR(dname),
                     NULLSTR(dconnuri), NULLSTR(uri), bandwidth);
4390

4391
    if (!domain->conn->driver->domainMigratePerform) {
4392
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4393
        virDispatchError(domain->conn);
4394 4395 4396
        return -1;
    }

4397
    tempuri = xmlParseURI(dconnuri);
4398
    if (!tempuri) {
4399
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4400 4401 4402 4403 4404
        virDispatchError(domain->conn);
        return -1;
    }

    if (!tempuri->server || STRPREFIX(tempuri->server, "localhost")) {
4405
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4406 4407 4408 4409 4410 4411
        virDispatchError(domain->conn);
        xmlFreeURI(tempuri);
        return -1;
    }
    xmlFreeURI(tempuri);

4412 4413 4414
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
4415 4416 4417 4418
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATION_V3)) {
        VIR_DEBUG("Using migration protocol 3");
        return domain->conn->driver->domainMigratePerform3(domain,
4419
                                                           xmlin,
4420 4421 4422 4423
                                                           NULL, /* cookiein */
                                                           0,    /* cookieinlen */
                                                           NULL, /* cookieoutlen */
                                                           NULL, /* cookieoutlen */
4424
                                                           dconnuri,
4425 4426 4427 4428 4429 4430
                                                           uri,
                                                           flags,
                                                           dname,
                                                           bandwidth);
    } else {
        VIR_DEBUG("Using migration protocol 2");
4431 4432 4433 4434 4435
        if (xmlin) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to change target guest XML during migration"));
            return -1;
        }
4436 4437 4438 4439 4440
        if (uri) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to override peer2peer migration URI"));
            return -1;
        }
4441 4442 4443
        return domain->conn->driver->domainMigratePerform(domain,
                                                          NULL, /* cookie */
                                                          0,    /* cookielen */
4444
                                                          dconnuri,
4445 4446 4447 4448
                                                          flags,
                                                          dname,
                                                          bandwidth);
    }
4449 4450 4451
}


C
Chris Lalancette 已提交
4452
/*
4453
 * In normal migration, the libvirt client co-ordinates communication
4454
 * between the 2 libvirtd instances on source & dest hosts.
C
Chris Lalancette 已提交
4455
 *
4456 4457 4458
 * Some hypervisors support an alternative, direct migration where
 * there is no requirement for a libvirtd instance on the dest host.
 * In this case
4459
 *
4460 4461
 * 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 已提交
4462
 */
4463 4464
static int
virDomainMigrateDirect (virDomainPtr domain,
4465
                        const char *xmlin,
4466 4467 4468 4469 4470
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
4471 4472 4473 4474
    VIR_DOMAIN_DEBUG(domain,
                     "xmlin=%s, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
                     NULLSTR(xmlin), flags, NULLSTR(dname), NULLSTR(uri),
                     bandwidth);
4475

4476
    if (!domain->conn->driver->domainMigratePerform) {
4477
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4478
        virDispatchError(domain->conn);
4479 4480 4481
        return -1;
    }

C
Chris Lalancette 已提交
4482 4483 4484
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
4485 4486 4487
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATION_V3)) {
        VIR_DEBUG("Using migration protocol 3");
4488 4489
        /* dconn URI not relevant in direct migration, since no
         * target libvirtd is involved */
4490
        return domain->conn->driver->domainMigratePerform3(domain,
4491
                                                           xmlin,
4492 4493 4494 4495
                                                           NULL, /* cookiein */
                                                           0,    /* cookieinlen */
                                                           NULL, /* cookieoutlen */
                                                           NULL, /* cookieoutlen */
4496
                                                           NULL, /* dconnuri */
4497 4498 4499 4500 4501 4502
                                                           uri,
                                                           flags,
                                                           dname,
                                                           bandwidth);
    } else {
        VIR_DEBUG("Using migration protocol 2");
4503 4504 4505 4506 4507
        if (xmlin) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to change target guest XML during migration"));
            return -1;
        }
4508 4509 4510 4511 4512 4513 4514 4515
        return domain->conn->driver->domainMigratePerform(domain,
                                                          NULL, /* cookie */
                                                          0,    /* cookielen */
                                                          uri,
                                                          flags,
                                                          dname,
                                                          bandwidth);
    }
C
Chris Lalancette 已提交
4516 4517
}

4518

4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531
/**
 * 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:
4532 4533 4534
 *   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 已提交
4535 4536 4537 4538
 *   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.
4539
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
4540 4541 4542
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
4543 4544 4545 4546 4547
 *
 * 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.
4548 4549 4550 4551 4552 4553
 *
 * 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.
 *
4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564
 * 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.
 *
4565
 * In either case it is typically only necessary to specify a
4566 4567
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595
 *
 * 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;
4596

4597 4598
    VIR_DOMAIN_DEBUG(domain,
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4599
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4600

4601 4602
    virResetLastError();

4603
    /* First checkout the source */
4604
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4605
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4606
        virDispatchError(NULL);
4607 4608
        return NULL;
    }
4609
    if (domain->conn->flags & VIR_CONNECT_RO) {
4610
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4611
        goto error;
4612 4613
    }

4614 4615
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
4616
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4617 4618 4619 4620
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
4621
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4622 4623 4624
        goto error;
    }

4625 4626 4627 4628 4629 4630
    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);
4631
                if (!dstURI)
4632 4633
                    return NULL;
            }
4634

4635
            VIR_DEBUG("Using peer2peer migration");
4636
            if (virDomainMigratePeer2Peer(domain, NULL, flags, dname,
4637
                                          uri ? uri : dstURI, NULL, bandwidth) < 0) {
4638 4639 4640 4641
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
4642

4643 4644 4645
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
4646
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4647 4648
            goto error;
        }
4649
    } else {
4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662
        /* Change protection requires support only on source side, and
         * is only needed in v3 migration, which automatically re-adds
         * the flag for just the source side.  We mask it out for
         * non-peer2peer to allow migration from newer source to an
         * older destination that rejects the flag.  */
        if (flags & VIR_MIGRATE_CHANGE_PROTECTION &&
            !VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATE_CHANGE_PROTECTION)) {
            virLibConnError(VIR_ERR_ARGUMENT_UNSUPPORTED, "%s",
                            _("cannot enforce change protection"));
            goto error;
        }
        flags &= ~VIR_MIGRATE_CHANGE_PROTECTION;
4663
        if (flags & VIR_MIGRATE_TUNNELLED) {
4664
            virLibConnError(VIR_ERR_OPERATION_INVALID,
4665 4666 4667 4668
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
4669 4670
        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
4671
                                     VIR_DRV_FEATURE_MIGRATION_V3) &&
C
Chris Lalancette 已提交
4672
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
4673 4674
                                     VIR_DRV_FEATURE_MIGRATION_V3)) {
            VIR_DEBUG("Using migration protocol 3");
4675 4676
            ddomain = virDomainMigrateVersion3(domain, dconn, NULL,
                                               flags, dname, uri, bandwidth);
4677 4678 4679 4680 4681
        } 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)) {
            VIR_DEBUG("Using migration protocol 2");
4682 4683
            ddomain = virDomainMigrateVersion2(domain, dconn, flags,
                                               dname, uri, bandwidth);
4684 4685 4686 4687 4688
        } else 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)) {
            VIR_DEBUG("Using migration protocol 1");
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 4729 4730
            ddomain = virDomainMigrateVersion1(domain, dconn, flags,
                                               dname, uri, bandwidth);
        } else {
            /* This driver does not support any migration method */
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
    }

    if (ddomain == NULL)
        goto error;

    return ddomain;

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


/**
 * virDomainMigrate2:
 * @domain: a domain object
 * @dconn: destination host (a connection object)
 * @flags: flags
 * @dxml: (optional) XML config for launching guest on target
 * @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:
 *   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
 *   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.
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
4731 4732 4733
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773
 *
 * 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.
 *
 * 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.
 *
 * 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.
 *
 * In either case it is typically only necessary to specify a
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
 *
 * 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.
 *
4774 4775 4776 4777 4778 4779 4780 4781 4782
 * If the hypervisor supports it, @dxml can be used to alter
 * host-specific portions of the domain XML that will be used on
 * the destination.  For example, it is possible to alter the
 * backing filename that is associated with a disk device, in order
 * to account for naming differences between source and destination
 * in accessing the underlying storage.  The migration will fail
 * if @dxml would cause any guest-visible changes.  Pass NULL
 * if no changes are needed to the XML between source and destination.
 *
4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797
 * 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
virDomainMigrate2(virDomainPtr domain,
                  virConnectPtr dconn,
                  const char *dxml,
                  unsigned long flags,
                  const char *dname,
                  const char *uri,
                  unsigned long bandwidth)
{
    virDomainPtr ddomain = NULL;

4798 4799
    VIR_DOMAIN_DEBUG(domain,
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
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 4845 4846 4847
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
            char *dstURI = virConnectGetURI(dconn);
            if (!dstURI)
                return NULL;

            VIR_DEBUG("Using peer2peer migration");
            if (virDomainMigratePeer2Peer(domain, dxml, flags, dname,
                                          dstURI, uri, bandwidth) < 0) {
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);

            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
            goto error;
        }
    } else {
4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860
        /* Change protection requires support only on source side, and
         * is only needed in v3 migration, which automatically re-adds
         * the flag for just the source side.  We mask it out for
         * non-peer2peer to allow migration from newer source to an
         * older destination that rejects the flag.  */
        if (flags & VIR_MIGRATE_CHANGE_PROTECTION &&
            !VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATE_CHANGE_PROTECTION)) {
            virLibConnError(VIR_ERR_ARGUMENT_UNSUPPORTED, "%s",
                            _("cannot enforce change protection"));
            goto error;
        }
        flags &= ~VIR_MIGRATE_CHANGE_PROTECTION;
4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898
        if (flags & VIR_MIGRATE_TUNNELLED) {
            virLibConnError(VIR_ERR_OPERATION_INVALID,
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                     VIR_DRV_FEATURE_MIGRATION_V3) &&
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
                                     VIR_DRV_FEATURE_MIGRATION_V3)) {
            VIR_DEBUG("Using migration protocol 3");
            ddomain = virDomainMigrateVersion3(domain, dconn, dxml,
                                               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)) {
            VIR_DEBUG("Using migration protocol 2");
            if (dxml) {
                virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                                _("Unable to change target guest XML during migration"));
                goto error;
            }
            ddomain = virDomainMigrateVersion2(domain, dconn, flags,
                                               dname, uri, bandwidth);
        } else 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)) {
            VIR_DEBUG("Using migration protocol 1");
            if (dxml) {
                virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                                _("Unable to change target guest XML during migration"));
                goto error;
            }
            ddomain = virDomainMigrateVersion1(domain, dconn, flags,
                                               dname, uri, bandwidth);
4899
        } else {
4900
            /* This driver does not support any migration method */
4901
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
4902 4903
            goto error;
        }
4904 4905
    }

4906 4907
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
4908

4909
    return ddomain;
4910 4911

error:
4912
    virDispatchError(domain->conn);
4913
    return NULL;
4914 4915
}

4916 4917 4918 4919 4920 4921 4922 4923 4924 4925

/**
 * 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 已提交
4926
 * host given by duri.
4927 4928 4929 4930 4931
 *
 * 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
4932 4933 4934 4935
 *   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.
4936 4937 4938
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
4939
 *
4940 4941 4942 4943 4944 4945 4946 4947 4948 4949
 * 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
4950
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
4951
 * libvirt driver can connect to the destination libvirt.
4952
 *
4953 4954 4955 4956 4957 4958 4959
 * 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.
4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983
 *
 * 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)
{
4984
    VIR_DOMAIN_DEBUG(domain, "duri=%p, flags=%lx, dname=%s, bandwidth=%lu",
4985
                     NULLSTR(duri), flags, NULLSTR(dname), bandwidth);
4986 4987 4988 4989 4990

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4991
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4992
        virDispatchError(NULL);
4993 4994 4995
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
4996
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4997 4998 4999 5000
        goto error;
    }

    if (duri == NULL) {
5001
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5002 5003 5004 5005 5006 5007
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
5008
            VIR_DEBUG("Using peer2peer migration");
5009
            if (virDomainMigratePeer2Peer(domain, NULL, flags,
5010
                                          dname, duri, NULL, bandwidth) < 0)
5011 5012 5013
                goto error;
        } else {
            /* No peer to peer migration supported */
5014
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5015 5016 5017 5018 5019
            goto error;
        }
    } else {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_DIRECT)) {
5020
            VIR_DEBUG("Using direct migration");
5021 5022
            if (virDomainMigrateDirect(domain, NULL, flags,
                                       dname, duri, bandwidth) < 0)
5023 5024 5025
                goto error;
        } else {
            /* Cannot do a migration with only the perform step */
5026
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5027 5028 5029 5030 5031 5032 5033
            goto error;
        }
    }

    return 0;

error:
5034
    virDispatchError(domain->conn);
5035 5036 5037 5038
    return -1;
}


5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059
/**
 * virDomainMigrateToURI2:
 * @domain: a domain object
 * @dconnuri: (optional) URI for target libvirtd if @flags includes VIR_MIGRATE_PEER2PEER
 * @miguri: (optional) URI for invoking the migration, not if @flags includs VIR_MIGRATE_TUNNELLED
 * @dxml: (optional) XML config for launching guest on target
 * @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
 * host given by duri.
 *
 * 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
 *   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.
5060 5061 5062
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
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 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120
 *
 * The operation of this API hinges on the VIR_MIGRATE_PEER2PEER flag.
 *
 * If the VIR_MIGRATE_PEER2PEER flag is set, the @dconnuri parameter
 * must be a valid libvirt connection URI, by which the source
 * libvirt driver can connect to the destination libvirt. If the
 * VIR_MIGRATE_PEER2PEER flag is NOT set, then @dconnuri must be
 * NULL.
 *
 * If the VIR_MIGRATE_TUNNELLED flag is NOT set, then the @miguri
 * parameter allows specification of a URI to use to initiate the
 * VM migration. It takes a hypervisor specific format. The uri_transports
 * element of the hypervisor capabilities XML includes details of the
 * supported URI schemes.
 *
 * VIR_MIGRATE_TUNNELLED requires that VIR_MIGRATE_PEER2PEER be set.
 *
 * If a hypervisor supports changing the configuration of the guest
 * during migration, the @dxml parameter specifies the new config
 * for the guest. The configuration must include an identical set
 * of virtual devices, to ensure a stable guest ABI across migration.
 * Only parameters related to host side configuration can be
 * changed in the XML. Hypervisors will validate this and refuse to
 * allow migration if the provided XML would cause a change in the
 * guest ABI,
 *
 * 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.
 *
 * 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
virDomainMigrateToURI2(virDomainPtr domain,
                       const char *dconnuri,
                       const char *miguri,
                       const char *dxml,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    VIR_DOMAIN_DEBUG(domain, "dconnuri=%s, miguri=%s, dxml=%s, "
5121
                     "flags=%lx, dname=%s, bandwidth=%lu",
5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171
                     NULLSTR(dconnuri), NULLSTR(miguri), NULLSTR(dxml),
                     flags, NULLSTR(dname), bandwidth);

    virResetLastError();

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

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

    return 0;

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


D
Daniel Veillard 已提交
5172 5173
/*
 * Not for public use.  This function is part of the internal
5174 5175 5176
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5177
virDomainMigratePrepare (virConnectPtr dconn,
5178 5179 5180 5181 5182 5183 5184
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
5185
{
J
John Levon 已提交
5186
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, "
5187
              "flags=%lx, dname=%s, bandwidth=%lu", dconn, cookie, cookielen,
J
John Levon 已提交
5188
              NULLSTR(uri_in), uri_out, flags, NULLSTR(dname), bandwidth);
5189

5190 5191
    virResetLastError();

5192
    if (!VIR_IS_CONNECT (dconn)) {
5193
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5194
        virDispatchError(NULL);
5195 5196 5197
        return -1;
    }

5198
    if (dconn->flags & VIR_CONNECT_RO) {
5199
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5200
        goto error;
5201 5202
    }

5203 5204 5205 5206 5207 5208 5209 5210 5211
    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;
    }
5212

5213
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5214 5215

error:
5216
    virDispatchError(dconn);
5217 5218 5219
    return -1;
}

D
Daniel Veillard 已提交
5220 5221
/*
 * Not for public use.  This function is part of the internal
5222 5223 5224
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5225
virDomainMigratePerform (virDomainPtr domain,
5226 5227 5228 5229 5230 5231 5232 5233
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
5234

5235
    VIR_DOMAIN_DEBUG(domain, "cookie=%p, cookielen=%d, uri=%s, flags=%lx, "
5236 5237
                     "dname=%s, bandwidth=%lu", cookie, cookielen, uri, flags,
                     NULLSTR(dname), bandwidth);
5238

5239 5240 5241
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
5242
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5243
        virDispatchError(NULL);
5244 5245 5246 5247
        return -1;
    }
    conn = domain->conn;

5248
    if (domain->conn->flags & VIR_CONNECT_RO) {
5249
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5250
        goto error;
5251 5252
    }

5253 5254 5255 5256 5257 5258 5259 5260 5261
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
5262

5263
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5264 5265

error:
5266
    virDispatchError(domain->conn);
5267 5268 5269
    return -1;
}

D
Daniel Veillard 已提交
5270 5271
/*
 * Not for public use.  This function is part of the internal
5272 5273 5274
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
5275
virDomainMigrateFinish (virConnectPtr dconn,
5276 5277 5278 5279 5280 5281
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
5282
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
5283
              "flags=%lx", dconn, NULLSTR(dname), cookie, cookielen,
J
John Levon 已提交
5284
              uri, flags);
5285

5286 5287
    virResetLastError();

5288
    if (!VIR_IS_CONNECT (dconn)) {
5289
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5290
        virDispatchError(NULL);
5291 5292 5293
        return NULL;
    }

5294
    if (dconn->flags & VIR_CONNECT_RO) {
5295
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5296
        goto error;
5297 5298
    }

5299 5300 5301 5302 5303 5304 5305 5306 5307
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
5308

5309
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5310 5311

error:
5312
    virDispatchError(dconn);
5313
    return NULL;
D
Daniel Veillard 已提交
5314 5315 5316
}


D
Daniel Veillard 已提交
5317 5318
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
5319 5320 5321
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5322 5323 5324 5325 5326 5327 5328 5329 5330
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 已提交
5331
{
J
John Levon 已提交
5332
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p,"
5333
              "flags=%lx, dname=%s, bandwidth=%lu, dom_xml=%s", dconn,
J
John Levon 已提交
5334 5335
              cookie, cookielen, uri_in, uri_out, flags, NULLSTR(dname),
              bandwidth, dom_xml);
D
Daniel Veillard 已提交
5336

5337 5338
    virResetLastError();

D
Daniel Veillard 已提交
5339
    if (!VIR_IS_CONNECT (dconn)) {
5340
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5341
        virDispatchError(NULL);
D
Daniel Veillard 已提交
5342 5343 5344
        return -1;
    }

5345
    if (dconn->flags & VIR_CONNECT_RO) {
5346
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5347
        goto error;
5348 5349
    }

5350 5351 5352 5353 5354 5355 5356 5357 5358 5359
    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 已提交
5360

5361
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5362 5363

error:
5364
    virDispatchError(dconn);
D
Daniel Veillard 已提交
5365 5366 5367
    return -1;
}

D
Daniel Veillard 已提交
5368 5369
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
5370 5371 5372
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
5373 5374 5375 5376 5377 5378 5379
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
5380
{
J
John Levon 已提交
5381
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
5382
              "flags=%lx, retcode=%d", dconn, NULLSTR(dname), cookie,
J
John Levon 已提交
5383
              cookielen, uri, flags, retcode);
D
Daniel Veillard 已提交
5384

5385 5386
    virResetLastError();

D
Daniel Veillard 已提交
5387
    if (!VIR_IS_CONNECT (dconn)) {
5388
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5389
        virDispatchError(NULL);
D
Daniel Veillard 已提交
5390 5391 5392
        return NULL;
    }

5393
    if (dconn->flags & VIR_CONNECT_RO) {
5394
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5395
        goto error;
5396 5397
    }

5398 5399 5400 5401 5402 5403 5404 5405 5406 5407
    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 已提交
5408

5409
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5410 5411

error:
5412
    virDispatchError(dconn);
D
Daniel Veillard 已提交
5413
    return NULL;
5414 5415 5416
}


C
Chris Lalancette 已提交
5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428
/*
 * 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)
{
5429
    VIR_DEBUG("conn=%p, stream=%p, flags=%lx, dname=%s, "
5430
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
5431 5432 5433 5434 5435
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
5436
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5437
        virDispatchError(NULL);
C
Chris Lalancette 已提交
5438 5439 5440 5441
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
5442
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
5443 5444 5445 5446
        goto error;
    }

    if (conn != st->conn) {
5447
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
5448 5449 5450 5451
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
5452
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
5453 5454 5455 5456 5457 5458 5459
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

5460
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
5461 5462

error:
5463
    virDispatchError(conn);
C
Chris Lalancette 已提交
5464 5465 5466
    return -1;
}

5467 5468 5469 5470 5471 5472
/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
char *
virDomainMigrateBegin3(virDomainPtr domain,
5473
                       const char *xmlin,
5474 5475 5476 5477 5478 5479 5480 5481
                       char **cookieout,
                       int *cookieoutlen,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    virConnectPtr conn;

5482
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s cookieout=%p, cookieoutlen=%p, "
5483
                     "flags=%lx, dname=%s, bandwidth=%lu",
5484
                     NULLSTR(xmlin), cookieout, cookieoutlen, flags,
5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502
                     NULLSTR(dname), bandwidth);

    virResetLastError();

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

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

    if (conn->driver->domainMigrateBegin3) {
        char *xml;
5503
        xml = conn->driver->domainMigrateBegin3(domain, xmlin,
5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536
                                                cookieout, cookieoutlen,
                                                flags, dname, bandwidth);
        VIR_DEBUG("xml %s", NULLSTR(xml));
        if (!xml)
            goto error;
        return xml;
    }

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
virDomainMigratePrepare3(virConnectPtr dconn,
                         const char *cookiein,
                         int cookieinlen,
                         char **cookieout,
                         int *cookieoutlen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth,
                         const char *dom_xml)
{
5537 5538 5539 5540 5541
    VIR_DEBUG("dconn=%p, cookiein=%p, cookieinlen=%d, cookieout=%p, "
              "cookieoutlen=%p, uri_in=%s, uri_out=%p, flags=%lx, dname=%s, "
              "bandwidth=%lu, dom_xml=%s",
              dconn, cookiein, cookieinlen, cookieout, cookieoutlen, uri_in,
              uri_out, flags, NULLSTR(dname), bandwidth, dom_xml);
5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592

    virResetLastError();

    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

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

    if (dconn->driver->domainMigratePrepare3) {
        int ret;
        ret = dconn->driver->domainMigratePrepare3(dconn,
                                                   cookiein, cookieinlen,
                                                   cookieout, cookieoutlen,
                                                   uri_in, uri_out,
                                                   flags, dname, bandwidth,
                                                   dom_xml);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(dconn);
    return -1;
}

/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
virDomainMigratePrepareTunnel3(virConnectPtr conn,
                               virStreamPtr st,
                               const char *cookiein,
                               int cookieinlen,
                               char **cookieout,
                               int *cookieoutlen,
                               unsigned long flags,
                               const char *dname,
                               unsigned long bandwidth,
                               const char *dom_xml)

{
5593 5594 5595
    VIR_DEBUG("conn=%p, stream=%p, cookiein=%p, cookieinlen=%d, cookieout=%p, "
              "cookieoutlen=%p, flags=%lx, dname=%s, bandwidth=%lu, "
              "dom_xml=%s",
5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641
              conn, st, cookiein, cookieinlen, cookieout, cookieoutlen, flags,
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

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

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

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

    if (conn->driver->domainMigratePrepareTunnel3) {
        int rv = conn->driver->domainMigratePrepareTunnel3(conn, st,
                                                           cookiein, cookieinlen,
                                                           cookieout, cookieoutlen,
                                                           flags, dname,
                                                           bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
virDomainMigratePerform3(virDomainPtr domain,
5642
                         const char *xmlin,
5643 5644 5645 5646
                         const char *cookiein,
                         int cookieinlen,
                         char **cookieout,
                         int *cookieoutlen,
5647
                         const char *dconnuri,
5648 5649 5650 5651 5652 5653 5654
                         const char *uri,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
{
    virConnectPtr conn;

5655
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s cookiein=%p, cookieinlen=%d, "
5656
                     "cookieout=%p, cookieoutlen=%p, dconnuri=%s, "
5657
                     "uri=%s, flags=%lx, dname=%s, bandwidth=%lu",
5658
                     NULLSTR(xmlin), cookiein, cookieinlen,
5659 5660
                     cookieout, cookieoutlen, NULLSTR(dconnuri),
                     NULLSTR(uri), flags, NULLSTR(dname), bandwidth);
5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677

    virResetLastError();

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

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

    if (conn->driver->domainMigratePerform3) {
        int ret;
5678
        ret = conn->driver->domainMigratePerform3(domain, xmlin,
5679 5680
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
5681
                                                  dconnuri, uri,
5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
5700
virDomainPtr
5701 5702 5703 5704 5705 5706
virDomainMigrateFinish3(virConnectPtr dconn,
                        const char *dname,
                        const char *cookiein,
                        int cookieinlen,
                        char **cookieout,
                        int *cookieoutlen,
5707
                        const char *dconnuri,
5708 5709
                        const char *uri,
                        unsigned long flags,
5710
                        int cancelled)
5711 5712
{
    VIR_DEBUG("dconn=%p, dname=%s, cookiein=%p, cookieinlen=%d, cookieout=%p,"
5713
              "cookieoutlen=%p, dconnuri=%s, uri=%s, flags=%lx, retcode=%d",
5714
              dconn, NULLSTR(dname), cookiein, cookieinlen, cookieout,
5715
              cookieoutlen, NULLSTR(dconnuri), NULLSTR(uri), flags, cancelled);
5716 5717 5718 5719 5720 5721

    virResetLastError();

    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
5722
        return NULL;
5723 5724 5725 5726 5727 5728 5729 5730
    }

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

    if (dconn->driver->domainMigrateFinish3) {
5731
        virDomainPtr ret;
5732 5733 5734
        ret = dconn->driver->domainMigrateFinish3(dconn, dname,
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
5735
                                                  dconnuri, uri, flags,
5736 5737
                                                  cancelled);
        if (!ret)
5738 5739 5740 5741 5742 5743 5744 5745
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(dconn);
5746
    return NULL;
5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762
}


/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
virDomainMigrateConfirm3(virDomainPtr domain,
                         const char *cookiein,
                         int cookieinlen,
                         unsigned long flags,
                         int cancelled)
{
    virConnectPtr conn;

5763 5764
    VIR_DOMAIN_DEBUG(domain,
                     "cookiein=%p, cookieinlen=%d, flags=%lx, cancelled=%d",
5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797
                     cookiein, cookieinlen, flags, cancelled);

    virResetLastError();

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

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

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

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

C
Chris Lalancette 已提交
5798

5799 5800 5801 5802
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
5803
 *
5804 5805 5806 5807 5808
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
5809 5810
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
5811
    VIR_DEBUG("conn=%p, info=%p", conn, info);
5812

5813 5814
    virResetLastError();

5815
    if (!VIR_IS_CONNECT(conn)) {
5816
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5817
        virDispatchError(NULL);
5818
        return -1;
5819 5820
    }
    if (info == NULL) {
5821
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5822
        goto error;
5823 5824
    }

5825 5826 5827 5828 5829 5830 5831
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
5832

5833
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5834 5835

error:
5836
    virDispatchError(conn);
5837
    return -1;
5838
}
5839

5840 5841 5842 5843 5844 5845
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
5846 5847
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
5848 5849 5850 5851 5852
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
5853
    VIR_DEBUG("conn=%p", conn);
5854

5855 5856
    virResetLastError();

5857
    if (!VIR_IS_CONNECT (conn)) {
5858
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5859
        virDispatchError(NULL);
5860 5861 5862
        return NULL;
    }

5863 5864 5865 5866 5867
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
5868
        VIR_DEBUG("conn=%p ret=%s", conn, ret);
5869 5870
        return ret;
    }
5871

5872
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5873 5874

error:
5875
    virDispatchError(conn);
5876 5877 5878
    return NULL;
}

5879 5880 5881
/**
 * virNodeGetCPUStats:
 * @conn: pointer to the hypervisor connection.
5882
 * @cpuNum: number of node cpu. (VIR_NODE_CPU_STATS_ALL_CPUS means total cpu
5883 5884 5885 5886 5887 5888 5889 5890
 *          statistics)
 * @params: pointer to node cpu time parameter objects
 * @nparams: number of node cpu time parameter (this value should be same or
 *          less than the number of parameters supported)
 * @flags: currently unused, for future extension. always pass 0.
 *
 * This function provides individual cpu statistics of the node.
 * If you want to get total cpu statistics of the node, you must specify
5891
 * VIR_NODE_CPU_STATS_ALL_CPUS to @cpuNum.
5892 5893 5894 5895 5896 5897
 * The @params array will be filled with the values equal to the number of
 * parameters suggested by @nparams
 *
 * 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
5898
 * array, i.e. (sizeof(@virNodeCPUStats) * @nparams) bytes and call
5899 5900 5901 5902 5903 5904
 * the API again.
 *
 * Here is a sample code snippet:
 *
 * if ((virNodeGetCPUStats(conn, cpuNum, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
5905
 *     if ((params = malloc(sizeof(virNodeCPUStats) * nparams)) == NULL)
5906
 *         goto error;
5907
 *     memset(params, 0, sizeof(virNodeCPUStats) * nparams);
5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934
 *     if (virNodeGetCPUStats(conn, cpuNum, params, &nparams, 0))
 *         goto error;
 * }
 *
 * This function doesn't require privileged access to the hypervisor.
 * This function expects the caller to allocate the @params.
 *
 * CPU time Statistics:
 *
 * VIR_NODE_CPU_STATS_KERNEL:
 *     The cumulative CPU time which spends by kernel,
 *     when the node booting up.(nanoseconds)
 * VIR_NODE_CPU_STATS_USER:
 *     The cumulative CPU time which spends by user processes,
 *     when the node booting up.(nanoseconds)
 * VIR_NODE_CPU_STATS_IDLE:
 *     The cumulative idle CPU time, when the node booting up.(nanoseconds)
 * VIR_NODE_CPU_STATS_IOWAIT:
 *     The cumulative I/O wait CPU time, when the node booting up.(nanoseconds)
 * VIR_NODE_CPU_STATS_UTILIZATION:
 *     The CPU utilization. The usage value is in percent and 100%
 *     represents all CPUs on the server.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virNodeGetCPUStats (virConnectPtr conn,
                        int cpuNum,
5935
                        virNodeCPUStatsPtr params,
5936 5937
                        int *nparams, unsigned int flags)
{
5938
    VIR_DEBUG("conn=%p, cpuNum=%d, params=%p, nparams=%d, flags=%x",
5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949
              conn, cpuNum, params, nparams ? *nparams : -1, flags);

    virResetLastError();

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

    if ((nparams == NULL) || (*nparams < 0) ||
5950
        ((cpuNum < 0) && (cpuNum != VIR_NODE_CPU_STATS_ALL_CPUS))) {
5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

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

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

5969 5970 5971
/**
 * virNodeGetMemoryStats:
 * @conn: pointer to the hypervisor connection.
5972 5973
 * @cellNum: number of node cell. (VIR_NODE_MEMORY_STATS_ALL_CELLS means total
 *           cell statistics)
5974 5975 5976 5977 5978 5979 5980
 * @params: pointer to node memory stats objects
 * @nparams: number of node memory stats (this value should be same or
 *          less than the number of stats supported)
 * @flags: currently unused, for future extension. always pass 0.
 *
 * This function provides memory stats of the node.
 * If you want to get total cpu statistics of the node, you must specify
5981
 * VIR_NODE_MEMORY_STATS_ALL_CELLS to @cellNum.
5982 5983 5984 5985 5986 5987
 * The @params array will be filled with the values equal to the number of
 * stats suggested by @nparams
 *
 * 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
5988
 * array, i.e. (sizeof(@virNodeMemoryStats) * @nparams) bytes and call
5989 5990 5991 5992 5993 5994
 * the API again.
 *
 * Here is the sample code snippet:
 *
 * if ((virNodeGetMemoryStats(conn, cellNum, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
5995
 *     if ((params = malloc(sizeof(virNodeMemoryStats) * nparams)) == NULL)
5996
 *         goto error;
5997
 *     memset(params, cellNum, 0, sizeof(virNodeMemoryStats) * nparams);
5998 5999 6000 6001 6002 6003 6004 6005 6006
 *     if (virNodeGetMemoryStats(conn, params, &nparams, 0))
 *         goto error;
 * }
 *
 * This function doesn't require privileged access to the hypervisor.
 * This function expects the caller to allocate the @params.
 *
 * Memory Stats:
 *
6007
 * VIR_NODE_MEMORY_STATS_TOTAL:
6008
 *     The total memory usage.(KB)
6009
 * VIR_NODE_MEMORY_STATS_FREE:
6010 6011
 *     The free memory usage.(KB)
 *     On linux, this usage includes buffers and cached.
6012
 * VIR_NODE_MEMORY_STATS_BUFFERS:
6013
 *     The buffers memory usage.(KB)
6014
 * VIR_NODE_MEMORY_STATS_CACHED:
6015 6016 6017 6018 6019 6020
 *     The cached memory usage.(KB)
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virNodeGetMemoryStats (virConnectPtr conn,
                           int cellNum,
6021
                           virNodeMemoryStatsPtr params,
6022 6023
                           int *nparams, unsigned int flags)
{
6024
    VIR_DEBUG("conn=%p, cellNum=%d, params=%p, nparams=%d, flags=%x",
6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035
              conn, cellNum, params, nparams ? *nparams : -1, flags);

    virResetLastError();

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

    if ((nparams == NULL) || (*nparams < 0) ||
6036
        ((cellNum < 0) && (cellNum != VIR_NODE_MEMORY_STATS_ALL_CELLS))) {
6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

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

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

6055 6056 6057
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
6058
 *
D
Daniel Veillard 已提交
6059
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
6060 6061
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
6062
 *
D
Daniel Veillard 已提交
6063
 * Returns the available free memory in bytes or 0 in case of error
6064 6065 6066 6067
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
6068
    VIR_DEBUG("conn=%p", conn);
6069

6070 6071
    virResetLastError();

6072
    if (!VIR_IS_CONNECT (conn)) {
6073
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6074
        virDispatchError(NULL);
6075 6076 6077
        return 0;
    }

6078
    if (conn->driver->nodeGetFreeMemory) {
6079
        unsigned long long ret;
6080
        ret = conn->driver->nodeGetFreeMemory (conn);
6081 6082 6083 6084
        if (ret == 0)
            goto error;
        return ret;
    }
6085

6086
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6087 6088

error:
6089
    virDispatchError(conn);
6090 6091 6092
    return 0;
}

6093 6094 6095
/**
 * virDomainGetSchedulerType:
 * @domain: pointer to domain object
6096 6097
 * @nparams: pointer to number of scheduler parameters, can be NULL
 *           (return value)
6098
 *
6099
 * Get the scheduler type and the number of scheduler parameters.
6100 6101 6102 6103 6104 6105 6106 6107
 *
 * Returns NULL in case of error. The caller must free the returned string.
 */
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
{
    virConnectPtr conn;
    char *schedtype;
6108 6109

    VIR_DOMAIN_DEBUG(domain, "nparams=%p", nparams);
6110

6111 6112
    virResetLastError();

6113
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6114
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6115
        virDispatchError(NULL);
6116 6117 6118 6119 6120 6121
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
6122 6123
        if (!schedtype)
            goto error;
6124 6125 6126
        return schedtype;
    }

6127
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6128 6129

error:
6130
    virDispatchError(domain->conn);
6131 6132 6133 6134 6135 6136 6137
    return NULL;
}


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
6138
 * @params: pointer to scheduler parameter objects
6139
 *          (return value)
6140 6141
 * @nparams: pointer to number of scheduler parameter objects
 *          (this value must be at least as large as the returned value
6142 6143
 *           nparams of virDomainGetSchedulerType)
 *
6144 6145
 * Get all scheduler parameters, the @params array will be filled with the
 * values and @nparams will be updated to the number of valid elements in
6146 6147 6148
 * @params.  It is hypervisor specific whether this returns the live or
 * persistent state; for more control, use
 * virDomainGetSchedulerParametersFlags.
6149 6150 6151 6152 6153
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
6154
                                virTypedParameterPtr params, int *nparams)
6155 6156
{
    virConnectPtr conn;
6157 6158

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%p", params, nparams);
6159

6160 6161
    virResetLastError();

6162
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6163
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6164
        virDispatchError(NULL);
6165 6166
        return -1;
    }
6167 6168 6169 6170 6171 6172

    if (params == NULL || nparams == NULL || *nparams <= 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

6173 6174
    conn = domain->conn;

6175 6176 6177 6178 6179 6180 6181
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
6182

6183
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6184 6185

error:
6186
    virDispatchError(domain->conn);
6187 6188 6189
    return -1;
}

6190 6191 6192 6193 6194 6195 6196 6197
/**
 * virDomainGetSchedulerParametersFlags:
 * @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)
6198
 * @flags: one of virDomainModificationImpact
6199 6200 6201 6202
 *
 * Get the scheduler parameters, the @params array will be filled with the
 * values.
 *
6203 6204
 * The value of @flags can be exactly VIR_DOMAIN_AFFECT_CURRENT,
 * VIR_DOMAIN_AFFECT_LIVE, or VIR_DOMAIN_AFFECT_CONFIG.
6205 6206 6207 6208 6209 6210 6211 6212 6213 6214
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParametersFlags(virDomainPtr domain,
                                     virTypedParameterPtr params, int *nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

6215
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%p, flags=%x",
6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248
                     params, nparams, flags);

    virResetLastError();

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

    if (params == NULL || nparams == NULL || *nparams <= 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

6249 6250 6251 6252
/**
 * virDomainSetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
6253 6254
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
6255 6256
 *           nparams of virDomainGetSchedulerType)
 *
6257 6258 6259 6260
 * Change all or a subset or the scheduler parameters.  It is
 * hypervisor-specific whether this sets live, persistent, or both
 * settings; for more control, use
 * virDomainSetSchedulerParametersFlags.
6261 6262 6263 6264
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
6265
virDomainSetSchedulerParameters(virDomainPtr domain,
6266
                                virTypedParameterPtr params, int nparams)
6267 6268
{
    virConnectPtr conn;
6269 6270

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d", params, nparams);
6271

6272 6273
    virResetLastError();

6274
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6275
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6276
        virDispatchError(NULL);
6277 6278
        return -1;
    }
6279 6280 6281 6282 6283 6284

    if (params == NULL || nparams < 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

6285
    if (domain->conn->flags & VIR_CONNECT_RO) {
6286
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6287
        goto error;
6288
    }
6289 6290
    conn = domain->conn;

6291 6292 6293 6294 6295 6296 6297
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
6298

6299
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310

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


/**
 * virDomainSetSchedulerParametersFlags:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
6311 6312
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
6313
 *           nparams of virDomainGetSchedulerType)
6314
 * @flags: bitwise-OR of virDomainModificationImpact
6315
 *
6316
 * Change a subset or all scheduler parameters.  The value of @flags
6317 6318 6319
 * should be either VIR_DOMAIN_AFFECT_CURRENT, or a bitwise-or of
 * values from VIR_DOMAIN_AFFECT_LIVE and
 * VIR_DOMAIN_AFFECT_CURRENT, although hypervisors vary in which
6320
 * flags are supported.
6321 6322 6323 6324 6325
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetSchedulerParametersFlags(virDomainPtr domain,
6326
                                     virTypedParameterPtr params,
6327 6328 6329 6330 6331
                                     int nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

6332
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
6333 6334 6335 6336 6337 6338 6339 6340 6341
                     params, nparams, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
6342 6343 6344 6345 6346 6347

    if (params == NULL || nparams < 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6366 6367

error:
6368
    virDispatchError(domain->conn);
6369 6370 6371 6372
    return -1;
}


6373
/**
6374
 * virDomainBlockStats:
6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401
 * @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 };
6402 6403

    VIR_DOMAIN_DEBUG(dom, "path=%s, stats=%p, size=%zi", path, stats, size);
6404

6405 6406
    virResetLastError();

6407
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6408
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6409
        virDispatchError(NULL);
6410 6411
        return -1;
    }
6412
    if (!path || !stats || size > sizeof stats2) {
6413
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6414 6415
        goto error;
    }
6416 6417 6418 6419
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
6420
            goto error;
6421 6422 6423 6424 6425

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

6426
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6427 6428

error:
6429
    virDispatchError(dom->conn);
6430 6431 6432 6433
    return -1;
}

/**
6434
 * virDomainInterfaceStats:
6435 6436 6437 6438 6439 6440 6441 6442 6443 6444
 * @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 已提交
6445
 * Domains may have more than one network interface.  To get stats for
6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460
 * 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 };
6461 6462 6463

    VIR_DOMAIN_DEBUG(dom, "path=%s, stats=%p, size=%zi",
                     path, stats, size);
6464

6465 6466
    virResetLastError();

6467
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6468
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6469
        virDispatchError(NULL);
6470 6471
        return -1;
    }
6472
    if (!path || !stats || size > sizeof stats2) {
6473
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6474 6475
        goto error;
    }
6476 6477 6478 6479
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
6480
            goto error;
6481 6482 6483 6484 6485

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

6486
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6487 6488

error:
6489
    virDispatchError(dom->conn);
6490 6491 6492
    return -1;
}

6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519
/**
 * 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).
6520 6521
 * VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON:
 *     Current balloon value (in kb).
6522 6523 6524 6525 6526 6527 6528 6529
 *
 * 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;
6530

E
Eric Blake 已提交
6531 6532
    VIR_DOMAIN_DEBUG(dom, "stats=%p, nr_stats=%u, flags=%x",
                     stats, nr_stats, flags);
6533 6534 6535 6536

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6537
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6538
        virDispatchError(NULL);
6539 6540
        return -1;
    }
6541

6542 6543 6544 6545 6546 6547 6548 6549
    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) {
6550 6551
        nr_stats_ret = conn->driver->domainMemoryStats (dom, stats, nr_stats,
                                                        flags);
6552 6553 6554 6555 6556
        if (nr_stats_ret == -1)
            goto error;
        return nr_stats_ret;
    }

6557
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6558 6559

error:
6560
    virDispatchError(dom->conn);
6561 6562 6563
    return -1;
}

R
Richard W.M. Jones 已提交
6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596
/**
 * 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 已提交
6597 6598 6599 6600
 * 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 已提交
6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611
 * 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;
6612

E
Eric Blake 已提交
6613 6614
    VIR_DOMAIN_DEBUG(dom, "path=%s, offset=%lld, size=%zi, buffer=%p, flags=%x",
                     path, offset, size, buffer, flags);
R
Richard W.M. Jones 已提交
6615

6616 6617
    virResetLastError();

R
Richard W.M. Jones 已提交
6618
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6619
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6620
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
6621 6622 6623
        return -1;
    }
    conn = dom->conn;
6624

6625
    if (dom->conn->flags & VIR_CONNECT_RO) {
6626
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6627
        goto error;
6628 6629
    }

R
Richard W.M. Jones 已提交
6630
    if (!path) {
6631
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
6632
                           _("path is NULL"));
6633
        goto error;
R
Richard W.M. Jones 已提交
6634 6635 6636 6637
    }

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

6643 6644 6645 6646 6647 6648 6649 6650
    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 已提交
6651

6652
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6653 6654

error:
6655
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
6656 6657
    return -1;
}
6658

R
Richard W.M. Jones 已提交
6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697
/**
 * 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;
6698

6699
    VIR_DOMAIN_DEBUG(dom, "start=%lld, size=%zi, buffer=%p, flags=%x",
6700
                     start, size, buffer, flags);
R
Richard W.M. Jones 已提交
6701

6702 6703
    virResetLastError();

R
Richard W.M. Jones 已提交
6704
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6705
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6706
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
6707 6708 6709 6710
        return -1;
    }
    conn = dom->conn;

6711
    if (dom->conn->flags & VIR_CONNECT_RO) {
6712
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6713
        goto error;
6714 6715
    }

6716
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
6717 6718 6719 6720 6721 6722
     * 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.
     *
6723
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
6724 6725 6726
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
6727 6728 6729
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
6730 6731 6732 6733 6734 6735 6736 6737
     * 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.
     */
6738

6739 6740
    /* Exactly one of these two flags must be set.  */
    if (!(flags & VIR_MEMORY_VIRTUAL) == !(flags & VIR_MEMORY_PHYSICAL)) {
6741
        virLibDomainError(VIR_ERR_INVALID_ARG,
6742
                     _("flags parameter must include VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
6743
        goto error;
R
Richard W.M. Jones 已提交
6744 6745 6746 6747
    }

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

6753 6754 6755 6756 6757 6758 6759 6760
    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 已提交
6761

6762
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6763 6764

error:
6765
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
6766 6767 6768
    return -1;
}

6769

6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784
/**
 * 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;
6785

E
Eric Blake 已提交
6786
    VIR_DOMAIN_DEBUG(domain, "info=%p, flags=%x", info, flags);
6787 6788 6789 6790

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6791
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6792
        virDispatchError(NULL);
6793
        return -1;
6794
    }
6795
    if (path == NULL || info == NULL) {
6796
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811
        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;
    }

6812
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6813 6814 6815 6816 6817 6818 6819

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


6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830
/************************************************************************
 *									*
 *		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
 *
6831 6832
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
6833 6834
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
6835 6836 6837 6838 6839
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
6840
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
6841

6842 6843
    virResetLastError();

6844
    if (!VIR_IS_CONNECT(conn)) {
6845
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6846
        virDispatchError(NULL);
6847
        return NULL;
6848
    }
6849
    if (conn->flags & VIR_CONNECT_RO) {
6850
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6851
        goto error;
6852
    }
6853
    if (xml == NULL) {
6854
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6855
        goto error;
6856 6857
    }

6858 6859 6860 6861 6862 6863 6864
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
6865

6866
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6867 6868

error:
6869
    virDispatchError(conn);
6870
    return NULL;
6871 6872 6873 6874 6875 6876
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
O
Osier Yang 已提交
6877 6878 6879 6880 6881 6882 6883
 * Undefine a domain. If the domain is running, it's converted to
 * transient domain, without stopping it. If the domain is inactive,
 * the domain configuration is removed.
 *
 * If the domain has a managed save image (see
 * virDomainHasManagedSaveImage()), then the undefine will fail. See
 * virDomainUndefineFlags() for more control.
6884 6885 6886 6887 6888
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
6889
    virConnectPtr conn;
6890

6891
    VIR_DOMAIN_DEBUG(domain);
6892

6893 6894
    virResetLastError();

6895
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6896
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6897
        virDispatchError(NULL);
6898
        return -1;
6899
    }
6900 6901
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6902
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6903
        goto error;
6904 6905
    }

6906 6907 6908 6909 6910 6911 6912
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
6913

6914
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6915 6916

error:
6917
    virDispatchError(domain->conn);
6918
    return -1;
6919 6920
}

O
Osier Yang 已提交
6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
/**
 * virDomainUndefineFlags:
 * @domain: pointer to a defined domain
 * @flags: bitwise-or of supported virDomainUndefineFlagsValues
 *
 * Undefine a domain. If the domain is running, it's converted to
 * transient domain, without stopping it. If the domain is inactive,
 * the domain configuration is removed.
 *
 * If the domain has a managed save image (see virDomainHasManagedSaveImage()),
 * then including VIR_DOMAIN_UNDEFINE_MANAGED_SAVE in @flags will also remove
 * that file, and omitting the flag will cause the undefine process to fail.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefineFlags(virDomainPtr domain,
                       unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);

    virResetLastError();

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


6973 6974 6975 6976
/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
6977
 * Provides the number of defined but inactive domains.
6978 6979 6980 6981 6982 6983
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
6984
    VIR_DEBUG("conn=%p", conn);
6985

6986 6987
    virResetLastError();

6988
    if (!VIR_IS_CONNECT(conn)) {
6989
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6990
        virDispatchError(NULL);
6991
        return -1;
6992 6993
    }

6994 6995 6996 6997 6998 6999 7000
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7001

7002
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7003 7004

error:
7005
    virDispatchError(conn);
7006
    return -1;
7007 7008 7009 7010 7011 7012 7013 7014
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
7015 7016
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
7017
 *
7018 7019 7020
 * Returns the number of names provided in the array or -1 in case of error
 */
int
7021
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
7022
                             int maxnames) {
7023
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7024

7025 7026
    virResetLastError();

7027
    if (!VIR_IS_CONNECT(conn)) {
7028
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7029
        virDispatchError(NULL);
7030
        return -1;
7031 7032
    }

7033
    if ((names == NULL) || (maxnames < 0)) {
7034
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7035
        goto error;
7036 7037
    }

7038 7039 7040 7041 7042 7043 7044
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7045

7046
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7047 7048

error:
7049
    virDispatchError(conn);
7050
    return -1;
7051 7052 7053 7054 7055 7056
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
7057
 * Launch a defined domain. If the call succeeds the domain moves from the
7058 7059 7060
 * defined to the running domains pools.  The domain will be paused only
 * if restoring from managed state created from a paused domain.  For more
 * control, see virDomainCreateWithFlags().
7061 7062 7063 7064 7065
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
7066
    virConnectPtr conn;
7067

7068
    VIR_DOMAIN_DEBUG(domain);
7069

7070 7071
    virResetLastError();

7072
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7073
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7074
        virDispatchError(NULL);
7075
        return -1;
7076
    }
7077 7078
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7079
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7080
        goto error;
7081
    }
7082

7083 7084 7085 7086 7087 7088 7089
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
7090

7091
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7092 7093

error:
7094
    virDispatchError(domain->conn);
7095
    return -1;
7096 7097
}

7098 7099 7100 7101 7102 7103 7104 7105
/**
 * 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.
 *
7106 7107 7108 7109 7110 7111
 * If the VIR_DOMAIN_START_PAUSED flag is set, or if the guest domain
 * has a managed save image that requested paused state (see
 * virDomainManagedSave()) the guest domain will be started, but its
 * CPUs will remain paused. The CPUs can later be manually started
 * using virDomainResume().  In all other cases, the guest domain will
 * be running.
7112 7113 7114 7115
 *
 * If the VIR_DOMAIN_START_AUTODESTROY flag is set, the guest
 * domain will be automatically destroyed when the virConnectPtr
 * object is finally released. This will also happen if the
E
Eric Blake 已提交
7116
 * client application crashes / loses its connection to the
7117
 * libvirtd daemon. Any domains marked for auto destroy will
7118
 * block attempts at migration, save-to-file, or snapshots.
7119
 *
7120 7121 7122 7123 7124 7125
 * If the VIR_DOMAIN_START_BYPASS_CACHE flag is set, and there is a
 * managed save file for this domain (created by virDomainManagedSave()),
 * then libvirt will attempt to bypass the file system cache while restoring
 * the file, or fail if it cannot do so for the given system; this can allow
 * less pressure on file system cache, but also risks slowing loads from NFS.
 *
7126 7127 7128
 * If the VIR_DOMAIN_START_FORCE_BOOT flag is set, then any managed save
 * file for this domain is discarded, and the domain boots from scratch.
 *
7129 7130 7131 7132 7133
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) {
    virConnectPtr conn;
7134

7135
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
7136 7137 7138 7139

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7140
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7141
        virDispatchError(NULL);
7142
        return -1;
7143 7144 7145
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7146
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157
        goto error;
    }

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

7158
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7159 7160 7161 7162 7163 7164

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

7165 7166 7167
/**
 * virDomainGetAutostart:
 * @domain: a domain object
7168
 * @autostart: the value returned
7169
 *
7170
 * Provides a boolean value indicating whether the domain
7171 7172 7173 7174 7175 7176 7177
 * 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,
7178 7179 7180
                      int *autostart)
{
    virConnectPtr conn;
7181 7182

    VIR_DOMAIN_DEBUG(domain, "autostart=%p", autostart);
7183

7184 7185 7186
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7187
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7188
        virDispatchError(NULL);
7189
        return -1;
7190 7191
    }
    if (!autostart) {
7192
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7193
        goto error;
7194 7195
    }

7196 7197
    conn = domain->conn;

7198 7199 7200 7201 7202 7203 7204
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7205

7206
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7207 7208

error:
7209
    virDispatchError(domain->conn);
7210
    return -1;
7211 7212 7213 7214 7215
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
7216
 * @autostart: whether the domain should be automatically started 0 or 1
7217 7218 7219 7220 7221 7222 7223 7224
 *
 * 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,
7225 7226 7227
                      int autostart)
{
    virConnectPtr conn;
7228 7229

    VIR_DOMAIN_DEBUG(domain, "autostart=%d", autostart);
7230

7231 7232 7233
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7234
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7235
        virDispatchError(NULL);
7236
        return -1;
7237 7238
    }

7239 7240
    conn = domain->conn;

7241
    if (domain->conn->flags & VIR_CONNECT_RO) {
7242
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7243
        goto error;
7244 7245
    }

7246 7247 7248 7249 7250 7251 7252
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7253

7254
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7255 7256

error:
7257
    virDispatchError(domain->conn);
7258
    return -1;
7259 7260
}

7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273
/**
 * virDomainInjectNMI:
 * @domain: pointer to domain object, or NULL for Domain0
 * @flags:  the flags for controlling behavior, pass 0 for now
 *
 * Send NMI to the guest
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int virDomainInjectNMI(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
7274
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304

    virResetLastError();

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

    conn = domain->conn;

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

    virLibConnError (VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322
/**
 * virDomainSendKey:
 * @domain:    pointer to domain object, or NULL for Domain0
 * @codeset:   the code set of keycodes, from virKeycodeSet
 * @holdtime:  the duration (in milliseconds) that the keys will be held
 * @keycodes:  array of keycodes
 * @nkeycodes: number of keycodes, up to VIR_DOMAIN_SEND_KEY_MAX_KEYS
 * @flags:     the flags for controlling behavior, pass 0 for now
 *
 * Send key(s) to the guest.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int virDomainSendKey(virDomainPtr domain,
                     unsigned int codeset,
                     unsigned int holdtime,
                     unsigned int *keycodes,
7323
                     int nkeycodes,
7324 7325 7326
                     unsigned int flags)
{
    virConnectPtr conn;
7327
    VIR_DOMAIN_DEBUG(domain, "codeset=%u, holdtime=%u, nkeycodes=%u, flags=%x",
7328 7329 7330 7331 7332
                     codeset, holdtime, nkeycodes, flags);

    virResetLastError();

    if (keycodes == NULL ||
7333
        nkeycodes <= 0 || nkeycodes > VIR_DOMAIN_SEND_KEY_MAX_KEYS) {
7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366
        virLibDomainError(VIR_ERR_OPERATION_INVALID, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

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

    conn = domain->conn;

    if (conn->driver->domainSendKey) {
        int ret;
        ret = conn->driver->domainSendKey(domain, codeset, holdtime,
                                          keycodes, nkeycodes, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

7367 7368 7369 7370 7371 7372 7373 7374
/**
 * 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.
7375
 * This function may require privileged access to the hypervisor.
7376
 *
7377
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
7378 7379 7380
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
7381
 *
7382 7383 7384 7385 7386 7387
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
7388
    virConnectPtr conn;
7389 7390

    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u", nvcpus);
7391

7392 7393
    virResetLastError();

7394
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7395
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7396
        virDispatchError(NULL);
7397
        return -1;
7398
    }
7399
    if (domain->conn->flags & VIR_CONNECT_RO) {
7400
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7401
        goto error;
7402
    }
7403

7404
    if (nvcpus < 1) {
7405
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7406
        goto error;
7407
    }
7408
    conn = domain->conn;
7409

7410 7411 7412 7413 7414 7415 7416
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
7417

7418
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7419 7420

error:
7421
    virDispatchError(domain->conn);
7422
    return -1;
7423 7424
}

E
Eric Blake 已提交
7425 7426 7427 7428 7429 7430 7431 7432 7433
/**
 * 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.
7434
 * This function may require privileged access to the hypervisor.
E
Eric Blake 已提交
7435
 *
7436
 * @flags may include VIR_DOMAIN_AFFECT_LIVE to affect a running
E
Eric Blake 已提交
7437
 * domain (which may fail if domain is not active), or
7438
 * VIR_DOMAIN_AFFECT_CONFIG to affect the next boot via the XML
E
Eric Blake 已提交
7439
 * description of the domain.  Both flags may be set.
7440 7441 7442 7443
 * If neither flag is specified (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT),
 * then an inactive domain modifies persistent setup, while an active domain
 * is hypervisor-dependent on whether just live or both live and persistent
 * state is changed.
E
Eric Blake 已提交
7444 7445
 *
 * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then
7446
 * VIR_DOMAIN_AFFECT_LIVE must be clear, and only the maximum virtual
E
Eric Blake 已提交
7447 7448 7449 7450
 * 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.
7451
 * Not all hypervisors can support all flag combinations.
E
Eric Blake 已提交
7452 7453 7454 7455 7456 7457 7458 7459 7460
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpusFlags(virDomainPtr domain, unsigned int nvcpus,
                       unsigned int flags)
{
    virConnectPtr conn;
7461

7462
    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u, flags=%x", nvcpus, flags);
E
Eric Blake 已提交
7463 7464 7465 7466

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7467
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
7468
        virDispatchError(NULL);
7469
        return -1;
E
Eric Blake 已提交
7470 7471
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
7472
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
7473 7474 7475 7476
        goto error;
    }

    /* Perform some argument validation common to all implementations.  */
7477
    if (nvcpus < 1 || (unsigned short) nvcpus != nvcpus) {
7478
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490
        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;
    }

7491
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504

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
7505
 * not support it.  This function may require privileged access to the
E
Eric Blake 已提交
7506 7507
 * hypervisor.
 *
7508 7509 7510 7511 7512 7513 7514
 * If @flags includes VIR_DOMAIN_AFFECT_LIVE, this will query a
 * running domain (which will fail if domain is not active); if
 * it includes VIR_DOMAIN_AFFECT_CONFIG, this will query the XML
 * description of the domain.  It is an error to set both flags.
 * If neither flag is set (that is, VIR_DOMAIN_AFFECT_CURRENT),
 * then the configuration queried depends on whether the domain
 * is currently running.
E
Eric Blake 已提交
7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526
 *
 * 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;
7527

7528
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
E
Eric Blake 已提交
7529 7530 7531 7532

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7533
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
7534
        virDispatchError(NULL);
7535
        return -1;
E
Eric Blake 已提交
7536 7537
    }

7538 7539
    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) && (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
7540
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552
        goto error;
    }
    conn = domain->conn;

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

7553
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
7554 7555 7556 7557 7558 7559

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

7560 7561 7562 7563 7564
/**
 * 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 已提交
7565 7566 7567
 *      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.
7568 7569 7570 7571
 * @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.
7572
 *
7573
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
7574
 * This function may require privileged access to the hypervisor.
7575
 *
7576 7577 7578
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
7579 7580 7581 7582 7583 7584
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
7585
    virConnectPtr conn;
7586 7587 7588

    VIR_DOMAIN_DEBUG(domain, "vcpu=%u, cpumap=%p, maplen=%d",
                     vcpu, cpumap, maplen);
7589

7590 7591
    virResetLastError();

7592
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7593
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7594
        virDispatchError(NULL);
7595
        return -1;
7596
    }
7597
    if (domain->conn->flags & VIR_CONNECT_RO) {
7598
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7599
        goto error;
7600
    }
7601

7602
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
7603
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7604
       goto error;
7605
    }
7606

7607 7608
    conn = domain->conn;

7609 7610 7611 7612 7613 7614 7615
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
7616

7617
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7618 7619

error:
7620
    virDispatchError(domain->conn);
7621
    return -1;
7622 7623
}

7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638
/**
 * virDomainPinVcpuFlags:
 * @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)
 *      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.
 * @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.
 * @flags: bitwise-OR of virDomainModificationImpac
 *
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
7639
 * This function may require privileged access to the hypervisor.
7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651
 *
 * @flags may include VIR_DOMAIN_AFFECT_LIVE or VIR_DOMAIN_AFFECT_CONFIG.
 * Both flags may be set.
 * If VIR_DOMAIN_AFFECT_LIVE is set, the change affects a running domain
 * and may fail if domain is not alive.
 * If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state,
 * and will fail for transient domains. If neither flag is specified (that is,
 * @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain modifies
 * persistent setup, while an active domain is hypervisor-dependent on whether
 * just live or both live and persistent state is changed.
 * Not all hypervisors can support all flag combinations.
 *
E
Eric Blake 已提交
7652
 * See also virDomainGetVcpuPinInfo for querying this information.
7653
 *
7654 7655 7656 7657 7658 7659 7660 7661 7662
 * Returns 0 in case of success, -1 in case of failure.
 *
 */
int
virDomainPinVcpuFlags(virDomainPtr domain, unsigned int vcpu,
                      unsigned char *cpumap, int maplen, unsigned int flags)
{
    virConnectPtr conn;

7663
    VIR_DOMAIN_DEBUG(domain, "vcpu=%u, cpumap=%p, maplen=%d, flags=%x",
7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701
                     vcpu, cpumap, maplen, flags);

    virResetLastError();

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

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

    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

}

7702
/**
E
Eric Blake 已提交
7703
 * virDomainGetVcpuPinInfo:
7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726
 * @domain: pointer to domain object, or NULL for Domain0
 * @ncpumaps: the number of cpumap (listed first to match virDomainGetVcpus)
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
 *     domain (in 8-bit bytes) (OUT)
 *     It's assumed there is <ncpumaps> cpumap in cpumaps array.
 *     The memory allocated to cpumaps must be (ncpumaps * maplen) bytes
 *     (ie: calloc(ncpumaps, maplen)).
 *     One cpumap inside cpumaps has the format described in
 *     virDomainPinVcpu() API.
 *     Must not be NULL.
 * @maplen: the number of bytes in one cpumap, from 1 up to size of CPU map.
 *     Must be positive.
 * @flags: an OR'ed set of virDomainModificationImpact
 *     Must not be VIR_DOMAIN_AFFECT_LIVE and
 *     VIR_DOMAIN_AFFECT_CONFIG concurrently.
 *
 * Query the CPU affinity setting of all virtual CPUs of domain, store it
 * in cpumaps.
 *
 * Returns the number of virtual CPUs in case of success,
 * -1 in case of failure.
 */
int
E
Eric Blake 已提交
7727
virDomainGetVcpuPinInfo (virDomainPtr domain, int ncpumaps,
7728 7729 7730 7731
                         unsigned char *cpumaps, int maplen, unsigned int flags)
{
    virConnectPtr conn;

7732
    VIR_DOMAIN_DEBUG(domain, "ncpumaps=%d, cpumaps=%p, maplen=%d, flags=%x",
7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750
                     ncpumaps, cpumaps, maplen, flags);

    virResetLastError();

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

    if (ncpumaps < 1 || !cpumaps || maplen <= 0 ||
        INT_MULTIPLY_OVERFLOW(ncpumaps, maplen)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;

E
Eric Blake 已提交
7751
    if (conn->driver->domainGetVcpuPinInfo) {
7752
        int ret;
E
Eric Blake 已提交
7753
        ret = conn->driver->domainGetVcpuPinInfo (domain, ncpumaps,
7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766
                                                  cpumaps, maplen, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

7767 7768 7769 7770 7771
/**
 * 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 已提交
7772
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
7773
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
7774
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
7775 7776 7777 7778 7779 7780 7781
 *	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...).
7782
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
7783
 *
7784
 * Extract information about virtual CPUs of domain, store it in info array
7785 7786 7787
 * and also in cpumaps if this pointer isn't NULL.  This call may fail
 * on an inactive domain.
 *
E
Eric Blake 已提交
7788
 * See also virDomainGetVcpuPinInfo for querying just cpumaps, including on
7789
 * an inactive domain.
7790 7791 7792 7793 7794
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
7795
                  unsigned char *cpumaps, int maplen)
7796
{
7797
    virConnectPtr conn;
7798 7799 7800

    VIR_DOMAIN_DEBUG(domain, "info=%p, maxinfo=%d, cpumaps=%p, maplen=%d",
                     info, maxinfo, cpumaps, maplen);
7801

7802 7803
    virResetLastError();

7804
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7805
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7806
        virDispatchError(NULL);
7807
        return -1;
7808 7809
    }
    if ((info == NULL) || (maxinfo < 1)) {
7810
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7811
        goto error;
7812
    }
7813 7814 7815

    /* Ensure that domainGetVcpus (aka remoteDomainGetVcpus) does not
       try to memcpy anything into a NULL pointer.  */
7816 7817
    if (!cpumaps ? maplen != 0
        : (maplen <= 0 || INT_MULTIPLY_OVERFLOW(maxinfo, maplen))) {
7818
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7819
        goto error;
7820
    }
7821

7822 7823
    conn = domain->conn;

7824 7825 7826 7827 7828 7829 7830 7831
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
7832

7833
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7834 7835

error:
7836
    virDispatchError(domain->conn);
7837
    return -1;
7838
}
7839

7840 7841 7842
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
7843
 *
7844 7845
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
7846
 * the same as virConnectGetMaxVcpus(). If the guest is running
7847
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
7848
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
7849 7850 7851 7852
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
7853 7854
virDomainGetMaxVcpus(virDomainPtr domain)
{
7855
    virConnectPtr conn;
7856

7857
    VIR_DOMAIN_DEBUG(domain);
7858

7859 7860
    virResetLastError();

7861
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7862
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7863
        virDispatchError(NULL);
7864
        return -1;
7865 7866 7867 7868
    }

    conn = domain->conn;

7869 7870 7871 7872 7873 7874 7875
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
7876

7877
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7878 7879

error:
7880
    virDispatchError(domain->conn);
7881
    return -1;
7882 7883
}

7884 7885 7886 7887 7888
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
7889 7890 7891
 * 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.
7892
 *
7893
 * Returns 0 in case of success, -1 in case of failure
7894 7895 7896 7897 7898 7899
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

7900 7901
    VIR_DOMAIN_DEBUG(domain, "seclabel=%p", seclabel);

7902
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7903
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7904
        virDispatchError(NULL);
7905 7906 7907 7908
        return -1;
    }

    if (seclabel == NULL) {
7909
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7910
        goto error;
7911 7912 7913 7914
    }

    conn = domain->conn;

7915 7916 7917 7918 7919 7920 7921 7922
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

7923
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7924

7925
error:
7926
    virDispatchError(domain->conn);
7927
    return -1;
7928 7929 7930 7931 7932 7933 7934
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
7935 7936 7937
 * 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.
7938
 *
7939
 * Returns 0 in case of success, -1 in case of failure
7940 7941 7942 7943
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
7944
    VIR_DEBUG("conn=%p secmodel=%p", conn, secmodel);
7945

7946
    if (!VIR_IS_CONNECT(conn)) {
7947
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7948
        virDispatchError(NULL);
7949 7950 7951 7952
        return -1;
    }

    if (secmodel == NULL) {
7953
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7954 7955 7956 7957 7958 7959 7960 7961 7962
        goto error;
    }

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

7965
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7966

7967
error:
7968
    virDispatchError(conn);
7969
    return -1;
7970
}
7971

7972 7973 7974 7975
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
7976
 *
7977 7978
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
7979
 *
7980 7981 7982 7983
 * 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.
 *
7984 7985 7986
 * Returns 0 in case of success, -1 in case of failure.
 */
int
7987
virDomainAttachDevice(virDomainPtr domain, const char *xml)
7988 7989
{
    virConnectPtr conn;
7990 7991

    VIR_DOMAIN_DEBUG(domain, "xml=%s", xml);
7992

7993 7994
    virResetLastError();

7995
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7996
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7997
        virDispatchError(NULL);
7998
        return -1;
7999
    }
8000 8001 8002 8003 8004 8005

    if (xml == NULL) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

8006
    if (domain->conn->flags & VIR_CONNECT_RO) {
8007
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8008
        goto error;
8009 8010 8011
    }
    conn = domain->conn;

8012
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
8013 8014 8015 8016 8017 8018 8019
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

8020
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033

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
8034
 * to control how the device is attached.  VIR_DOMAIN_AFFECT_CURRENT
J
Jim Fehlig 已提交
8035
 * specifies that the device allocation is made based on current domain
8036
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
J
Jim Fehlig 已提交
8037
 * allocated to the active domain instance only and is not added to the
8038
 * persisted domain configuration.  VIR_DOMAIN_AFFECT_CONFIG
J
Jim Fehlig 已提交
8039 8040 8041 8042 8043 8044
 * 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.
 *
8045 8046 8047 8048
 * 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 已提交
8049 8050 8051 8052 8053 8054 8055
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
8056

8057
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
J
Jim Fehlig 已提交
8058 8059 8060 8061

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8062
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8063
        virDispatchError(NULL);
8064
        return -1;
J
Jim Fehlig 已提交
8065
    }
8066 8067 8068 8069 8070 8071

    if (xml == NULL) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

J
Jim Fehlig 已提交
8072
    if (domain->conn->flags & VIR_CONNECT_RO) {
8073
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
8074 8075 8076 8077 8078
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
8079
        int ret;
J
Jim Fehlig 已提交
8080
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
8081 8082 8083 8084
        if (ret < 0)
            goto error;
        return ret;
    }
8085

8086
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8087 8088

error:
8089
    virDispatchError(domain->conn);
8090
    return -1;
8091 8092 8093 8094 8095 8096
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
8097
 *
8098 8099
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
8100 8101 8102 8103
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8104
virDomainDetachDevice(virDomainPtr domain, const char *xml)
8105 8106
{
    virConnectPtr conn;
8107 8108

    VIR_DOMAIN_DEBUG(domain, "xml=%s", xml);
8109

8110 8111
    virResetLastError();

8112
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8113
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8114
        virDispatchError(NULL);
8115
        return -1;
8116
    }
8117 8118 8119 8120 8121 8122

    if (xml == NULL) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

8123
    if (domain->conn->flags & VIR_CONNECT_RO) {
8124
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8125
        goto error;
8126 8127 8128
    }
    conn = domain->conn;

8129 8130 8131
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
8132 8133 8134 8135 8136
         if (ret < 0)
             goto error;
         return ret;
     }

8137
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150

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
8151
 * to control how the device is detached.  VIR_DOMAIN_AFFECT_CURRENT
J
Jim Fehlig 已提交
8152
 * specifies that the device allocation is removed based on current domain
8153
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
J
Jim Fehlig 已提交
8154
 * deallocated from the active domain instance only and is not from the
8155
 * persisted domain configuration.  VIR_DOMAIN_AFFECT_CONFIG
J
Jim Fehlig 已提交
8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168
 * 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;
8169

8170
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
J
Jim Fehlig 已提交
8171 8172 8173 8174

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8175
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8176
        virDispatchError(NULL);
8177
        return -1;
J
Jim Fehlig 已提交
8178
    }
8179 8180 8181 8182 8183 8184

    if (xml == NULL) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

J
Jim Fehlig 已提交
8185
    if (domain->conn->flags & VIR_CONNECT_RO) {
8186
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
8187 8188 8189 8190 8191 8192 8193
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
8194 8195 8196 8197 8198
        if (ret < 0)
            goto error;
        return ret;
    }

8199
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212

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
8213
 * to control how the device is changed.  VIR_DOMAIN_AFFECT_CURRENT
8214
 * specifies that the device change is made based on current domain
8215
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
8216
 * changed on the active domain instance only and is not added to the
8217
 * persisted domain configuration. VIR_DOMAIN_AFFECT_CONFIG
8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234
 * 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;
8235

8236
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
8237 8238 8239 8240

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8241
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8242
        virDispatchError(NULL);
8243
        return -1;
8244
    }
8245 8246 8247 8248 8249 8250

    if (xml == NULL) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

8251
    if (domain->conn->flags & VIR_CONNECT_RO) {
8252
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8253 8254 8255 8256 8257 8258 8259
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
8260 8261 8262 8263
        if (ret < 0)
            goto error;
        return ret;
    }
8264

8265
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8266 8267

error:
8268
    virDispatchError(domain->conn);
8269
    return -1;
8270
}
8271

8272 8273 8274 8275 8276 8277 8278 8279 8280 8281
/**
 * 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
8282
 * with the amount of free memory in bytes for each cell requested,
8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293
 * 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)
{
8294
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
8295 8296
          conn, freeMems, startCell, maxCells);

8297 8298
    virResetLastError();

8299
    if (!VIR_IS_CONNECT(conn)) {
8300
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8301
        virDispatchError(NULL);
8302
        return -1;
8303 8304
    }

D
Daniel Veillard 已提交
8305
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
8306
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8307
        goto error;
8308 8309
    }

8310 8311 8312 8313 8314 8315 8316
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
8317

8318
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8319 8320

error:
8321
    virDispatchError(conn);
8322 8323 8324
    return -1;
}

8325 8326 8327 8328
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
8329
 * Provides the connection pointer associated with a network.  The
8330 8331 8332
 * reference counter on the connection is not increased by this
 * call.
 *
8333 8334 8335 8336
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
8337 8338 8339 8340 8341
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
8342
    VIR_DEBUG("net=%p", net);
8343

8344 8345 8346
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
8347
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8348
        virDispatchError(NULL);
8349 8350 8351 8352 8353
        return NULL;
    }
    return net->conn;
}

8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364
/**
 * 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)
{
8365
    VIR_DEBUG("conn=%p", conn);
8366

8367 8368
    virResetLastError();

8369
    if (!VIR_IS_CONNECT(conn)) {
8370
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8371
        virDispatchError(NULL);
8372
        return -1;
8373 8374
    }

8375 8376 8377 8378 8379 8380 8381
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8382

8383
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8384 8385

error:
8386
    virDispatchError(conn);
8387
    return -1;
8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400
}

/**
 * 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
8401
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
8402
{
8403
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8404

8405 8406
    virResetLastError();

8407
    if (!VIR_IS_CONNECT(conn)) {
8408
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8409
        virDispatchError(NULL);
8410
        return -1;
8411 8412
    }

8413
    if ((names == NULL) || (maxnames < 0)) {
8414
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8415
        goto error;
8416 8417
    }

8418 8419 8420 8421 8422 8423 8424
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8425

8426
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8427 8428

error:
8429
    virDispatchError(conn);
8430
    return -1;
8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443
}

/**
 * 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)
{
8444
    VIR_DEBUG("conn=%p", conn);
8445

8446 8447
    virResetLastError();

8448
    if (!VIR_IS_CONNECT(conn)) {
8449
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8450
        virDispatchError(NULL);
8451
        return -1;
8452 8453
    }

8454 8455 8456 8457 8458 8459 8460
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8461

8462
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8463 8464

error:
8465
    virDispatchError(conn);
8466
    return -1;
8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479
}

/**
 * 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
8480
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
8481 8482
                              int maxnames)
{
8483
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8484

8485 8486
    virResetLastError();

8487
    if (!VIR_IS_CONNECT(conn)) {
8488
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8489
        virDispatchError(NULL);
8490
        return -1;
8491 8492
    }

8493
    if ((names == NULL) || (maxnames < 0)) {
8494
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8495
        goto error;
8496 8497
    }

8498 8499 8500 8501 8502 8503 8504 8505
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8506

8507
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8508 8509

error:
8510
    virDispatchError(conn);
8511
    return -1;
8512 8513 8514 8515 8516 8517 8518 8519 8520
}

/**
 * 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.
 *
8521 8522
 * 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.
8523 8524 8525 8526
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
8527
    VIR_DEBUG("conn=%p, name=%s", conn, name);
8528

8529 8530
    virResetLastError();

8531
    if (!VIR_IS_CONNECT(conn)) {
8532
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8533
        virDispatchError(NULL);
8534
        return NULL;
8535 8536
    }
    if (name == NULL) {
8537
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8538
        goto  error;
8539 8540
    }

8541 8542 8543 8544 8545 8546 8547
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8548

8549
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8550 8551

error:
8552
    virDispatchError(conn);
8553
    return NULL;
8554 8555 8556 8557 8558 8559 8560 8561 8562
}

/**
 * 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.
 *
8563 8564
 * 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.
8565 8566 8567 8568
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
8569
    VIR_UUID_DEBUG(conn, uuid);
8570

8571 8572
    virResetLastError();

8573
    if (!VIR_IS_CONNECT(conn)) {
8574
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8575
        virDispatchError(NULL);
8576
        return NULL;
8577 8578
    }
    if (uuid == NULL) {
8579
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8580
        goto error;
8581 8582
    }

8583 8584 8585 8586 8587 8588 8589
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
8590

8591
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8592 8593

error:
8594
    virDispatchError(conn);
8595
    return NULL;
8596 8597 8598 8599 8600 8601 8602 8603 8604
}

/**
 * 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.
 *
8605 8606
 * 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.
8607 8608 8609 8610 8611
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
8612
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
8613

8614 8615
    virResetLastError();

8616
    if (!VIR_IS_CONNECT(conn)) {
8617
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8618
        virDispatchError(NULL);
8619
        return NULL;
8620 8621
    }
    if (uuidstr == NULL) {
8622
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8623
        goto error;
8624 8625
    }

8626
    if (virUUIDParse(uuidstr, uuid) < 0) {
8627
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8628
        goto error;
8629 8630 8631
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
8632 8633

error:
8634
    virDispatchError(conn);
8635
    return NULL;
8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650
}

/**
 * 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)
{
8651
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
8652

8653 8654
    virResetLastError();

8655
    if (!VIR_IS_CONNECT(conn)) {
8656
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8657
        virDispatchError(NULL);
8658
        return NULL;
8659 8660
    }
    if (xmlDesc == NULL) {
8661
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8662
        goto error;
8663 8664
    }
    if (conn->flags & VIR_CONNECT_RO) {
8665
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8666
        goto error;
8667 8668
    }

8669 8670 8671 8672 8673 8674 8675
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
8676

8677
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8678 8679

error:
8680
    virDispatchError(conn);
8681
    return NULL;
8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693
}

/**
 * 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
8694 8695
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
8696
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
8697

8698 8699
    virResetLastError();

8700
    if (!VIR_IS_CONNECT(conn)) {
8701
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8702
        virDispatchError(NULL);
8703
        return NULL;
8704 8705
    }
    if (conn->flags & VIR_CONNECT_RO) {
8706
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8707
        goto error;
8708 8709
    }
    if (xml == NULL) {
8710
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8711
        goto error;
8712 8713
    }

8714 8715 8716 8717 8718 8719 8720
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
8721

8722
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8723 8724

error:
8725
    virDispatchError(conn);
8726
    return NULL;
8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739
}

/**
 * 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;
8740
    VIR_DEBUG("network=%p", network);
8741

8742 8743
    virResetLastError();

8744
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
8745
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8746
        virDispatchError(NULL);
8747
        return -1;
8748 8749 8750
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8751
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8752
        goto error;
8753 8754
    }

8755 8756 8757 8758 8759 8760 8761
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
8762

8763
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8764 8765

error:
8766
    virDispatchError(network->conn);
8767
    return -1;
8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779
}

/**
 * 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
8780 8781
virNetworkCreate(virNetworkPtr network)
{
8782
    virConnectPtr conn;
8783
    VIR_DEBUG("network=%p", network);
8784

8785 8786
    virResetLastError();

8787
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
8788
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8789
        virDispatchError(NULL);
8790
        return -1;
8791 8792 8793
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8794
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8795
        goto error;
8796 8797
    }

8798 8799 8800 8801 8802 8803 8804
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
8805

8806
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8807 8808

error:
8809
    virDispatchError(network->conn);
8810
    return -1;
8811 8812 8813 8814 8815 8816 8817
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
8818 8819 8820
 * 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
8821 8822 8823 8824 8825 8826 8827
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
8828
    VIR_DEBUG("network=%p", network);
8829

8830 8831
    virResetLastError();

8832
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
8833
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8834
        virDispatchError(NULL);
8835
        return -1;
8836 8837 8838 8839
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8840
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8841
        goto error;
8842 8843
    }

8844 8845 8846 8847 8848 8849 8850
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
8851

8852
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8853 8854

error:
8855
    virDispatchError(network->conn);
8856
    return -1;
8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870
}

/**
 * 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)
{
8871
    VIR_DEBUG("network=%p", network);
8872

8873 8874 8875
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
8876
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8877
        virDispatchError(NULL);
8878
        return -1;
8879
    }
8880 8881
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
8882
        return -1;
8883
    }
8884
    return 0;
8885 8886
}

8887 8888
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
8889
 * @network: the network to hold a reference on
8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900
 *
 * 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 已提交
8901 8902
 *
 * Returns 0 in case of success, -1 in case of failure.
8903 8904 8905 8906 8907
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
8908
        virLibConnError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8909
        virDispatchError(NULL);
8910
        return -1;
8911 8912
    }
    virMutexLock(&network->conn->lock);
8913
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
8914 8915 8916 8917 8918
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930
/**
 * 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)
{
8931
    VIR_DEBUG("network=%p", network);
8932

8933 8934
    virResetLastError();

8935
    if (!VIR_IS_NETWORK(network)) {
8936
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8937
        virDispatchError(NULL);
8938
        return NULL;
8939
    }
8940
    return network->name;
8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954
}

/**
 * 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)
{
8955
    VIR_DEBUG("network=%p, uuid=%p", network, uuid);
8956

8957 8958
    virResetLastError();

8959
    if (!VIR_IS_NETWORK(network)) {
8960
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8961
        virDispatchError(NULL);
8962
        return -1;
8963 8964
    }
    if (uuid == NULL) {
8965
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8966
        goto error;
8967 8968 8969 8970
    }

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

8971
    return 0;
8972 8973

error:
8974
    virDispatchError(network->conn);
8975
    return -1;
8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991
}

/**
 * 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];
8992
    VIR_DEBUG("network=%p, buf=%p", network, buf);
8993

8994 8995
    virResetLastError();

8996
    if (!VIR_IS_NETWORK(network)) {
8997
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8998
        virDispatchError(NULL);
8999
        return -1;
9000 9001
    }
    if (buf == NULL) {
9002
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9003
        goto error;
9004 9005 9006
    }

    if (virNetworkGetUUID(network, &uuid[0]))
9007
        goto error;
9008

9009
    virUUIDFormat(uuid, buf);
9010
    return 0;
9011 9012

error:
9013
    virDispatchError(network->conn);
9014
    return -1;
9015 9016 9017 9018 9019
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
9020
 * @flags: an OR'ed set of extraction flags, not used yet
9021 9022 9023 9024 9025 9026 9027 9028
 *
 * 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 *
9029
virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
9030
{
9031
    virConnectPtr conn;
9032
    VIR_DEBUG("network=%p, flags=%x", network, flags);
9033

9034 9035 9036
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9037
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9038
        virDispatchError(NULL);
9039
        return NULL;
9040 9041
    }

9042 9043
    conn = network->conn;

9044
    if (conn->networkDriver && conn->networkDriver->networkGetXMLDesc) {
9045
        char *ret;
9046
        ret = conn->networkDriver->networkGetXMLDesc(network, flags);
9047 9048 9049 9050
        if (!ret)
            goto error;
        return ret;
    }
9051

9052
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9053 9054

error:
9055
    virDispatchError(network->conn);
9056
    return NULL;
9057
}
9058 9059 9060 9061 9062

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
9063
 * Provides a bridge interface name to which a domain may connect
9064 9065 9066 9067 9068 9069 9070 9071
 * 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)
{
9072
    virConnectPtr conn;
9073
    VIR_DEBUG("network=%p", network);
9074

9075 9076 9077
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9078
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9079
        virDispatchError(NULL);
9080
        return NULL;
9081 9082
    }

9083 9084
    conn = network->conn;

9085 9086 9087 9088 9089 9090 9091
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
9092

9093
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9094 9095

error:
9096
    virDispatchError(network->conn);
9097
    return NULL;
9098
}
9099 9100 9101 9102

/**
 * virNetworkGetAutostart:
 * @network: a network object
9103
 * @autostart: the value returned
9104
 *
9105
 * Provides a boolean value indicating whether the network
9106 9107 9108 9109 9110 9111 9112
 * 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,
9113 9114 9115
                       int *autostart)
{
    virConnectPtr conn;
9116
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
9117

9118 9119 9120
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9121
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9122
        virDispatchError(NULL);
9123
        return -1;
9124 9125
    }
    if (!autostart) {
9126
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9127
        goto error;
9128 9129
    }

9130 9131
    conn = network->conn;

9132 9133 9134 9135 9136 9137 9138
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9139

9140
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9141 9142

error:
9143
    virDispatchError(network->conn);
9144
    return -1;
9145 9146 9147 9148 9149
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
9150
 * @autostart: whether the network should be automatically started 0 or 1
9151 9152 9153 9154 9155 9156 9157 9158
 *
 * 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,
9159 9160 9161
                       int autostart)
{
    virConnectPtr conn;
9162
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
9163

9164 9165 9166
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9167
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9168
        virDispatchError(NULL);
9169
        return -1;
9170 9171
    }

9172
    if (network->conn->flags & VIR_CONNECT_RO) {
9173
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9174
        goto error;
9175 9176
    }

9177 9178
    conn = network->conn;

9179 9180 9181 9182 9183 9184 9185
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9186

9187
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9188 9189

error:
9190
    virDispatchError(network->conn);
9191
    return -1;
9192
}
9193

D
Daniel Veillard 已提交
9194 9195
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
9196
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208
 *
 * 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
9209
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
9210
{
9211
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9212 9213 9214

    virResetLastError();

9215
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
9216
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9217
        virDispatchError(NULL);
D
Daniel Veillard 已提交
9218 9219
        return NULL;
    }
9220
    return iface->conn;
D
Daniel Veillard 已提交
9221 9222 9223 9224 9225 9226
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
9227
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
9228
 *
9229
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
9230 9231 9232 9233
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
9234
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
9235 9236 9237 9238

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9239
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9240
        virDispatchError(NULL);
9241
        return -1;
D
Daniel Veillard 已提交
9242 9243 9244 9245 9246 9247 9248 9249 9250 9251
    }

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

9252
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9253 9254

error:
9255
    virDispatchError(conn);
D
Daniel Veillard 已提交
9256 9257 9258 9259 9260 9261 9262 9263 9264
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
9265 9266
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
9267 9268 9269 9270 9271 9272
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
9273
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
9274 9275 9276 9277

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9278
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9279
        virDispatchError(NULL);
9280
        return -1;
D
Daniel Veillard 已提交
9281 9282 9283
    }

    if ((names == NULL) || (maxnames < 0)) {
9284
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295
        goto error;
    }

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

9296
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9297 9298

error:
9299
    virDispatchError(conn);
D
Daniel Veillard 已提交
9300 9301 9302
    return -1;
}

9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313
/**
 * 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)
{
9314
    VIR_DEBUG("conn=%p", conn);
9315 9316 9317 9318

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9319
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9320
        virDispatchError(NULL);
9321
        return -1;
9322 9323 9324 9325 9326 9327 9328 9329 9330 9331
    }

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

9332
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9333 9334

error:
9335
    virDispatchError(conn);
9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354
    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)
{
9355
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
9356 9357 9358 9359

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9360
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9361
        virDispatchError(NULL);
9362
        return -1;
9363 9364 9365
    }

    if ((names == NULL) || (maxnames < 0)) {
9366
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377
        goto error;
    }

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

9378
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9379 9380

error:
9381
    virDispatchError(conn);
9382 9383 9384
    return -1;
}

D
Daniel Veillard 已提交
9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397
/**
 * 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)
{
9398
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
9399 9400 9401 9402

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9403
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9404
        virDispatchError(NULL);
9405
        return NULL;
D
Daniel Veillard 已提交
9406 9407
    }
    if (name == NULL) {
9408
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419
        goto  error;
    }

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

9420
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9421 9422

error:
9423
    virDispatchError(conn);
D
Daniel Veillard 已提交
9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439
    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)
{
9440
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
9441 9442 9443 9444

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9445
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9446
        virDispatchError(NULL);
9447
        return NULL;
D
Daniel Veillard 已提交
9448 9449
    }
    if (macstr == NULL) {
9450
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461
        goto  error;
    }

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

9462
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9463 9464

error:
9465
    virDispatchError(conn);
D
Daniel Veillard 已提交
9466 9467 9468 9469 9470
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
9471
 * @iface: an interface object
D
Daniel Veillard 已提交
9472 9473 9474 9475 9476 9477 9478
 *
 * 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 *
9479
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
9480
{
9481
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9482 9483 9484

    virResetLastError();

9485
    if (!VIR_IS_INTERFACE(iface)) {
9486
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9487
        virDispatchError(NULL);
9488
        return NULL;
D
Daniel Veillard 已提交
9489
    }
9490
    return iface->name;
D
Daniel Veillard 已提交
9491 9492 9493 9494
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
9495
 * @iface: an interface object
D
Daniel Veillard 已提交
9496
 *
L
Laine Stump 已提交
9497
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
9498 9499 9500 9501 9502 9503 9504
 * 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 *
9505
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
9506
{
9507
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9508 9509 9510

    virResetLastError();

9511
    if (!VIR_IS_INTERFACE(iface)) {
9512
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9513
        virDispatchError(NULL);
9514
        return NULL;
D
Daniel Veillard 已提交
9515
    }
9516
    return iface->mac;
D
Daniel Veillard 已提交
9517 9518 9519 9520
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
9521
 * @iface: an interface object
9522 9523 9524 9525 9526
 * @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 已提交
9527
 *
9528 9529 9530 9531 9532
 * 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 已提交
9533 9534 9535 9536 9537
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
9538
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
9539 9540
{
    virConnectPtr conn;
9541
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
9542 9543 9544

    virResetLastError();

9545
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9546
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9547
        virDispatchError(NULL);
9548
        return NULL;
D
Daniel Veillard 已提交
9549 9550
    }

9551
    conn = iface->conn;
D
Daniel Veillard 已提交
9552 9553 9554

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
9555
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
9556 9557 9558 9559 9560
        if (!ret)
            goto error;
        return ret;
    }

9561
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9562 9563

error:
9564
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
9565 9566 9567 9568 9569 9570 9571 9572 9573
    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
 *
9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585

 * Define an interface (or modify existing interface configuration).
 *
 * Normally this change in the interface configuration is immediately
 * permanent/persistent, but if virInterfaceChangeBegin() has been
 * previously called (i.e. if an interface config transaction is
 * open), the new interface definition will only become permanent if
 * virInterfaceChangeCommit() is called prior to the next reboot of
 * the system running libvirtd. Prior to that time, it can be
 * explicitly removed using virInterfaceChangeRollback(), or will be
 * automatically removed during the next reboot of the system running
 * libvirtd.
D
Daniel Veillard 已提交
9586 9587 9588 9589 9590 9591
 *
 * Returns NULL in case of error, a pointer to the interface otherwise
 */
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
9592
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
D
Daniel Veillard 已提交
9593 9594 9595 9596

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9597
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9598
        virDispatchError(NULL);
9599
        return NULL;
D
Daniel Veillard 已提交
9600 9601
    }
    if (conn->flags & VIR_CONNECT_RO) {
9602
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9603 9604 9605
        goto error;
    }
    if (xml == NULL) {
9606
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617
        goto error;
    }

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

9618
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9619 9620

error:
9621
    virDispatchError(conn);
D
Daniel Veillard 已提交
9622 9623 9624 9625 9626
    return NULL;
}

/**
 * virInterfaceUndefine:
9627
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
9628 9629 9630 9631
 *
 * Undefine an interface, ie remove it from the config.
 * This does not free the associated virInterfacePtr object.
 *
9632 9633 9634 9635 9636 9637 9638 9639 9640 9641
 * Normally this change in the interface configuration is
 * permanent/persistent, but if virInterfaceChangeBegin() has been
 * previously called (i.e. if an interface config transaction is
 * open), the removal of the interface definition will only become
 * permanent if virInterfaceChangeCommit() is called prior to the next
 * reboot of the system running libvirtd. Prior to that time, the
 * definition can be explicitly restored using
 * virInterfaceChangeRollback(), or will be automatically restored
 * during the next reboot of the system running libvirtd.
 *
D
Daniel Veillard 已提交
9642 9643 9644
 * Returns 0 in case of success, -1 in case of error
 */
int
9645
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
9646
    virConnectPtr conn;
9647
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9648 9649 9650

    virResetLastError();

9651
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9652
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9653
        virDispatchError(NULL);
9654
        return -1;
D
Daniel Veillard 已提交
9655
    }
9656
    conn = iface->conn;
D
Daniel Veillard 已提交
9657
    if (conn->flags & VIR_CONNECT_RO) {
9658
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9659 9660 9661 9662 9663
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
9664
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
9665 9666 9667 9668 9669
        if (ret < 0)
            goto error;
        return ret;
    }

9670
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9671 9672

error:
9673
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
9674 9675 9676 9677 9678
    return -1;
}

/**
 * virInterfaceCreate:
9679
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
9680 9681
 * @flags: and OR'ed set of extraction flags, not used yet
 *
9682
 * Activate an interface (i.e. call "ifup").
D
Daniel Veillard 已提交
9683
 *
9684 9685 9686 9687 9688
 * If there was an open network config transaction at the time this
 * interface was defined (that is, if virInterfaceChangeBegin() had
 * been called), the interface will be brought back down (and then
 * undefined) if virInterfaceChangeRollback() is called.
p *
D
Daniel Veillard 已提交
9689 9690 9691
 * Returns 0 in case of success, -1 in case of error
 */
int
9692
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
9693 9694
{
    virConnectPtr conn;
9695
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
9696 9697 9698

    virResetLastError();

9699
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9700
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9701
        virDispatchError(NULL);
9702
        return -1;
D
Daniel Veillard 已提交
9703
    }
9704
    conn = iface->conn;
D
Daniel Veillard 已提交
9705
    if (conn->flags & VIR_CONNECT_RO) {
9706
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9707 9708 9709 9710 9711
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
9712
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
9713 9714 9715 9716 9717
        if (ret < 0)
            goto error;
        return ret;
    }

9718
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9719 9720

error:
9721
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
9722 9723 9724 9725 9726
    return -1;
}

/**
 * virInterfaceDestroy:
9727
 * @iface: an interface object
D
Daniel Veillard 已提交
9728 9729 9730 9731 9732 9733
 * @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.
 *
9734 9735 9736 9737 9738 9739 9740

 * If there is an open network config transaction at the time this
 * interface is destroyed (that is, if virInterfaceChangeBegin() had
 * been called), and if the interface is later undefined and then
 * virInterfaceChangeRollback() is called, the restoral of the
 * interface definition will also bring the interface back up.
 *
D
Daniel Veillard 已提交
9741 9742 9743
 * Returns 0 in case of success and -1 in case of failure.
 */
int
9744
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
9745 9746
{
    virConnectPtr conn;
9747
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
9748 9749 9750

    virResetLastError();

9751
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9752
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9753
        virDispatchError(NULL);
9754
        return -1;
D
Daniel Veillard 已提交
9755 9756
    }

9757
    conn = iface->conn;
D
Daniel Veillard 已提交
9758
    if (conn->flags & VIR_CONNECT_RO) {
9759
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9760 9761 9762 9763 9764
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
9765
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
9766 9767 9768 9769 9770
        if (ret < 0)
            goto error;
        return ret;
    }

9771
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9772 9773

error:
9774
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
9775 9776 9777 9778 9779
    return -1;
}

/**
 * virInterfaceRef:
9780
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
9781 9782 9783 9784 9785 9786 9787 9788 9789
 *
 * 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 已提交
9790
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
9791 9792 9793 9794 9795
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
9796
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
9797
{
9798
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
9799
        virLibConnError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9800
        virDispatchError(NULL);
9801
        return -1;
D
Daniel Veillard 已提交
9802
    }
9803
    virMutexLock(&iface->conn->lock);
9804
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
9805 9806
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
9807 9808 9809 9810 9811
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
9812
 * @iface: an interface object
D
Daniel Veillard 已提交
9813 9814 9815 9816 9817 9818 9819
 *
 * 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
9820
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
9821
{
9822
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9823 9824 9825

    virResetLastError();

9826
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9827
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9828
        virDispatchError(NULL);
9829
        return -1;
D
Daniel Veillard 已提交
9830
    }
9831 9832
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
9833
        return -1;
9834
    }
9835
    return 0;
D
Daniel Veillard 已提交
9836 9837
}

9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857
/**
 * virInterfaceChangeBegin:
 * @conn: pointer to hypervisor connection
 * @flags: flags, not used yet
 *
 * This functions creates a restore point to which one can return
 * later by calling virInterfaceChangeRollback(). This function should
 * be called before any transaction with interface configuration.
 * Once knowing, new configuration works, it can be commited via
 * virInterfaceChangeCommit(), which frees the restore point.
 *
 * If virInterfaceChangeBegin() is called when a transaction is
 * already opened, this function will fail, and a
 * VIR_ERR_INVALID_OPERATION will be logged.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virInterfaceChangeBegin(virConnectPtr conn, unsigned int flags)
{
9858
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904

    virResetLastError();

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

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceChangeCommit:
 * @conn: pointer to hypervisor connection
 * @flags: flags, not used yet
 *
 * This commits the changes made to interfaces and frees the restore point
 * created by virInterfaceChangeBegin().
 *
 * If virInterfaceChangeCommit() is called when a transaction is not
 * opened, this function will fail, and a VIR_ERR_INVALID_OPERATION
 * will be logged.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virInterfaceChangeCommit(virConnectPtr conn, unsigned int flags)
{
9905
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951

    virResetLastError();

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

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceChangeRollback:
 * @conn: pointer to hypervisor connection
 * @flags: flags, not used yet
 *
 * This cancels changes made to interfaces settings by restoring previous
 * state created by virInterfaceChangeBegin().
 *
 * If virInterfaceChangeRollback() is called when a transaction is not
 * opened, this function will fail, and a VIR_ERR_INVALID_OPERATION
 * will be logged.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virInterfaceChangeRollback(virConnectPtr conn, unsigned int flags)
{
9952
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982

    virResetLastError();

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

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

9983 9984 9985

/**
 * virStoragePoolGetConnect:
9986
 * @pool: pointer to a pool
9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000
 *
 * 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)
{
10001
    VIR_DEBUG("pool=%p", pool);
10002

10003 10004 10005
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
10006
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10007
        virDispatchError(NULL);
10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023
        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)
{
10024
    VIR_DEBUG("conn=%p", conn);
10025

10026 10027
    virResetLastError();

10028
    if (!VIR_IS_CONNECT(conn)) {
10029
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10030
        virDispatchError(NULL);
10031
        return -1;
10032 10033
    }

10034 10035 10036 10037 10038 10039 10040
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
10041

10042
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10043 10044

error:
10045
    virDispatchError(conn);
10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065
    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)
{
10066
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
10067

10068 10069
    virResetLastError();

10070
    if (!VIR_IS_CONNECT(conn)) {
10071
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10072
        virDispatchError(NULL);
10073
        return -1;
10074 10075 10076
    }

    if ((names == NULL) || (maxnames < 0)) {
10077
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10078
        goto error;
10079 10080
    }

10081 10082 10083 10084 10085 10086 10087
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
10088

10089
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10090

10091
error:
10092
    virDispatchError(conn);
10093
    return -1;
10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107
}


/**
 * 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)
{
10108
    VIR_DEBUG("conn=%p", conn);
10109

10110 10111
    virResetLastError();

10112
    if (!VIR_IS_CONNECT(conn)) {
10113
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10114
        virDispatchError(NULL);
10115
        return -1;
10116 10117
    }

10118 10119 10120 10121 10122 10123 10124
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
10125

10126
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10127 10128

error:
10129
    virDispatchError(conn);
10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150
    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)
{
10151
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
10152

10153 10154
    virResetLastError();

10155
    if (!VIR_IS_CONNECT(conn)) {
10156
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10157
        virDispatchError(NULL);
10158
        return -1;
10159 10160 10161
    }

    if ((names == NULL) || (maxnames < 0)) {
10162
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10163
        goto error;
10164 10165
    }

10166 10167 10168 10169 10170 10171 10172
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
10173

10174
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10175 10176

error:
10177
    virDispatchError(conn);
10178 10179 10180 10181
    return -1;
}


10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208
/**
 * 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)
{
10209 10210
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%x",
              conn, type ? type : "", srcSpec ? srcSpec : "", flags);
10211 10212 10213

    virResetLastError();

10214
    if (!VIR_IS_CONNECT(conn)) {
10215
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10216
        virDispatchError(NULL);
10217
        return NULL;
10218 10219
    }
    if (type == NULL) {
10220
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10221
        goto error;
10222 10223
    }

10224
    if (conn->flags & VIR_CONNECT_RO) {
10225
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10226
        goto error;
10227 10228
    }

10229 10230 10231 10232 10233 10234 10235
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
10236

10237
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10238 10239

error:
10240
    virDispatchError(conn);
10241 10242 10243 10244
    return NULL;
}


10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257
/**
 * 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)
{
10258
    VIR_DEBUG("conn=%p, name=%s", conn, name);
10259

10260 10261
    virResetLastError();

10262
    if (!VIR_IS_CONNECT(conn)) {
10263
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10264
        virDispatchError(NULL);
10265
        return NULL;
10266 10267
    }
    if (name == NULL) {
10268
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10269
        goto error;
10270 10271
    }

10272 10273 10274 10275 10276 10277 10278
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
10279

10280
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10281 10282

error:
10283
    virDispatchError(conn);
10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300
    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)
{
10301
    VIR_UUID_DEBUG(conn, uuid);
10302

10303 10304
    virResetLastError();

10305
    if (!VIR_IS_CONNECT(conn)) {
10306
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10307
        virDispatchError(NULL);
10308
        return NULL;
10309 10310
    }
    if (uuid == NULL) {
10311
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10312
        goto error;
10313 10314
    }

10315 10316 10317 10318 10319 10320 10321
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
10322

10323
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10324

10325
error:
10326
    virDispatchError(conn);
10327
    return NULL;
10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341
}


/**
 * 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,
10342
                                 const char *uuidstr)
10343 10344
{
    unsigned char uuid[VIR_UUID_BUFLEN];
10345
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
10346

10347 10348
    virResetLastError();

10349
    if (!VIR_IS_CONNECT(conn)) {
10350
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10351
        virDispatchError(NULL);
10352
        return NULL;
10353 10354
    }
    if (uuidstr == NULL) {
10355
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10356
        goto error;
10357 10358 10359
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
10360
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10361
        goto error;
10362 10363 10364
    }

    return virStoragePoolLookupByUUID(conn, uuid);
10365 10366

error:
10367
    virDispatchError(conn);
10368
    return NULL;
10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382
}


/**
 * 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)
{
10383
    VIR_DEBUG("vol=%p", vol);
10384

10385 10386 10387
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10388
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10389
        virDispatchError(NULL);
10390
        return NULL;
10391 10392
    }

10393 10394 10395 10396 10397 10398 10399
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
10400

10401
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10402

10403
error:
10404
    virDispatchError(vol->conn);
10405
    return NULL;
10406 10407 10408 10409 10410 10411
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
10412
 * @flags: future flags, use 0 for now
10413 10414
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
10415
 * pool is not persistent, so its definition will disappear
10416 10417 10418 10419 10420 10421 10422 10423 10424
 * 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)
{
E
Eric Blake 已提交
10425
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
10426

10427 10428
    virResetLastError();

10429
    if (!VIR_IS_CONNECT(conn)) {
10430
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10431
        virDispatchError(NULL);
10432
        return NULL;
10433 10434
    }
    if (xmlDesc == NULL) {
10435
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10436
        goto error;
10437 10438
    }
    if (conn->flags & VIR_CONNECT_RO) {
10439
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10440
        goto error;
10441 10442
    }

10443 10444 10445 10446 10447 10448 10449
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
10450

10451
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10452 10453

error:
10454
    virDispatchError(conn);
10455 10456 10457 10458 10459 10460 10461
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
10462
 * @flags: future flags, use 0 for now
10463 10464
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
10465
 * pool is persistent, until explicitly undefined.
10466 10467 10468 10469 10470 10471 10472 10473
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
E
Eric Blake 已提交
10474
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
10475

10476 10477
    virResetLastError();

10478
    if (!VIR_IS_CONNECT(conn)) {
10479
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10480
        virDispatchError(NULL);
10481
        return NULL;
10482 10483
    }
    if (conn->flags & VIR_CONNECT_RO) {
10484
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10485
        goto error;
10486 10487
    }
    if (xml == NULL) {
10488
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10489
        goto error;
10490 10491
    }

10492 10493 10494 10495 10496 10497 10498
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
10499

10500
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10501

10502
error:
10503
    virDispatchError(conn);
10504
    return NULL;
10505 10506 10507 10508 10509
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
10510
 * @flags: future flags, use 0 for now
O
Osier Yang 已提交
10511 10512 10513 10514
 * @flags: flags to control pool build behaviour
 *
 * Currently only filesystem pool accepts flags VIR_STORAGE_POOL_BUILD_OVERWRITE
 * and VIR_STORAGE_POOL_BUILD_NO_OVERWRITE.
10515 10516 10517 10518 10519 10520 10521 10522 10523 10524
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
10525
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10526

10527 10528
    virResetLastError();

10529
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10530
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
10531
        virDispatchError(NULL);
10532
        return -1;
10533 10534 10535
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10536
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10537
        goto error;
10538 10539
    }

10540 10541 10542 10543 10544 10545 10546
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10547

10548
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10549

10550
error:
10551
    virDispatchError(pool->conn);
10552
    return -1;
10553 10554 10555 10556 10557 10558 10559 10560 10561
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
10562
 * Returns 0 on success, -1 on failure
10563 10564 10565 10566 10567
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
10568
    VIR_DEBUG("pool=%p", pool);
10569

10570 10571
    virResetLastError();

10572
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10573
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
10574
        virDispatchError(NULL);
10575
        return -1;
10576 10577 10578
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10579
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10580
        goto error;
10581 10582
    }

10583 10584 10585 10586 10587 10588 10589
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
10590

10591
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10592

10593
error:
10594
    virDispatchError(pool->conn);
10595
    return -1;
10596 10597 10598 10599 10600 10601
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
10602
 * @flags: future flags, use 0 for now
10603 10604 10605 10606 10607 10608 10609 10610 10611 10612
 *
 * 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;
E
Eric Blake 已提交
10613
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10614

10615 10616
    virResetLastError();

10617
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10618
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10619
        virDispatchError(NULL);
10620
        return -1;
10621 10622 10623
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10624
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10625
        goto error;
10626 10627
    }

10628 10629 10630 10631 10632 10633 10634
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10635

10636
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10637

10638
error:
10639
    virDispatchError(pool->conn);
10640
    return -1;
10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659
}


/**
 * 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;
10660
    VIR_DEBUG("pool=%p", pool);
10661

10662 10663
    virResetLastError();

10664
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10665
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10666
        virDispatchError(NULL);
10667
        return -1;
10668 10669 10670 10671
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10672
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10673
        goto error;
10674 10675
    }

10676 10677 10678 10679 10680 10681 10682
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
10683

10684
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10685 10686

error:
10687
    virDispatchError(pool->conn);
10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706
    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;
10707
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10708

10709 10710
    virResetLastError();

10711
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10712
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10713
        virDispatchError(NULL);
10714
        return -1;
10715 10716 10717 10718
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10719
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10720
        goto error;
10721 10722
    }

10723 10724 10725 10726 10727 10728 10729
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10730

10731
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10732 10733

error:
10734
    virDispatchError(pool->conn);
10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750
    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)
{
10751
    VIR_DEBUG("pool=%p", pool);
10752

10753 10754 10755
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10756
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10757
        virDispatchError(NULL);
10758
        return -1;
10759
    }
10760 10761
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
10762
        return -1;
10763
    }
10764
    return 0;
10765 10766 10767 10768

}


10769 10770
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
10771
 * @pool: the pool to hold a reference on
10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782
 *
 * 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 已提交
10783 10784
 *
 * Returns 0 in case of success, -1 in case of failure.
10785 10786 10787 10788 10789
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
10790
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10791
        virDispatchError(NULL);
10792
        return -1;
10793 10794
    }
    virMutexLock(&pool->conn->lock);
10795
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
10796 10797 10798 10799 10800
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

10801 10802 10803 10804 10805 10806 10807 10808 10809
/**
 * 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
 *
10810
 * Returns 0 if the volume list was refreshed, -1 on failure
10811 10812 10813 10814 10815 10816
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
E
Eric Blake 已提交
10817
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10818

10819 10820
    virResetLastError();

10821
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10822
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10823
        virDispatchError(NULL);
10824
        return -1;
10825 10826 10827 10828
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10829
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10830
        goto error;
10831 10832
    }

10833 10834 10835 10836 10837 10838 10839
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10840

10841
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10842 10843

error:
10844
    virDispatchError(pool->conn);
10845 10846 10847 10848 10849 10850 10851 10852 10853 10854
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
10855
 * Returns the name of the pool, or NULL on error
10856 10857 10858 10859
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
10860
    VIR_DEBUG("pool=%p", pool);
10861

10862 10863
    virResetLastError();

10864
    if (!VIR_IS_STORAGE_POOL(pool)) {
10865
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10866
        virDispatchError(NULL);
10867
        return NULL;
10868
    }
10869
    return pool->name;
10870 10871 10872 10873 10874 10875 10876 10877 10878 10879
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
10880
 * Returns 0 on success, or -1 on error;
10881 10882 10883 10884 10885
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
10886
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
10887

10888 10889
    virResetLastError();

10890
    if (!VIR_IS_STORAGE_POOL(pool)) {
10891
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10892
        virDispatchError(NULL);
10893
        return -1;
10894 10895
    }
    if (uuid == NULL) {
10896
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10897
        goto error;
10898 10899 10900 10901
    }

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

10902
    return 0;
10903

10904
error:
10905
    virDispatchError(pool->conn);
10906
    return -1;
10907 10908 10909 10910 10911 10912 10913 10914 10915
}

/**
 * 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
 *
10916
 * Returns 0 on success, or -1 on error;
10917 10918 10919 10920 10921 10922
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
10923
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
10924

10925 10926
    virResetLastError();

10927
    if (!VIR_IS_STORAGE_POOL(pool)) {
10928
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10929
        virDispatchError(NULL);
10930
        return -1;
10931 10932
    }
    if (buf == NULL) {
10933
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10934
        goto error;
10935 10936 10937
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
10938
        goto error;
10939 10940

    virUUIDFormat(uuid, buf);
10941
    return 0;
10942

10943
error:
10944
    virDispatchError(pool->conn);
10945
    return -1;
10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956
}


/**
 * 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
 *
10957
 * Returns 0 on success, or -1 on failure.
10958 10959 10960 10961 10962 10963
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
10964
    VIR_DEBUG("pool=%p, info=%p", pool, info);
10965

10966 10967
    virResetLastError();

10968
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10969
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10970
        virDispatchError(NULL);
10971
        return -1;
10972 10973
    }
    if (info == NULL) {
10974
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10975
        goto error;
10976 10977 10978 10979 10980 10981
    }

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

    conn = pool->conn;

10982 10983 10984 10985 10986 10987 10988
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
10989

10990
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10991

10992
error:
10993
    virDispatchError(pool->conn);
10994
    return -1;
10995 10996 10997 10998 10999 11000
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
11001
 * @flags: flags for XML format options (set of virDomainXMLFlags)
11002 11003 11004 11005 11006
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
11007
 * Returns a XML document, or NULL on error
11008 11009 11010 11011 11012 11013
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
11014
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11015

11016 11017 11018
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11019
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11020
        virDispatchError(NULL);
11021
        return NULL;
11022 11023 11024 11025
    }

    conn = pool->conn;

11026 11027 11028 11029 11030 11031 11032
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
11033

11034
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11035

11036
error:
11037
    virDispatchError(pool->conn);
11038
    return NULL;
11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049
}


/**
 * 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
 *
11050
 * Returns 0 on success, -1 on failure
11051 11052 11053 11054 11055 11056
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
11057
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
11058

11059 11060 11061
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11062
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11063
        virDispatchError(NULL);
11064
        return -1;
11065 11066
    }
    if (!autostart) {
11067
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11068
        goto error;
11069 11070 11071 11072
    }

    conn = pool->conn;

11073 11074 11075 11076 11077 11078 11079
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
11080

11081
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11082 11083

error:
11084
    virDispatchError(pool->conn);
11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
11096
 * Returns 0 on success, -1 on failure
11097 11098 11099 11100 11101 11102
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
11103
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
11104

11105 11106 11107
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11108
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11109
        virDispatchError(NULL);
11110
        return -1;
11111 11112
    }

11113
    if (pool->conn->flags & VIR_CONNECT_RO) {
11114
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11115
        goto error;
11116 11117
    }

11118 11119
    conn = pool->conn;

11120 11121 11122 11123 11124 11125 11126
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
11127

11128
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11129 11130

error:
11131
    virDispatchError(pool->conn);
11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146
    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)
{
11147
    VIR_DEBUG("pool=%p", pool);
11148

11149 11150
    virResetLastError();

11151
    if (!VIR_IS_STORAGE_POOL(pool)) {
11152
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11153
        virDispatchError(NULL);
11154
        return -1;
11155 11156
    }

11157 11158 11159 11160 11161 11162 11163
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
11164

11165
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11166 11167

error:
11168
    virDispatchError(pool->conn);
11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188
    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)
{
11189
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
11190

11191 11192
    virResetLastError();

11193
    if (!VIR_IS_STORAGE_POOL(pool)) {
11194
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11195
        virDispatchError(NULL);
11196
        return -1;
11197 11198 11199
    }

    if ((names == NULL) || (maxnames < 0)) {
11200
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11201
        goto error;
11202 11203
    }

11204 11205 11206 11207 11208 11209 11210
    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;
    }
11211

11212
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11213 11214

error:
11215
    virDispatchError(pool->conn);
11216 11217 11218 11219 11220 11221
    return -1;
}


/**
 * virStorageVolGetConnect:
11222
 * @vol: pointer to a pool
11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236
 *
 * 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)
{
11237
    VIR_DEBUG("vol=%p", vol);
11238

11239 11240
    virResetLastError();

11241
    if (!VIR_IS_STORAGE_VOL (vol)) {
11242
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11243
        virDispatchError(NULL);
11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257
        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
 *
11258
 * Returns a storage volume, or NULL if not found / error
11259 11260 11261 11262 11263
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
11264
    VIR_DEBUG("pool=%p, name=%s", pool, name);
11265

11266 11267
    virResetLastError();

11268
    if (!VIR_IS_STORAGE_POOL(pool)) {
11269
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11270
        virDispatchError(NULL);
11271
        return NULL;
11272 11273
    }
    if (name == NULL) {
11274
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11275
        goto error;
11276 11277
    }

11278 11279 11280 11281 11282 11283 11284
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
11285

11286
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11287 11288

error:
11289
    virDispatchError(pool->conn);
11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302
    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
 *
11303
 * Returns a storage volume, or NULL if not found / error
11304 11305 11306 11307 11308
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
11309
    VIR_DEBUG("conn=%p, key=%s", conn, key);
11310

11311 11312
    virResetLastError();

11313
    if (!VIR_IS_CONNECT(conn)) {
11314
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11315
        virDispatchError(NULL);
11316
        return NULL;
11317 11318
    }
    if (key == NULL) {
11319
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11320
        goto error;
11321 11322
    }

11323 11324 11325 11326 11327 11328 11329
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
11330

11331
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11332 11333

error:
11334
    virDispatchError(conn);
11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345
    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
 *
11346
 * Returns a storage volume, or NULL if not found / error
11347 11348 11349 11350 11351
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
11352
    VIR_DEBUG("conn=%p, path=%s", conn, path);
11353

11354 11355
    virResetLastError();

11356
    if (!VIR_IS_CONNECT(conn)) {
11357
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11358
        virDispatchError(NULL);
11359
        return NULL;
11360 11361
    }
    if (path == NULL) {
11362
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11363
        goto error;
11364 11365
    }

11366 11367 11368 11369 11370 11371 11372
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
11373

11374
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11375 11376

error:
11377
    virDispatchError(conn);
11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
11389
 * Returns the volume name, or NULL on error
11390 11391 11392 11393
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
11394
    VIR_DEBUG("vol=%p", vol);
11395

11396 11397
    virResetLastError();

11398
    if (!VIR_IS_STORAGE_VOL(vol)) {
11399
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11400
        virDispatchError(NULL);
11401
        return NULL;
11402
    }
11403
    return vol->name;
11404 11405 11406 11407 11408 11409 11410 11411
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
11412
 * unique, so the same volume will have the same
11413 11414
 * key no matter what host it is accessed from
 *
11415
 * Returns the volume key, or NULL on error
11416 11417 11418 11419
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
11420
    VIR_DEBUG("vol=%p", vol);
11421

11422 11423
    virResetLastError();

11424
    if (!VIR_IS_STORAGE_VOL(vol)) {
11425
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11426
        virDispatchError(NULL);
11427
        return NULL;
11428
    }
11429
    return vol->key;
11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442
}


/**
 * 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
 *
11443
 * Returns the storage volume, or NULL on error
11444 11445 11446 11447 11448 11449
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
11450
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11451

11452 11453
    virResetLastError();

11454
    if (!VIR_IS_STORAGE_POOL(pool)) {
11455
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11456
        virDispatchError(NULL);
11457
        return NULL;
11458 11459
    }

11460 11461 11462 11463 11464
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

11465
    if (pool->conn->flags & VIR_CONNECT_RO) {
11466
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11467
        goto error;
11468 11469
    }

11470 11471 11472 11473 11474 11475 11476
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
11477

11478
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11479 11480

error:
11481
    virDispatchError(pool->conn);
11482 11483 11484 11485
    return NULL;
}


11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497
/**
 * 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.
 *
11498
 * Returns the storage volume, or NULL on error
11499 11500 11501 11502 11503 11504 11505
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
11506
    VIR_DEBUG("pool=%p, flags=%x, clonevol=%p", pool, flags, clonevol);
11507 11508 11509 11510

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
11511
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11512
        virDispatchError(NULL);
11513
        return NULL;
11514 11515 11516
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
11517
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11518
        goto error;
11519 11520
    }

11521 11522 11523 11524 11525
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

11526 11527
    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
11528
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541
        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;
    }

11542
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11543 11544

error:
11545
    virDispatchError(pool->conn);
11546 11547 11548 11549
    return NULL;
}


11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576
/**
 * virStorageVolDownload:
 * @vol: pointer to volume to download from
 * @stream: stream to use as output
 * @offset: position in @vol to start reading from
 * @length: limit on amount of data to download
 * @flags: future flags (unused, pass 0)
 *
 * Download the content of the volume as a stream. If @length
 * is zero, then the remaining contents of the volume after
 * @offset will be downloaded.
 *
 * This call sets up an asynchronous stream; subsequent use of
 * stream APIs is necessary to transfer the actual data,
 * determine how much data is successfully transferred, and
 * detect any errors. The results will be unpredictable if
 * another active stream is writing to the storage volume.
 *
 * Returns 0, or -1 upon error.
 */
int
virStorageVolDownload(virStorageVolPtr vol,
                      virStreamPtr stream,
                      unsigned long long offset,
                      unsigned long long length,
                      unsigned int flags)
{
E
Eric Blake 已提交
11577
    VIR_DEBUG("vol=%p, stream=%p, offset=%llu, length=%llu, flags=%x",
11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 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
              vol, stream, offset, length, flags);

    virResetLastError();

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return -1;
    }

    if (!VIR_IS_STREAM(stream)) {
        virLibConnError(VIR_ERR_INVALID_STREAM, __FUNCTION__);
        return -1;
    }

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

    if (vol->conn->storageDriver &&
        vol->conn->storageDriver->volDownload) {
        int ret;
        ret = vol->conn->storageDriver->volDownload(vol,
                                                    stream,
                                                    offset,
                                                    length,
                                                    flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/**
 * virStorageVolUpload:
 * @vol: pointer to volume to upload
 * @stream: stream to use as input
 * @offset: position to start writing to
 * @length: limit on amount of data to upload
 * @flags: flags for creation (unused, pass 0)
 *
 * Upload new content to the volume from a stream. This call
 * will fail if @offset + @length exceeds the size of the
 * volume. Otherwise, if @length is non-zero, an error
 * will be raised if an attempt is made to upload greater
 * than @length bytes of data.
 *
 * This call sets up an asynchronous stream; subsequent use of
 * stream APIs is necessary to transfer the actual data,
 * determine how much data is successfully transferred, and
 * detect any errors. The results will be unpredictable if
 * another active stream is writing to the storage volume.
 *
 * Returns 0, or -1 upon error.
 */
int
virStorageVolUpload(virStorageVolPtr vol,
                    virStreamPtr stream,
                    unsigned long long offset,
                    unsigned long long length,
                    unsigned int flags)
{
E
Eric Blake 已提交
11648
    VIR_DEBUG("vol=%p, stream=%p, offset=%llu, length=%llu, flags=%x",
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
              vol, stream, offset, length, flags);

    virResetLastError();

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return -1;
    }

    if (!VIR_IS_STREAM(stream)) {
        virLibConnError(VIR_ERR_INVALID_STREAM, __FUNCTION__);
        return -1;
    }

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

    if (vol->conn->storageDriver &&
        vol->conn->storageDriver->volUpload) {
        int ret;
        ret = vol->conn->storageDriver->volUpload(vol,
                                                  stream,
                                                  offset,
                                                  length,
                                                  flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


11690 11691 11692
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
11693
 * @flags: future flags, use 0 for now
11694 11695 11696
 *
 * Delete the storage volume from the pool
 *
11697
 * Returns 0 on success, or -1 on error
11698 11699 11700 11701 11702 11703
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
11704
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
11705

11706 11707
    virResetLastError();

11708
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
11709
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11710
        virDispatchError(NULL);
11711
        return -1;
11712 11713 11714 11715
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11716
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11717
        goto error;
11718 11719
    }

11720 11721 11722 11723 11724 11725 11726
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11727

11728
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11729 11730

error:
11731
    virDispatchError(vol->conn);
11732 11733 11734 11735
    return -1;
}


11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749
/**
 * 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;
11750
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
11751 11752 11753 11754

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
11755
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11756
        virDispatchError(NULL);
11757
        return -1;
11758 11759 11760 11761
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11762
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

11775
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11776 11777 11778 11779 11780 11781 11782

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


11783 11784 11785 11786 11787
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
11788
 * storage volume continues to exist.
11789
 *
11790
 * Returns 0 on success, or -1 on error
11791 11792 11793 11794
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
11795
    VIR_DEBUG("vol=%p", vol);
11796

11797 11798
    virResetLastError();

11799
    if (!VIR_IS_STORAGE_VOL(vol)) {
11800
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11801
        virDispatchError(NULL);
11802
        return -1;
11803
    }
11804 11805
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
11806
        return -1;
11807
    }
11808
    return 0;
11809 11810 11811
}


11812 11813
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
11814
 * @vol: the vol to hold a reference on
11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825
 *
 * 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 已提交
11826 11827
 *
 * Returns 0 in case of success, -1 in case of failure.
11828 11829 11830 11831 11832
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
11833
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11834
        virDispatchError(NULL);
11835
        return -1;
11836 11837
    }
    virMutexLock(&vol->conn->lock);
11838
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
11839 11840 11841 11842 11843
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

11844 11845 11846 11847 11848 11849 11850 11851
/**
 * 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
 *
11852
 * Returns 0 on success, or -1 on failure
11853 11854 11855 11856 11857 11858
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
11859
    VIR_DEBUG("vol=%p, info=%p", vol, info);
11860

11861 11862
    virResetLastError();

11863
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
11864
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11865
        virDispatchError(NULL);
11866
        return -1;
11867 11868
    }
    if (info == NULL) {
11869
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11870
        goto error;
11871 11872 11873 11874 11875 11876
    }

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

    conn = vol->conn;

11877 11878 11879 11880 11881 11882 11883
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
11884

11885
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11886 11887

error:
11888
    virDispatchError(vol->conn);
11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900
    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
 *
11901
 * Returns the XML document, or NULL on error
11902 11903 11904 11905 11906 11907
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
11908
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
11909

11910 11911
    virResetLastError();

11912
    if (!VIR_IS_STORAGE_VOL(vol)) {
11913
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11914
        virDispatchError(NULL);
11915
        return NULL;
11916 11917 11918 11919
    }

    conn = vol->conn;

11920 11921 11922 11923 11924 11925 11926
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
11927

11928
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11929

11930
error:
11931
    virDispatchError(vol->conn);
11932
    return NULL;
11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945
}


/**
 * 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
 *
11946 11947
 * Returns the storage volume path, or NULL on error. The
 * caller must free() the returned path after use.
11948 11949 11950 11951 11952
 */
char *
virStorageVolGetPath(virStorageVolPtr vol)
{
    virConnectPtr conn;
11953
    VIR_DEBUG("vol=%p", vol);
11954

11955 11956
    virResetLastError();

11957
    if (!VIR_IS_STORAGE_VOL(vol)) {
11958
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11959
        virDispatchError(NULL);
11960
        return NULL;
11961 11962 11963 11964
    }

    conn = vol->conn;

11965 11966 11967 11968 11969 11970 11971
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
11972

11973
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11974 11975

error:
11976
    virDispatchError(vol->conn);
11977 11978
    return NULL;
}
11979 11980


11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996
/**
 * 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)
{
11997
    VIR_DEBUG("conn=%p, cap=%s, flags=%x", conn, NULLSTR(cap), flags);
11998

11999 12000
    virResetLastError();

12001
    if (!VIR_IS_CONNECT(conn)) {
12002
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12003
        virDispatchError(NULL);
12004
        return -1;
12005 12006
    }

12007 12008 12009 12010 12011 12012 12013
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12014

12015
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12016 12017

error:
12018
    virDispatchError(conn);
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
    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)
{
12044
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%x",
12045 12046
          conn, cap, names, maxnames, flags);

12047 12048
    virResetLastError();

12049
    if (!VIR_IS_CONNECT(conn)) {
12050
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12051
        virDispatchError(NULL);
12052
        return -1;
12053
    }
12054
    if ((names == NULL) || (maxnames < 0)) {
12055
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12056
        goto error;
12057 12058
    }

12059 12060 12061 12062 12063 12064 12065
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12066

12067
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12068 12069

error:
12070
    virDispatchError(conn);
12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085
    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)
{
12086
    VIR_DEBUG("conn=%p, name=%p", conn, name);
12087

12088 12089
    virResetLastError();

12090
    if (!VIR_IS_CONNECT(conn)) {
12091
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12092
        virDispatchError(NULL);
12093 12094 12095 12096
        return NULL;
    }

    if (name == NULL) {
12097
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12098
        goto error;
12099 12100
    }

12101 12102 12103 12104 12105 12106 12107
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
12108

12109
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12110 12111

error:
12112
    virDispatchError(conn);
12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124
    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.
 *
12125
 * Returns the XML document, or NULL on error
12126 12127 12128
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
E
Eric Blake 已提交
12129
    VIR_DEBUG("dev=%p, conn=%p, flags=%x", dev, dev ? dev->conn : NULL, flags);
12130

12131 12132
    virResetLastError();

12133
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12134
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12135
        virDispatchError(NULL);
12136 12137 12138
        return NULL;
    }

12139
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetXMLDesc) {
12140
        char *ret;
12141
        ret = dev->conn->deviceMonitor->deviceGetXMLDesc(dev, flags);
12142 12143 12144 12145
        if (!ret)
            goto error;
        return ret;
    }
12146

12147
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12148 12149

error:
12150
    virDispatchError(dev->conn);
12151 12152 12153 12154 12155 12156 12157 12158
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12159 12160 12161
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
12162 12163 12164
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
12165
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12166 12167

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12168
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12169
        virDispatchError(NULL);
12170 12171 12172 12173 12174 12175 12176 12177 12178 12179
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12180 12181
 * Accessor for the parent of the device
 *
12182 12183 12184 12185 12186
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
12187
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12188

12189 12190
    virResetLastError();

12191
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12192
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12193
        virDispatchError(NULL);
12194 12195 12196
        return NULL;
    }

12197 12198 12199 12200
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
12201
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12202
            virDispatchError(dev->conn);
12203 12204 12205 12206
            return NULL;
        }
    }
    return dev->parent;
12207 12208 12209 12210 12211 12212
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12213 12214
 * Accessor for the number of capabilities supported by the device.
 *
12215 12216 12217 12218
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
12219
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12220

12221 12222
    virResetLastError();

12223
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12224
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12225
        virDispatchError(NULL);
12226 12227 12228
        return -1;
    }

12229 12230 12231 12232 12233 12234 12235
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
12236

12237
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12238 12239

error:
12240
    virDispatchError(dev->conn);
12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257
    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)
{
12258
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
12259 12260
          dev, dev ? dev->conn : NULL, names, maxnames);

12261 12262
    virResetLastError();

12263
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12264
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12265
        virDispatchError(NULL);
12266 12267 12268
        return -1;
    }

12269 12270 12271 12272 12273
    if (names == NULL || maxnames < 0) {
        virLibNodeDeviceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

12274 12275 12276 12277 12278 12279 12280
    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;
    }
12281

12282
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12283 12284

error:
12285
    virDispatchError(dev->conn);
12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300
    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)
{
12301
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12302

12303 12304
    virResetLastError();

12305
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12306
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12307
        virDispatchError(NULL);
12308
        return -1;
12309
    }
12310 12311
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
12312
        return -1;
12313
    }
12314
    return 0;
12315 12316 12317
}


12318 12319
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
12320
 * @dev: the dev to hold a reference on
12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331
 *
 * 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 已提交
12332 12333
 *
 * Returns 0 in case of success, -1 in case of failure.
12334 12335 12336 12337 12338
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
12339
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12340
        virDispatchError(NULL);
12341
        return -1;
12342 12343
    }
    virMutexLock(&dev->conn->lock);
12344
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
12345 12346 12347 12348 12349
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

12350
/**
D
Daniel Veillard 已提交
12351
 * virNodeDeviceDettach:
12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365
 * @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 已提交
12366 12367
 *
 * Returns 0 in case of success, -1 in case of failure.
12368 12369 12370 12371
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
12372
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12373 12374 12375 12376

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12377
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12378
        virDispatchError(NULL);
12379
        return -1;
12380 12381
    }

12382 12383 12384 12385 12386
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12387 12388 12389 12390 12391 12392 12393 12394
    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12395
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12396 12397

error:
12398
    virDispatchError(dev->conn);
12399
    return -1;
12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413
}

/**
 * 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 已提交
12414 12415
 *
 * Returns 0 in case of success, -1 in case of failure.
12416 12417 12418 12419
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
12420
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12421 12422 12423 12424

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12425
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12426
        virDispatchError(NULL);
12427
        return -1;
12428 12429
    }

12430 12431 12432 12433 12434
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12435 12436 12437 12438 12439 12440 12441 12442
    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12443
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12444 12445

error:
12446
    virDispatchError(dev->conn);
12447
    return -1;
12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463
}

/**
 * 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 已提交
12464 12465
 *
 * Returns 0 in case of success, -1 in case of failure.
12466 12467 12468 12469
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
12470
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12471 12472 12473 12474

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12475
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12476
        virDispatchError(NULL);
12477
        return -1;
12478 12479
    }

12480 12481 12482 12483 12484
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12485 12486 12487 12488 12489 12490 12491 12492
    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12493
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12494 12495

error:
12496
    virDispatchError(dev->conn);
12497
    return -1;
12498 12499
}

12500

12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516
/**
 * 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)
{
12517
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
12518 12519 12520 12521

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12522
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12523
        virDispatchError(NULL);
12524 12525 12526 12527
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
12528
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12529 12530 12531 12532
        goto error;
    }

    if (xmlDesc == NULL) {
12533
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

12545
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12546 12547

error:
12548
    virDispatchError(conn);
12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564
    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)
{
12565
    VIR_DEBUG("dev=%p", dev);
12566 12567 12568 12569

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12570
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12571
        virDispatchError(NULL);
12572
        return -1;
12573 12574 12575
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
12576
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

12590
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12591 12592

error:
12593
    virDispatchError(dev->conn);
12594 12595 12596 12597
    return -1;
}


12598 12599 12600 12601 12602 12603 12604 12605 12606
/*
 * 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 已提交
12607
 * @freecb: optional function to deallocate opaque when not used anymore
12608
 *
12609 12610 12611 12612 12613 12614
 * 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
12615
 *
12616 12617
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
12618 12619
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
12620 12621 12622
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
12623 12624 12625 12626 12627
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
12628 12629
                              void *opaque,
                              virFreeCallback freecb)
12630
{
12631
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
12632
    virResetLastError();
12633 12634

    if (!VIR_IS_CONNECT(conn)) {
12635
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12636
        virDispatchError(NULL);
12637
        return -1;
12638 12639
    }
    if (cb == NULL) {
12640
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12641
        goto error;
12642 12643
    }

12644 12645 12646 12647 12648 12649 12650 12651
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

12652
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12653
error:
12654
    virDispatchError(conn);
12655 12656 12657 12658 12659 12660 12661 12662
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
12663 12664 12665 12666 12667 12668
 * 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
12669 12670 12671 12672 12673 12674 12675
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
12676
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
12677 12678

    virResetLastError();
12679 12680

    if (!VIR_IS_CONNECT(conn)) {
12681
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12682
        virDispatchError(NULL);
12683
        return -1;
12684 12685
    }
    if (cb == NULL) {
12686
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12687 12688 12689 12690 12691 12692 12693 12694
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
12695 12696
    }

12697
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12698
error:
12699
    virDispatchError(conn);
12700 12701
    return -1;
}
12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717

/**
 * 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)
{
12718
    VIR_DEBUG("secret=%p", secret);
12719 12720 12721 12722

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
12723
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
12724
        virDispatchError(NULL);
12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745
        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)) {
12746
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12747
        virDispatchError(NULL);
12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

12761
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12762 12763

error:
12764
    virDispatchError(conn);
12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785
    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)) {
12786
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12787
        virDispatchError(NULL);
12788 12789 12790
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
12791
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803
        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;
    }

12804
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12805 12806

error:
12807
    virDispatchError(conn);
12808 12809 12810 12811
    return -1;
}

/**
12812 12813 12814
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
12815
 *
12816 12817
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
12818
 *
12819 12820
 * 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.
12821 12822
 */
virSecretPtr
12823
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
12824
{
12825
    VIR_UUID_DEBUG(conn, uuid);
12826 12827 12828 12829

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12830
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12831
        virDispatchError(NULL);
12832
        return NULL;
12833 12834
    }
    if (uuid == NULL) {
12835
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12836 12837 12838
        goto error;
    }

12839 12840
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
12841
        virSecretPtr ret;
12842 12843
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
12844 12845 12846 12847
            goto error;
        return ret;
    }

12848
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12849 12850

error:
12851
    virDispatchError(conn);
12852 12853 12854
    return NULL;
}

12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869
/**
 * 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];
12870
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
12871 12872 12873 12874

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12875
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12876
        virDispatchError(NULL);
12877
        return NULL;
12878 12879
    }
    if (uuidstr == NULL) {
12880
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12881 12882
        goto error;
    }
12883 12884

    if (virUUIDParse(uuidstr, uuid) < 0) {
12885
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12886 12887 12888 12889 12890 12891
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
12892
    virDispatchError(conn);
12893 12894 12895 12896
    return NULL;
}


12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914
/**
 * 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)
{
12915
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
12916 12917 12918 12919

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12920
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12921
        virDispatchError(NULL);
12922
        return NULL;
12923 12924
    }
    if (usageID == NULL) {
12925
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

12938
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12939 12940

error:
12941
    virDispatchError(conn);
12942 12943 12944 12945
    return NULL;
}


12946 12947 12948 12949 12950 12951
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
12952
 * If XML specifies a UUID, locates the specified secret and replaces all
12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963
 * 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)
{
12964
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
12965 12966 12967 12968

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12969
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12970
        virDispatchError(NULL);
12971 12972 12973
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
12974
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12975 12976 12977
        goto error;
    }
    if (xml == NULL) {
12978
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990
        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;
    }

12991
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12992 12993

error:
12994
    virDispatchError(conn);
12995 12996 12997 12998
    return NULL;
}

/**
12999
 * virSecretGetUUID:
13000
 * @secret: A virSecret secret
13001
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
13002 13003 13004
 *
 * Fetches the UUID of the secret.
 *
13005 13006
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
13007
 */
13008 13009
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
13010 13011 13012 13013 13014 13015
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13016
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13017
        virDispatchError(NULL);
13018 13019 13020
        return -1;
    }
    if (uuid == NULL) {
13021
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13022
        virDispatchError(secret->conn);
13023
        return -1;
13024 13025
    }

13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044
    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];
13045
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
13046 13047

    virResetLastError();
13048

13049
    if (!VIR_IS_SECRET(secret)) {
13050
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13051
        virDispatchError(NULL);
13052
        return -1;
13053 13054
    }
    if (buf == NULL) {
13055
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13056 13057 13058 13059 13060 13061 13062
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
13063
    return 0;
13064 13065

error:
13066
    virDispatchError(secret->conn);
13067
    return -1;
13068 13069
}

13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085
/**
 * 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)
{
13086
    VIR_DEBUG("secret=%p", secret);
13087 13088 13089 13090

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
13091
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13092
        virDispatchError(NULL);
13093
        return -1;
13094
    }
13095
    return secret->usageType;
13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116
}

/**
 * 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)
{
13117
    VIR_DEBUG("secret=%p", secret);
13118 13119 13120 13121

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
13122
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13123
        virDispatchError(NULL);
13124
        return NULL;
13125
    }
13126
    return secret->usageID;
13127 13128
}

13129

13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144
/**
 * 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;

13145
    VIR_DEBUG("secret=%p, flags=%x", secret, flags);
13146 13147 13148 13149

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13150
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13151
        virDispatchError(NULL);
13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164
        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;
    }

13165
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13166 13167

error:
13168
    virDispatchError(conn);
13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188
    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;

13189
    VIR_DEBUG("secret=%p, value=%p, value_size=%zu, flags=%x", secret, value,
13190 13191 13192 13193 13194
              value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13195
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13196
        virDispatchError(NULL);
13197 13198 13199 13200
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13201
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13202 13203 13204
        goto error;
    }
    if (value == NULL) {
13205
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217
        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;
    }

13218
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13219 13220

error:
13221
    virDispatchError(conn);
13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240
    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;

13241
    VIR_DEBUG("secret=%p, value_size=%p, flags=%x", secret, value_size, flags);
13242 13243 13244 13245

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13246
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13247
        virDispatchError(NULL);
13248 13249 13250 13251
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13252
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13253 13254 13255
        goto error;
    }
    if (value_size == NULL) {
13256
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13257 13258 13259 13260 13261 13262
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->getValue != NULL) {
        unsigned char *ret;

13263
        ret = conn->secretDriver->getValue(secret, value_size, flags, 0);
13264 13265 13266 13267 13268
        if (ret == NULL)
            goto error;
        return ret;
    }

13269
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13270 13271

error:
13272
    virDispatchError(conn);
13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294
    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)) {
13295
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13296
        virDispatchError(NULL);
13297 13298 13299 13300
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13301
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

13314
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13315 13316

error:
13317
    virDispatchError(conn);
13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340
    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)) {
13341
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13342
        virDispatchError(NULL);
13343 13344 13345
        return -1;
    }
    virMutexLock(&secret->conn->lock);
13346
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
13358
 * Returns 0 on success, or -1 on error
13359 13360 13361 13362
 */
int
virSecretFree(virSecretPtr secret)
{
13363
    VIR_DEBUG("secret=%p", secret);
13364 13365 13366 13367

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13368
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13369
        virDispatchError(NULL);
13370 13371
        return -1;
    }
13372 13373
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
13374
        return -1;
13375
    }
13376 13377
    return 0;
}
13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404


/**
 * 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;

13405
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
13406 13407 13408 13409

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13410
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13411
        virDispatchError(NULL);
13412
        return NULL;
13413 13414 13415 13416 13417
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;
13418 13419
    else
        virDispatchError(conn);
13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439

    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))) {
13440
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13441
        virDispatchError(NULL);
13442
        return -1;
13443 13444
    }
    virMutexLock(&stream->conn->lock);
13445
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460
    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
13461
 * it should call virStreamFinish to wait for successful
13462
 * confirmation from the driver, or detect any error.
13463 13464
 *
 * This method may not be used if a stream source has been
13465
 * registered.
13466 13467 13468 13469 13470
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
13471
 * An example using this with a hypothetical file upload
13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519
 * 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)
{
13520
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
13521 13522 13523 13524

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13525
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13526
        virDispatchError(NULL);
13527
        return -1;
13528 13529
    }

13530 13531 13532 13533 13534
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545
    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;
    }

13546
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13547 13548

error:
13549
    virDispatchError(stream->conn);
13550 13551 13552 13553 13554 13555 13556
    return -1;
}


/**
 * virStreamRecv:
 * @stream: pointer to the stream object
13557
 * @data: buffer to read into from stream
13558 13559
 * @nbytes: size of @data buffer
 *
13560
 * Reads a series of bytes from the stream. This method may
13561 13562 13563 13564 13565 13566 13567
 * 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 已提交
13568
 * An example using this with a hypothetical file download
13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619
 * 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)
{
13620
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
13621 13622 13623 13624

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13625
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13626
        virDispatchError(NULL);
13627
        return -1;
13628 13629
    }

13630 13631 13632 13633 13634
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645
    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;
    }

13646
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13647 13648

error:
13649
    virDispatchError(stream->conn);
13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663
    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 已提交
13664
 * An example using this with a hypothetical file upload
13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685
 * 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);
 *
13686
 * Returns 0 if all the data was successfully sent. The caller
13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700
 * 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;
13701
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
13702 13703 13704 13705

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13706
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13707
        virDispatchError(NULL);
13708
        return -1;
13709 13710
    }

13711 13712 13713 13714 13715
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

13716
    if (stream->flags & VIR_STREAM_NONBLOCK) {
13717
        virLibConnError(VIR_ERR_OPERATION_INVALID,
13718 13719 13720 13721 13722
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
13723
        virReportOOMError();
13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749
        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)
13750
        virDispatchError(stream->conn);
13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765

    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 已提交
13766
 * An example using this with a hypothetical file download
13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787
 * 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);
 *
13788
 * Returns 0 if all the data was successfully received. The caller
13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802
 * 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;
13803
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
13804 13805 13806 13807

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13808
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13809
        virDispatchError(NULL);
13810
        return -1;
13811 13812
    }

13813 13814 13815 13816 13817
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

13818
    if (stream->flags & VIR_STREAM_NONBLOCK) {
13819
        virLibConnError(VIR_ERR_OPERATION_INVALID,
13820 13821 13822 13823 13824 13825
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
13826
        virReportOOMError();
13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852
        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)
13853
        virDispatchError(stream->conn);
13854 13855 13856 13857 13858 13859

    return ret;
}


/**
M
Matthias Bolte 已提交
13860
 * virStreamEventAddCallback:
13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879
 * @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)
{
13880
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
13881 13882 13883 13884

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13885
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13886
        virDispatchError(NULL);
13887
        return -1;
13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

13899
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13900 13901

error:
13902
    virDispatchError(stream->conn);
13903 13904 13905 13906 13907
    return -1;
}


/**
M
Matthias Bolte 已提交
13908
 * virStreamEventUpdateCallback:
13909 13910 13911 13912 13913 13914
 * @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
E
Eric Blake 已提交
13915
 * is guaranteed to succeed if a callback is already registered
13916 13917 13918 13919 13920 13921
 *
 * Returns 0 on success, -1 if no callback is registered
 */
int virStreamEventUpdateCallback(virStreamPtr stream,
                                 int events)
{
13922
    VIR_DEBUG("stream=%p, events=%d", stream, events);
13923 13924 13925 13926

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13927
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13928
        virDispatchError(NULL);
13929
        return -1;
13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

13941
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13942 13943

error:
13944
    virDispatchError(stream->conn);
13945 13946 13947 13948
    return -1;
}

/**
M
Matthias Bolte 已提交
13949
 * virStreamEventRemoveCallback:
13950 13951
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
13952
 * Remove an event callback from the stream
13953 13954 13955 13956 13957
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
13958
    VIR_DEBUG("stream=%p", stream);
13959 13960 13961 13962

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13963
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13964
        virDispatchError(NULL);
13965
        return -1;
13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

13977
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13978 13979

error:
13980
    virDispatchError(stream->conn);
13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000
    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)
{
14001
    VIR_DEBUG("stream=%p", stream);
14002 14003 14004 14005

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14006
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14007
        virDispatchError(NULL);
14008
        return -1;
14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14020
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14021 14022

error:
14023
    virDispatchError(stream->conn);
14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041
    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)
{
14042
    VIR_DEBUG("stream=%p", stream);
14043 14044 14045 14046

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14047
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14048
        virDispatchError(NULL);
14049
        return -1;
14050 14051
    }

14052 14053 14054 14055 14056 14057
    if (!stream->driver) {
        VIR_DEBUG("aborting unused stream");
        return 0;
    }

    if (stream->driver->streamAbort) {
14058 14059 14060 14061 14062 14063 14064
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14065
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14066 14067

error:
14068
    virDispatchError(stream->conn);
14069 14070 14071 14072 14073 14074 14075 14076 14077 14078
    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 已提交
14079
 * There must not be an active data transfer in progress
14080 14081 14082 14083 14084 14085 14086 14087
 * 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)
{
14088
    VIR_DEBUG("stream=%p", stream);
14089 14090 14091 14092

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14093
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14094
        virDispatchError(NULL);
14095
        return -1;
14096 14097 14098 14099
    }

    /* XXX Enforce shutdown before free'ing resources ? */

14100 14101
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
14102
        return -1;
14103
    }
14104
    return 0;
14105
}
14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117


/**
 * 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)
{
14118
    VIR_DEBUG("dom=%p", dom);
14119 14120 14121 14122

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14123
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14124
        virDispatchError(NULL);
14125
        return -1;
14126 14127 14128 14129 14130 14131 14132 14133 14134
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14135
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14136
error:
14137
    virDispatchError(dom->conn);
14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151
    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)
{
14152
    VIR_DOMAIN_DEBUG(dom);
14153 14154 14155 14156

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14157
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14158
        virDispatchError(NULL);
14159
        return -1;
14160 14161 14162 14163 14164 14165 14166 14167 14168
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14169
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14170
error:
14171
    virDispatchError(dom->conn);
14172 14173 14174
    return -1;
}

14175 14176 14177 14178 14179 14180 14181 14182 14183 14184
/**
 * 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)
{
14185
    VIR_DOMAIN_DEBUG(dom);
14186 14187 14188 14189

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14190
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14191
        virDispatchError(NULL);
14192
        return -1;
14193 14194 14195 14196 14197 14198 14199 14200 14201
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14202
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14203 14204 14205 14206 14207
error:
    virDispatchError(dom->conn);
    return -1;
}

14208 14209 14210 14211 14212 14213 14214 14215 14216 14217
/**
 * 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)
{
14218
    VIR_DEBUG("net=%p", net);
14219 14220 14221 14222

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
14223
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14224
        virDispatchError(NULL);
14225
        return -1;
14226 14227 14228 14229 14230 14231 14232 14233 14234
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

14235
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14236
error:
14237
    virDispatchError(net->conn);
14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252
    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)
{
14253
    VIR_DEBUG("net=%p", net);
14254 14255 14256 14257

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
14258
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14259
        virDispatchError(NULL);
14260
        return -1;
14261 14262 14263 14264 14265 14266 14267 14268 14269
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

14270
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14271
error:
14272
    virDispatchError(net->conn);
14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286
    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)
{
14287
    VIR_DEBUG("pool=%p", pool);
14288 14289 14290 14291

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
14292
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14293
        virDispatchError(NULL);
14294
        return -1;
14295 14296 14297 14298 14299 14300 14301 14302 14303
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

14304
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14305
error:
14306
    virDispatchError(pool->conn);
14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321
    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)
{
14322
    VIR_DEBUG("pool=%p", pool);
14323 14324 14325 14326

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
14327
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14328
        virDispatchError(NULL);
14329
        return -1;
14330 14331 14332 14333 14334 14335 14336 14337 14338
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

14339
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14340
error:
14341
    virDispatchError(pool->conn);
14342 14343 14344 14345
    return -1;
}


S
Stefan Berger 已提交
14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357

/**
 * 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)
{
14358
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
14359 14360 14361 14362

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14363
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375
        virDispatchError(NULL);
        return -1;
    }

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

14376
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396

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)
{
14397
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
14398 14399 14400 14401

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14402
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14403 14404 14405 14406 14407
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
14408
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419
        goto error;
    }

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

14420
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440

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)
{
14441
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
14442 14443 14444 14445

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14446
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14447
        virDispatchError(NULL);
14448
        return NULL;
S
Stefan Berger 已提交
14449 14450
    }
    if (name == NULL) {
14451
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

14463
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482

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)
{
14483
    VIR_UUID_DEBUG(conn, uuid);
S
Stefan Berger 已提交
14484 14485 14486 14487

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14488
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14489
        virDispatchError(NULL);
14490
        return NULL;
S
Stefan Berger 已提交
14491 14492
    }
    if (uuid == NULL) {
14493
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

14505
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14506 14507 14508 14509 14510 14511 14512

error:
    virDispatchError(conn);
    return NULL;
}

/**
14513
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525
 * @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];
14526
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
S
Stefan Berger 已提交
14527 14528 14529 14530

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14531
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14532
        virDispatchError(NULL);
14533
        return NULL;
S
Stefan Berger 已提交
14534 14535
    }
    if (uuidstr == NULL) {
14536
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14537 14538 14539 14540
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
14541
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563
        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)
{
14564
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
14565 14566 14567 14568

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
14569
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591
        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)
{
14592
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
14593 14594 14595 14596

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
14597
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14598
        virDispatchError(NULL);
14599
        return NULL;
S
Stefan Berger 已提交
14600
    }
14601
    return nwfilter->name;
S
Stefan Berger 已提交
14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615
}

/**
 * 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)
{
14616
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
14617 14618 14619 14620

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
14621
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14622 14623 14624 14625
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
14626
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652
        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];
14653
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
14654 14655 14656 14657

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
14658
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14659 14660 14661 14662
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
14663
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691
        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)
{
14692
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
14693 14694 14695 14696

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14697
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14698
        virDispatchError(NULL);
14699
        return NULL;
S
Stefan Berger 已提交
14700 14701
    }
    if (xmlDesc == NULL) {
14702
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14703 14704 14705
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
14706
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
14707 14708 14709 14710 14711
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
E
Eric Blake 已提交
14712
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc);
S
Stefan Berger 已提交
14713 14714 14715 14716 14717
        if (!ret)
            goto error;
        return ret;
    }

14718
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739

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;
14740
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
14741 14742 14743 14744

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
14745
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14746 14747 14748 14749 14750 14751
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
14752
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

14764
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783

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 *
14784
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
S
Stefan Berger 已提交
14785 14786
{
    virConnectPtr conn;
14787
    VIR_DEBUG("nwfilter=%p, flags=%x", nwfilter, flags);
S
Stefan Berger 已提交
14788 14789 14790 14791

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
14792
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14793
        virDispatchError(NULL);
14794
        return NULL;
S
Stefan Berger 已提交
14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806
    }

    conn = nwfilter->conn;

    if (conn->nwfilterDriver && conn->nwfilterDriver->getXMLDesc) {
        char *ret;
        ret = conn->nwfilterDriver->getXMLDesc (nwfilter, flags);
        if (!ret)
            goto error;
        return ret;
    }

14807
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835

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))) {
14836
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14837 14838 14839 14840
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
14841
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
14842 14843 14844 14845 14846 14847
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


14848 14849 14850 14851 14852 14853 14854 14855 14856 14857
/**
 * 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)
{
14858
    VIR_DEBUG("iface=%p", iface);
14859 14860 14861 14862

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
14863
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14864
        virDispatchError(NULL);
14865
        return -1;
14866 14867 14868 14869 14870 14871 14872 14873 14874
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

14875
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14876
error:
14877
    virDispatchError(iface->conn);
14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891
    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)
{
14892
    VIR_DEBUG("conn=%p", conn);
14893 14894 14895 14896

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14897
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14898
        virDispatchError(NULL);
14899
        return -1;
14900 14901 14902 14903 14904 14905 14906 14907 14908
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

14909
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14910
error:
14911
    virDispatchError(conn);
14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928
    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)
{
14929
    VIR_DEBUG("conn=%p", conn);
14930 14931 14932 14933

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14934
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14935
        virDispatchError(NULL);
14936
        return -1;
14937 14938 14939 14940 14941 14942 14943 14944 14945
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

14946
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14947
error:
14948
    virDispatchError(conn);
14949 14950
    return -1;
}
J
Jiri Denemark 已提交
14951 14952 14953 14954 14955


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
14956 14957 14958 14959
 * @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 已提交
14960 14961 14962 14963 14964 14965 14966 14967
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
14968
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
14969 14970 14971 14972

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14973
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14974
        virDispatchError(NULL);
J
Jiri Denemark 已提交
14975 14976 14977
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
14978
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990
        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;
    }

14991
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
14992 14993

error:
14994
    virDispatchError(conn);
J
Jiri Denemark 已提交
14995 14996
    return VIR_CPU_COMPARE_ERROR;
}
14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019


/**
 * 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;

15020
    VIR_DEBUG("conn=%p, xmlCPUs=%p, ncpus=%u, flags=%x",
15021 15022 15023 15024 15025 15026 15027 15028 15029
              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)) {
15030
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15031 15032 15033 15034
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
15035
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047
        goto error;
    }

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

15048
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15049 15050 15051 15052 15053

error:
    virDispatchError(conn);
    return NULL;
}
15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069


/**
 * 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;
15070 15071

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
15072 15073 15074 15075

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15076
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15077
        virDispatchError(NULL);
15078
        return -1;
15079 15080
    }
    if (info == NULL) {
15081
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096
        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;
    }

15097
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15098 15099 15100 15101 15102

error:
    virDispatchError(domain->conn);
    return -1;
}
15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119


/**
 * 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;

15120
    VIR_DOMAIN_DEBUG(domain);
15121 15122 15123 15124

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15125
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15126
        virDispatchError(NULL);
15127
        return -1;
15128 15129 15130 15131
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15132
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143
        goto error;
    }

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

15144
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15145 15146 15147 15148 15149

error:
    virDispatchError(conn);
    return -1;
}
15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170


/**
 * 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;

15171
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%x", downtime, flags);
15172 15173 15174 15175

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15176
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15177 15178 15179 15180 15181 15182
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15183
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15184 15185 15186 15187 15188 15189 15190 15191 15192
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

15193
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15194 15195 15196 15197 15198
error:
    virDispatchError(conn);
    return -1;
}

15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217
/**
 * virDomainMigrateSetMaxSpeed:
 * @domain: a domain object
 * @bandwidth: migration bandwidth limit in Mbps
 * @flags: fine-tuning flags, currently unused, use 0
 *
 * The maximum bandwidth (in Mbps) that will be used to do migration
 * can be specified with the bandwidth parameter. Not all hypervisors
 * will support a bandwidth cap
 *
 * Returns 0 in case of success, -1 otherwise.
 */
int
virDomainMigrateSetMaxSpeed(virDomainPtr domain,
                            unsigned long bandwidth,
                            unsigned int flags)
{
    virConnectPtr conn;

15218
    VIR_DOMAIN_DEBUG(domain, "bandwidth=%lu, flags=%x", bandwidth, flags);
15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239

    virResetLastError();

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

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

    if (conn->driver->domainMigrateSetMaxSpeed) {
        if (conn->driver->domainMigrateSetMaxSpeed(domain, bandwidth, flags) < 0)
            goto error;
        return 0;
    }

15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainMigrateGetMaxSpeed:
 * @domain: a domain object
 * @bandwidth: return value of current migration bandwidth limit in Mbps
 * @flags: fine-tuning flags, currently unused, use 0
 *
 * Get the current maximum bandwidth (in Mbps) that will be used if the
 * domain is migrated.  Not all hypervisors will support a bandwidth limit.
 *
 * Returns 0 in case of success, -1 otherwise.
 */
int
virDomainMigrateGetMaxSpeed(virDomainPtr domain,
                            unsigned long *bandwidth,
                            unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "bandwidth = %p, flags=%x", bandwidth, flags);

    virResetLastError();

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

15274 15275
    conn = domain->conn;

15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291
    if (!bandwidth) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

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

    if (conn->driver->domainMigrateGetMaxSpeed) {
        if (conn->driver->domainMigrateGetMaxSpeed(domain, bandwidth, flags) < 0)
            goto error;
        return 0;
    }

15292 15293 15294 15295 15296 15297
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319
/**
 * 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.
15320 15321
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338
 * 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)
{
15339 15340 15341
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

15342 15343 15344
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15345
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15346
        virDispatchError(NULL);
15347
        return -1;
15348 15349 15350
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
15351
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15352
        virDispatchError(conn);
15353
        return -1;
15354 15355
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
15356
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367
        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;
    }

15368
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15369 15370 15371 15372
error:
    virDispatchError(conn);
    return -1;
}
15373

15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387
/**
 * 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)
{
15388
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
15389 15390 15391 15392

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15393
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15394
        virDispatchError(NULL);
15395
        return -1;
15396 15397
    }
    if (callbackID < 0) {
15398
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15399 15400 15401 15402 15403 15404 15405 15406 15407 15408
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

15409
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15410 15411 15412 15413
error:
    virDispatchError(conn);
    return -1;
}
15414 15415 15416 15417

/**
 * virDomainManagedSave:
 * @dom: pointer to the domain
15418
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
15419 15420 15421 15422 15423 15424 15425 15426
 *
 * 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.
15427 15428 15429
 * This also implies that managed save only works on persistent domains,
 * since the domain must still exist in order to use virDomainCreate() to
 * restart it.
15430
 *
15431 15432 15433 15434 15435
 * If @flags includes VIR_DOMAIN_SAVE_BYPASS_CACHE, then libvirt will
 * attempt to bypass the file system cache while creating the file, or
 * fail if it cannot do so for the given system; this can allow less
 * pressure on file system cache, but also risks slowing saves to NFS.
 *
15436 15437 15438 15439 15440 15441
 * Normally, the managed saved state will remember whether the domain
 * was running or paused, and start will resume to the same state.
 * Specifying VIR_DOMAIN_SAVE_RUNNING or VIR_DOMAIN_SAVE_PAUSED in
 * @flags will override the default saved into the file.  These two
 * flags are mutually exclusive.
 *
15442 15443 15444 15445 15446 15447
 * Returns 0 in case of success or -1 in case of failure
 */
int virDomainManagedSave(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

15448
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
15449 15450 15451 15452

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
15453
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15454 15455 15456 15457 15458 15459
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15460
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15461 15462 15463
        goto error;
    }

15464 15465 15466 15467 15468 15469
    if ((flags & VIR_DOMAIN_SAVE_RUNNING) && (flags & VIR_DOMAIN_SAVE_PAUSED)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("running and paused flags are mutually exclusive"));
        goto error;
    }

15470 15471 15472 15473 15474 15475 15476 15477 15478
    if (conn->driver->domainManagedSave) {
        int ret;

        ret = conn->driver->domainManagedSave(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

15479
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501

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;

15502
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
15503 15504 15505 15506

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
15507
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522
        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;
    }

15523
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
15535
 * Remove any managed save image for this domain.
15536 15537 15538 15539 15540 15541 15542
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

15543
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
15544 15545 15546 15547

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
15548
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15549 15550 15551 15552 15553 15554
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15555
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567
        goto error;
    }

    if (conn->driver->domainManagedSaveRemove) {
        int ret;

        ret = conn->driver->domainManagedSaveRemove(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

15568
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15569 15570 15571 15572 15573

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
15574 15575 15576 15577 15578

/**
 * virDomainSnapshotCreateXML:
 * @domain: a domain object
 * @xmlDesc: string containing an XML description of the domain
15579
 * @flags: bitwise-OR of virDomainSnapshotCreateFlags
C
Chris Lalancette 已提交
15580 15581 15582 15583
 *
 * Creates a new snapshot of a domain based on the snapshot xml
 * contained in xmlDesc.
 *
15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618
 * If @flags is 0, the domain can be active, in which case the
 * snapshot will be a system checkpoint (both disk state and runtime
 * VM state such as RAM contents), where reverting to the snapshot is
 * the same as resuming from hibernation (TCP connections may have
 * timed out, but everything else picks up where it left off); or
 * the domain can be inactive, in which case the snapshot includes
 * just the disk state prior to booting.  The newly created snapshot
 * becomes current (see virDomainSnapshotCurrent()), and is a child
 * of any previous current snapshot.
 *
 * If @flags includes VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE, then this
 * is a request to reinstate snapshot metadata that was previously
 * discarded, rather than creating a new snapshot.  This can be used
 * to recreate a snapshot hierarchy on a destination, then remove it
 * on the source, in order to allow migration (since migration
 * normally fails if snapshot metadata still remains on the source
 * machine).  When redefining snapshot metadata, the current snapshot
 * will not be altered unless the VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT
 * flag is also present.  It is an error to request the
 * VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT flag without
 * VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE.  On some hypervisors,
 * redefining an existing snapshot can be used to alter host-specific
 * portions of the domain XML to be used during revert (such as
 * backing filenames associated with disk devices), but must not alter
 * guest-visible layout.  When redefining a snapshot name that does
 * not exist, the hypervisor may validate that reverting to the
 * snapshot appears to be possible (for example, disk images have
 * snapshot contents by the requested name).  Not all hypervisors
 * support these flags.
 *
 * If @flags includes VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA, then the
 * domain's disk images are modified according to @xmlDesc, but then
 * the just-created snapshot has its metadata deleted.  This flag is
 * incompatible with VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE.
 *
C
Chris Lalancette 已提交
15619 15620 15621 15622 15623 15624 15625 15626 15627
 * Returns an (opaque) virDomainSnapshotPtr on success, NULL on failure.
 */
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
                           const char *xmlDesc,
                           unsigned int flags)
{
    virConnectPtr conn;

15628
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%x", xmlDesc, flags);
C
Chris Lalancette 已提交
15629 15630 15631 15632

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15633
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15634 15635 15636 15637 15638
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
15639 15640 15641 15642 15643 15644

    if (xmlDesc == NULL) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

C
Chris Lalancette 已提交
15645
    if (conn->flags & VIR_CONNECT_RO) {
15646
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
15647 15648 15649
        goto error;
    }

15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662
    if ((flags & VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT) &&
        !(flags & VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("use of current flag requires redefine flag"));
        goto error;
    }
    if ((flags & VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE) &&
        (flags & VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                   _("redefine and no metadata flags are mutually exclusive"));
        goto error;
    }

C
Chris Lalancette 已提交
15663 15664 15665 15666 15667 15668 15669 15670
    if (conn->driver->domainSnapshotCreateXML) {
        virDomainSnapshotPtr ret;
        ret = conn->driver->domainSnapshotCreateXML(domain, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }

15671
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691
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;
15692
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
15693 15694 15695 15696

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
15697
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
15698 15699
                                  __FUNCTION__);
        virDispatchError(NULL);
15700
        return NULL;
C
Chris Lalancette 已提交
15701 15702 15703 15704 15705
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
15706
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
15707 15708 15709 15710
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

15711
    if (conn->driver->domainSnapshotGetXMLDesc) {
C
Chris Lalancette 已提交
15712
        char *ret;
15713
        ret = conn->driver->domainSnapshotGetXMLDesc(snapshot, flags);
C
Chris Lalancette 已提交
15714 15715 15716 15717 15718
        if (!ret)
            goto error;
        return ret;
    }

15719
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15720 15721 15722 15723 15724 15725 15726 15727
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotNum:
 * @domain: a domain object
15728 15729 15730
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
 *
 * Provides the number of domain snapshots for this domain.
C
Chris Lalancette 已提交
15731
 *
15732 15733
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_ROOTS, then the result is
 * filtered to the number of snapshots that have no parents.
C
Chris Lalancette 已提交
15734
 *
15735 15736 15737 15738 15739 15740
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_METADATA, then the result is
 * the number of snapshots that also include metadata that would prevent
 * the removal of the last reference to a domain; this value will either
 * be 0 or the same value as if the flag were not given.
 *
 * Returns the number of domain snapshots found or -1 in case of error.
C
Chris Lalancette 已提交
15741 15742 15743 15744 15745
 */
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
15746

E
Eric Blake 已提交
15747
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
15748 15749 15750 15751

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15752
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764
        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;
    }

15765
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15766 15767 15768 15769 15770 15771 15772 15773 15774 15775
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotListNames:
 * @domain: a domain object
 * @names: array to collect the list of names of snapshots
 * @nameslen: size of @names
15776
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
C
Chris Lalancette 已提交
15777 15778 15779
 *
 * Collect the list of domain snapshots for the given domain, and store
 * their names in @names.  Caller is responsible for freeing each member
15780 15781 15782 15783 15784 15785 15786 15787 15788 15789
 * of the array.  The value to use for @nameslen can be determined by
 * virDomainSnapshotNum() with the same @flags.
 *
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_ROOTS, then the result is
 * filtered to the number of snapshots that have no parents.
 *
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_METADATA, then the result is
 * the number of snapshots that also include metadata that would prevent
 * the removal of the last reference to a domain; this value will either
 * be 0 or the same value as if the flag were not given.
C
Chris Lalancette 已提交
15790 15791 15792 15793 15794 15795 15796 15797 15798
 *
 * 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;

15799
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%x",
15800
                     names, nameslen, flags);
C
Chris Lalancette 已提交
15801 15802 15803 15804

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15805
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15806 15807 15808 15809 15810 15811 15812
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
15813
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824
        goto error;
    }

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

15825
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848
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;
15849

15850
    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%x", name, flags);
C
Chris Lalancette 已提交
15851 15852 15853 15854

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15855
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15856
        virDispatchError(NULL);
15857
        return NULL;
C
Chris Lalancette 已提交
15858 15859 15860 15861 15862
    }

    conn = domain->conn;

    if (name == NULL) {
15863
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874
        goto error;
    }

    if (conn->driver->domainSnapshotLookupByName) {
        virDomainSnapshotPtr dom;
        dom = conn->driver->domainSnapshotLookupByName(domain, name, flags);
        if (!dom)
            goto error;
        return dom;
    }

15875
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893
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;
15894

15895
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
15896 15897 15898 15899

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15900
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913
        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;
    }

15914
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935
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;
15936

15937
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
15938 15939 15940 15941

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15942
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15943
        virDispatchError(NULL);
15944
        return NULL;
C
Chris Lalancette 已提交
15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

15957
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
15958 15959 15960 15961 15962 15963
error:
    virDispatchError(conn);
    return NULL;
}

/**
15964
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
15965
 * @snapshot: a domain snapshot object
15966
 * @flags: bitwise-OR of virDomainSnapshotRevertFlags
C
Chris Lalancette 已提交
15967 15968 15969
 *
 * Revert the domain to a given snapshot.
 *
15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981
 * Normally, the domain will revert to the same state the domain was
 * in while the snapshot was taken (whether inactive, running, or
 * paused), except that disk snapshots default to reverting to
 * inactive state.  Including VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING in
 * @flags overrides the snapshot state to guarantee a running domain
 * after the revert; or including VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED in
 * @flags guarantees a paused domain after the revert.  These two
 * flags are mutually exclusive.  While a persistent domain does not
 * need either flag, it is not possible to revert a transient domain
 * into an inactive state, so transient domains require the use of one
 * of these two flags.
 *
C
Chris Lalancette 已提交
15982 15983 15984 15985 15986 15987 15988 15989
 * Returns 0 if the creation is successful, -1 on error.
 */
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
                          unsigned int flags)
{
    virConnectPtr conn;

15990
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
15991 15992 15993 15994

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
15995
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
15996 15997 15998 15999 16000 16001
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
16002 16003 16004 16005
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
16006

16007 16008 16009 16010 16011 16012 16013
    if ((flags & VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING) &&
        (flags & VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("running and paused flags are mutually exclusive"));
        goto error;
    }

C
Chris Lalancette 已提交
16014 16015 16016 16017 16018 16019 16020
    if (conn->driver->domainRevertToSnapshot) {
        int ret = conn->driver->domainRevertToSnapshot(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16021
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16022 16023 16024 16025 16026 16027
error:
    virDispatchError(conn);
    return -1;
}

/**
16028
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
16029
 * @snapshot: a domain snapshot object
16030
 * @flags: bitwise-or of supported virDomainSnapshotDeleteFlags
C
Chris Lalancette 已提交
16031 16032 16033 16034 16035
 *
 * 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
16036 16037 16038 16039 16040 16041
 * @flags includes VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN, then this snapshot
 * and any children snapshots are deleted.  If @flags includes
 * VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY, then any snapshot metadata
 * tracked by libvirt is removed while keeping the snapshot contents
 * intact; if a hypervisor does not require any libvirt metadata to
 * track snapshots, then this flag is silently ignored.
C
Chris Lalancette 已提交
16042 16043 16044 16045 16046 16047 16048 16049 16050
 *
 * Returns 0 if the snapshot was successfully deleted, -1 on error.
 */
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
                        unsigned int flags)
{
    virConnectPtr conn;

16051
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16052 16053 16054 16055

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16056
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16057 16058 16059 16060 16061 16062
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
16063 16064 16065 16066
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
16067 16068 16069 16070 16071 16072 16073 16074

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

16075
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092
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)
{
16093
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
16094 16095 16096 16097

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16098
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16099 16100 16101 16102 16103 16104 16105 16106 16107 16108
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131

/**
 * 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;
16132

16133
    VIR_DOMAIN_DEBUG(dom, "devname=%s, st=%p, flags=%x",
16134
                     NULLSTR(devname), st, flags);
16135 16136 16137 16138

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
16139
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
16140 16141 16142 16143 16144 16145
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
16146
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
        ret = conn->driver->domainOpenConsole(dom, devname, st, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16158
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
16159 16160 16161 16162 16163

error:
    virDispatchError(conn);
    return -1;
}
16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389

/**
 * virDomainBlockJobAbort:
 * @dom: pointer to domain object
 * @path: fully-qualified filename of disk
 * @flags: currently unused, for future extension
 *
 * Cancel the active block job on the given disk.
 *
 * Returns -1 in case of failure, 0 when successful.
 */
int virDomainBlockJobAbort(virDomainPtr dom, const char *path,
                           unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "path=%p, flags=%x", path, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    conn = dom->conn;

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

    if (!path) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
        goto error;
    }

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

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainGetBlockJobInfo:
 * @dom: pointer to domain object
 * @path: fully-qualified filename of disk
 * @info: pointer to a virDomainBlockJobInfo structure
 * @flags: currently unused, for future extension
 *
 * Request block job information for the given disk.  If an operation is active
 * @info will be updated with the current progress.
 *
 * Returns -1 in case of failure, 0 when nothing found, 1 when info was found.
 */
int virDomainGetBlockJobInfo(virDomainPtr dom, const char *path,
                             virDomainBlockJobInfoPtr info, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "path=%p, info=%p, flags=%x", path, info, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    conn = dom->conn;

    if (!path) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
        goto error;
    }

    if (!info) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("info is NULL"));
        goto error;
    }

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

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainBlockJobSetSpeed:
 * @dom: pointer to domain object
 * @path: fully-qualified filename of disk
 * @bandwidth: specify bandwidth limit in Mbps
 * @flags: currently unused, for future extension
 *
 * Set the maximimum allowable bandwidth that a block job may consume.  If
 * bandwidth is 0, the limit will revert to the hypervisor default.
 *
 * Returns -1 in case of failure, 0 when successful.
 */
int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *path,
                              unsigned long bandwidth, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "path=%p, bandwidth=%lu, flags=%x",
                     path, bandwidth, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    conn = dom->conn;

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

    if (!path) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
        goto error;
    }

    if (conn->driver->domainBlockJobSetSpeed) {
        int ret;
        ret = conn->driver->domainBlockJobSetSpeed(dom, path, bandwidth, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainBlockPull:
 * @dom: pointer to domain object
 * @path: Fully-qualified filename of disk
 * @bandwidth: (optional) specify copy bandwidth limit in Mbps
 * @flags: currently unused, for future extension
 *
 * Populate a disk image with data from its backing image.  Once all data from
 * its backing image has been pulled, the disk no longer depends on a backing
 * image.  This function pulls data for the entire device in the background.
 * Progress of the operation can be checked with virDomainGetBlockJobInfo() and
 * the operation can be aborted with virDomainBlockJobAbort().  When finished,
 * an asynchronous event is raised to indicate the final status.
 *
 * The maximum bandwidth (in Mbps) that will be used to do the copy 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.
 *
 * Returns 0 if the operation has started, -1 on failure.
 */
int virDomainBlockPull(virDomainPtr dom, const char *path,
                       unsigned long bandwidth, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "path=%p, bandwidth=%lu, flags=%x",
                     path, bandwidth, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    conn = dom->conn;

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

    if (!path) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
        goto error;
    }

    if (conn->driver->domainBlockPull) {
        int ret;
        ret = conn->driver->domainBlockPull(dom, path, bandwidth, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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