libvirt.c 478.7 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 "conf.h"
44
#include "rpc/virnettlscontext.h"
E
Eric Blake 已提交
45
#include "command.h"
46

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

80 81
#define VIR_FROM_THIS VIR_FROM_NONE

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

88
#define MAX_DRIVERS 20
89

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

110 111
#if defined(POLKIT_AUTH)
static int virConnectAuthGainPolkit(const char *privilege) {
E
Eric Blake 已提交
112 113 114
    virCommandPtr cmd;
    int status;
    int ret = -1;
115 116 117 118

    if (getuid() == 0)
        return 0;

E
Eric Blake 已提交
119 120 121 122
    cmd = virCommandNewArgList(POLKIT_AUTH, "--obtain", privilege, NULL);
    if (virCommandRun(cmd, &status) < 0 ||
        status > 1)
        goto cleanup;
123

E
Eric Blake 已提交
124 125 126 127
    ret = 0;
cleanup:
    virCommandFree(cmd);
    return ret;
128 129 130
}
#endif

131 132 133 134 135 136 137 138
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;
139
        size_t len;
140 141

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

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

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

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

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

187 188 189 190
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
191 192 193

        default:
            return -1;
194 195
        }

D
Daniel P. Berrange 已提交
196 197 198 199 200 201 202 203 204
        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);
        }
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    }

    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,
220
    VIR_CRED_EXTERNAL,
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
};

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;

242 243 244 245 246 247 248 249 250 251
#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 已提交
252
    return err == 0 ? 0 : -1;
253 254 255
}
#endif

D
Daniel P. Berrange 已提交
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
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 = {
295 296
    /* GCRY_THREAD_OPTION_VERSION was added in gcrypt 1.4.2 */
#ifdef GCRY_THREAD_OPTION_VERSION
D
Daniel P. Berrange 已提交
297
    (GCRY_THREAD_OPTION_PTHREAD | (GCRY_THREAD_OPTION_VERSION << 8)),
298 299 300
#else
    GCRY_THREAD_OPTION_PTHREAD,
#endif
D
Daniel P. Berrange 已提交
301 302 303 304 305 306 307 308
    NULL,
    virTLSMutexInit,
    virTLSMutexDestroy,
    virTLSMutexLock,
    virTLSMutexUnlock,
    NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
};

309
/* Helper macros to implement VIR_DOMAIN_DEBUG using just C99.  This
310
 * assumes you pass fewer than 15 arguments to VIR_DOMAIN_DEBUG, but
311 312 313 314 315 316
 * 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.
 */
317 318
#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)
319 320 321 322 323 324 325 326 327 328 329

/* 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 已提交
330
    VIR_DOMAIN_DEBUG_2(dom, "%s", "")
331 332

/* Internal use only, when VIR_DOMAIN_DEBUG has three or more arguments.  */
E
Eric Blake 已提交
333 334 335 336 337
#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, ...)                               \
338 339 340 341 342 343 344 345 346 347 348
    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 已提交
349
        VIR_DEBUG("dom=%p, (VM: name=%s, uuid=%s)" fmt,                 \
350 351
                  dom, NULLSTR(_domname), _uuidstr, __VA_ARGS__);       \
    } while (0)
352

353 354 355 356 357 358 359 360 361 362
/**
 * 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 已提交
363

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
/**
 * 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)

380 381 382 383 384 385 386
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
387 388 389
 * Calling virInitialize is mandatory, unless your first API call is one of
 * virConnectOpen*.
 *
390 391 392 393 394 395
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
    if (initialized)
396
        return 0;
397

398
    initialized = 1;
399

400
    if (virThreadInitialize() < 0 ||
401 402
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
403 404
        return -1;

D
Daniel P. Berrange 已提交
405 406 407
    gcry_control(GCRYCTL_SET_THREAD_CBS, &virTLSThreadImpl);
    gcry_check_version(NULL);

408
    virLogSetFromEnv();
409

410 411
    virNetTLSInit();

412
    VIR_DEBUG("register drivers");
413

414 415 416 417
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

418
    if (!bindtextdomain(PACKAGE, LOCALEDIR))
419
        return -1;
420

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

491
    return 0;
492 493
}

494 495 496 497 498 499 500 501 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
#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
527

528
#define virLibConnError(code, ...)                                \
529
    virReportErrorHelper(VIR_FROM_NONE, code, __FILE__,           \
530 531
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibDomainError(code, ...)                              \
532
    virReportErrorHelper(VIR_FROM_DOM, code, __FILE__,            \
533 534
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNetworkError(code, ...)                             \
535
    virReportErrorHelper(VIR_FROM_NETWORK, code, __FILE__,        \
536 537
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStoragePoolError(code, ...)                         \
538
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
539 540
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStorageVolError(code, ...)                          \
541
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
542 543
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibInterfaceError(code, ...)                           \
544
    virReportErrorHelper(VIR_FROM_INTERFACE, code, __FILE__,      \
545 546
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNodeDeviceError(code, ...)                          \
547
    virReportErrorHelper(VIR_FROM_NODEDEV, code, __FILE__,        \
548 549
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibSecretError(code, ...)                              \
550
    virReportErrorHelper(VIR_FROM_SECRET, code, __FILE__,         \
551 552
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStreamError(code, ...)                              \
553
    virReportErrorHelper(VIR_FROM_STREAMS, code, __FILE__,        \
554 555
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNWFilterError(code, ...)                            \
556
    virReportErrorHelper(VIR_FROM_NWFILTER, code, __FILE__,       \
557
                         __FUNCTION__, __LINE__, __VA_ARGS__)
558 559
#define virLibDomainSnapshotError(code, ...)                       \
    virReportErrorHelper(VIR_FROM_DOMAIN_SNAPSHOT, code, __FILE__, \
560
                         __FUNCTION__, __LINE__, __VA_ARGS__)
561

C
Chris Lalancette 已提交
562

563 564 565 566 567 568 569 570 571 572 573
/**
 * 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)
{
574 575 576 577
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
578
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
579
        return -1;
580 581 582
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
583 584 585
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
586
        return -1;
587 588
    }

589
    VIR_DEBUG ("registering %s as network driver %d",
590 591
           driver->name, virNetworkDriverTabCount);

592 593
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
594 595
}

D
Daniel Veillard 已提交
596 597
/**
 * virRegisterInterfaceDriver:
L
Laine Stump 已提交
598
 * @driver: pointer to an interface driver block
D
Daniel Veillard 已提交
599
 *
L
Laine Stump 已提交
600
 * Register an interface virtualization driver
D
Daniel Veillard 已提交
601 602 603 604 605 606 607 608 609 610
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterInterfaceDriver(virInterfaceDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
611
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
612
        return -1;
D
Daniel Veillard 已提交
613 614 615
    }

    if (virInterfaceDriverTabCount >= MAX_DRIVERS) {
616 617 618
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
619
        return -1;
D
Daniel Veillard 已提交
620 621
    }

622
    VIR_DEBUG ("registering %s as interface driver %d",
D
Daniel Veillard 已提交
623 624 625 626 627 628
           driver->name, virInterfaceDriverTabCount);

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

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
/**
 * 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) {
644
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
645
        return -1;
646 647 648
    }

    if (virStorageDriverTabCount >= MAX_DRIVERS) {
649 650 651
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
652
        return -1;
653 654
    }

655
    VIR_DEBUG ("registering %s as storage driver %d",
656 657
           driver->name, virStorageDriverTabCount);

658 659 660 661
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
/**
 * 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) {
677
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
678
        return -1;
679 680 681
    }

    if (virDeviceMonitorTabCount >= MAX_DRIVERS) {
682 683 684
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
685
        return -1;
686 687
    }

688
    VIR_DEBUG ("registering %s as device driver %d",
689 690
           driver->name, virDeviceMonitorTabCount);

691 692 693 694
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
/**
 * 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) {
710
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
711
        return -1;
712 713 714
    }

    if (virSecretDriverTabCount >= MAX_DRIVERS) {
715 716 717
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
718
        return -1;
719 720
    }

721
    VIR_DEBUG ("registering %s as secret driver %d",
722 723 724 725 726 727
           driver->name, virSecretDriverTabCount);

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

S
Stefan Berger 已提交
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
/**
 * 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) {
743
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
744 745 746 747
        return -1;
    }

    if (virNWFilterDriverTabCount >= MAX_DRIVERS) {
748 749 750
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
S
Stefan Berger 已提交
751 752 753
        return -1;
    }

754
    VIR_DEBUG ("registering %s as network filter driver %d",
S
Stefan Berger 已提交
755 756 757 758 759 760 761
           driver->name, virNWFilterDriverTabCount);

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


762 763 764 765 766 767 768 769 770 771 772
/**
 * 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)
{
773
    VIR_DEBUG("driver=%p name=%s", driver, driver ? NULLSTR(driver->name) : "(null)");
774

775
    if (virInitialize() < 0)
776
        return -1;
777 778

    if (driver == NULL) {
779
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
780
        return -1;
781 782 783
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
784 785 786
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
787
        return -1;
788 789
    }

790
    if (driver->no < 0) {
791 792
        virLibConnError(VIR_ERR_INVALID_ARG,
                        _("Tried to register an internal Xen driver"));
793 794 795
        return -1;
    }

796
    VIR_DEBUG ("registering %s as driver %d",
797 798
           driver->name, virDriverTabCount);

799 800
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
801 802
}

A
Atsushi SAKAI 已提交
803
#ifdef WITH_LIBVIRTD
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
/**
 * 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) {
819
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
820
        return -1;
821 822 823
    }

    if (virStateDriverTabCount >= MAX_DRIVERS) {
824 825 826
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
827
        return -1;
828 829 830 831 832 833
    }

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

834 835
/**
 * virStateInitialize:
E
Eric Blake 已提交
836
 * @privileged: set to 1 if running with root privilege, 0 otherwise
837 838 839
 *
 * Initialize all virtualization drivers.
 *
840
 * Returns 0 if all succeed, -1 upon any failure.
841
 */
842
int virStateInitialize(int privileged) {
843 844 845 846 847 848
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
849
        if (virStateDriverTab[i]->initialize &&
850
            virStateDriverTab[i]->initialize(privileged) < 0) {
851
            VIR_ERROR(_("Initialization of %s state driver failed"),
852
                      virStateDriverTab[i]->name);
853
            ret = -1;
854
        }
855 856 857 858
    }
    return ret;
}

859 860 861 862 863
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
864
 * Returns 0 if all succeed, -1 upon any failure.
865
 */
D
Daniel P. Berrange 已提交
866
int virStateCleanup(void) {
867 868 869
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
870 871
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
872 873 874 875 876
            ret = -1;
    }
    return ret;
}

877 878 879 880 881
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
882
 * Returns 0 if all succeed, -1 upon any failure.
883
 */
D
Daniel P. Berrange 已提交
884
int virStateReload(void) {
885 886 887
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
888 889
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
890 891 892 893 894
            ret = -1;
    }
    return ret;
}

895 896 897 898 899
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
900
 * Returns 0 if none are active, 1 if at least one is.
901
 */
D
Daniel P. Berrange 已提交
902
int virStateActive(void) {
903 904 905
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
906 907
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
908 909 910 911 912
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
913
#endif
914

915 916


917 918 919
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
920 921 922 923 924 925 926 927 928 929 930 931 932
 * @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.
933 934 935 936 937
 *
 * 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
938
virGetVersion(unsigned long *libVer, const char *type ATTRIBUTE_UNUSED,
939 940
              unsigned long *typeVer)
{
941
    VIR_DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
942

943
    if (!initialized)
944
        if (virInitialize() < 0)
945
            goto error;
946

947
    if (libVer == NULL)
948
        goto error;
949 950
    *libVer = LIBVIR_VERSION_NUMBER;

951
    if (typeVer != NULL)
952 953
        *typeVer = LIBVIR_VERSION_NUMBER;

954
    return 0;
955 956 957 958

error:
    virDispatchError(NULL);
    return -1;
959 960
}

961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
static char *
virConnectConfigFile(void)
{
    char *path;
    if (geteuid() == 0) {
        if (virAsprintf(&path, "%s/libvirt/libvirt.conf",
                        SYSCONFDIR) < 0)
            goto no_memory;
    } else {
        char *userdir = virGetUserDirectory(geteuid());
        if (!userdir)
            goto error;

        if (virAsprintf(&path, "%s/.libvirt/libvirt.conf",
                        userdir) < 0)
            goto no_memory;
    }

    return path;

no_memory:
    virReportOOMError();
error:
    return NULL;
}

#define URI_ALIAS_CHARS "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-"

static int
virConnectOpenFindURIAliasMatch(virConfValuePtr value, const char *alias, char **uri)
{
    virConfValuePtr entry;
    if (value->type != VIR_CONF_LIST) {
        virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("Expected a list for 'uri_aliases' config parameter"));
        return -1;
    }

    entry = value->list;
    while (entry) {
        char *offset;
        size_t safe;

        if (entry->type != VIR_CONF_STRING) {
            virLibConnError(VIR_ERR_CONF_SYNTAX, "%s",
                            _("Expected a string for 'uri_aliases' config parameter list entry"));
            return -1;
        }

        if (!(offset = strchr(entry->str, '='))) {
            virLibConnError(VIR_ERR_CONF_SYNTAX,
                            _("Malformed 'uri_aliases' config entry '%s', expected 'alias=uri://host/path'"),
                            entry->str);
            return -1;
        }

        safe  = strspn(entry->str, URI_ALIAS_CHARS);
        if (safe < (offset - entry->str)) {
            virLibConnError(VIR_ERR_CONF_SYNTAX,
                            _("Malformed 'uri_aliases' config entry '%s', aliases may only container 'a-Z, 0-9, _, -'"),
                            entry->str);
            return -1;
        }

        if (STREQLEN(entry->str, alias, offset-entry->str)) {
            VIR_DEBUG("Resolved alias '%s' to '%s'",
                      alias, offset+1);
            if (!(*uri = strdup(offset+1))) {
                virReportOOMError();
                return -1;
            }
            return 0;
        }

        entry = entry->next;
    }

    VIR_DEBUG("No alias found for '%s', passing through to drivers",
              alias);
    return 0;
}

static int
virConnectOpenResolveURIAlias(const char *alias, char **uri)
{
    char *config = NULL;
    int ret = -1;
    virConfPtr conf = NULL;
    virConfValuePtr value = NULL;

    *uri = NULL;

    /* Short circuit to avoid doing URI alias resolution
     * when it clearly isn't an valid alias */
    if (strspn(alias, URI_ALIAS_CHARS) != strlen(alias))
        return 0;

    if (!(config = virConnectConfigFile()))
        goto cleanup;

    if (!virFileExists(config)) {
        ret = 0;
        goto cleanup;
    }

    VIR_DEBUG("Loading config file '%s'", config);
    if (!(conf = virConfReadFile(config, 0)))
        goto cleanup;

    if ((value = virConfGetValue(conf, "uri_aliases")))
        ret = virConnectOpenFindURIAliasMatch(value, alias, uri);
    else
        ret = 0;

cleanup:
    virConfFree(conf);
    VIR_FREE(config);
    return ret;
}

1081
static virConnectPtr
1082 1083
do_open (const char *name,
         virConnectAuthPtr auth,
1084
         unsigned int flags)
1085
{
1086
    int i, res;
1087 1088
    virConnectPtr ret;

1089 1090
    virResetLastError();

1091 1092 1093
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
1094

1095 1096 1097 1098 1099 1100 1101 1102
    /*
     *  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) {
1103
            VIR_DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
1104 1105
            name = defname;
        } else {
1106
            name = NULL;
1107
        }
1108
    }
1109

1110
    if (name) {
1111
        char *alias = NULL;
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
        /* 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:///";

1122 1123 1124 1125 1126
        if (!(flags & VIR_CONNECT_NO_ALIASES) &&
            virConnectOpenResolveURIAlias(name, &alias) < 0)
            goto failed;

        ret->uri = xmlParseURI (alias ? alias : name);
1127
        if (!ret->uri) {
1128
            virLibConnError(VIR_ERR_INVALID_ARG,
1129 1130 1131
                            _("could not parse connection URI %s"),
                            alias ? alias : name);
            VIR_FREE(alias);
1132 1133
            goto failed;
        }
1134

1135
        VIR_DEBUG("name \"%s\" to URI components:\n"
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
                  "  scheme %s\n"
                  "  opaque %s\n"
                  "  authority %s\n"
                  "  server %s\n"
                  "  user %s\n"
                  "  port %d\n"
                  "  path %s\n",
                  alias ? alias : name,
                  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));

        VIR_FREE(alias);
1150
    } else {
1151
        VIR_DEBUG("no name, allowing driver auto-select");
1152 1153
    }

1154 1155 1156
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1157
    for (i = 0; i < virDriverTabCount; i++) {
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
        /* 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
1172
             STRCASEEQ(ret->uri->scheme, "vpx") ||
1173 1174
             STRCASEEQ(ret->uri->scheme, "esx") ||
             STRCASEEQ(ret->uri->scheme, "gsx") ||
M
Matthias Bolte 已提交
1175 1176 1177
#endif
#ifndef WITH_HYPERV
             STRCASEEQ(ret->uri->scheme, "hyperv") ||
1178 1179 1180 1181 1182
#endif
#ifndef WITH_XENAPI
             STRCASEEQ(ret->uri->scheme, "xenapi") ||
#endif
             false)) {
1183
            virReportErrorHelper(VIR_FROM_NONE, VIR_ERR_INVALID_ARG,
1184 1185 1186 1187 1188 1189
                                 __FILE__, __FUNCTION__, __LINE__,
                                 _("libvirt was built without the '%s' driver"),
                                 ret->uri->scheme);
            goto failed;
        }

1190
        VIR_DEBUG("trying driver %d (%s) ...",
1191
              i, virDriverTab[i]->name);
1192
        res = virDriverTab[i]->open (ret, auth, flags);
1193
        VIR_DEBUG("driver %d %s returned %s",
1194 1195 1196 1197
              i, virDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1198 1199 1200 1201 1202
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1203 1204
    }

1205
    if (!ret->driver) {
1206
        /* If we reach here, then all drivers declined the connection. */
1207 1208 1209
        virLibConnError(VIR_ERR_NO_CONNECT,
                        _("No connection for URI %s"),
                        NULLSTR(name));
1210
        goto failed;
1211 1212
    }

1213
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1214
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1215
        VIR_DEBUG("network driver %d %s returned %s",
1216 1217 1218 1219
              i, virNetworkDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1220 1221 1222
        if (res == VIR_DRV_OPEN_ERROR) {
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1223 1224 1225
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1226
    }
1227

D
Daniel Veillard 已提交
1228 1229
    for (i = 0; i < virInterfaceDriverTabCount; i++) {
        res = virInterfaceDriverTab[i]->open (ret, auth, flags);
1230
        VIR_DEBUG("interface driver %d %s returned %s",
D
Daniel Veillard 已提交
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
              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;
        }
    }
1242 1243 1244

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1245
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1246
        VIR_DEBUG("storage driver %d %s returned %s",
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
              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;
        }
    }

1259 1260 1261
    /* Node driver (optional) */
    for (i = 0; i < virDeviceMonitorTabCount; i++) {
        res = virDeviceMonitorTab[i]->open (ret, auth, flags);
1262
        VIR_DEBUG("node driver %d %s returned %s",
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
              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;
        }
    }

1275 1276 1277
    /* Secret manipulation driver. Optional */
    for (i = 0; i < virSecretDriverTabCount; i++) {
        res = virSecretDriverTab[i]->open (ret, auth, flags);
1278
        VIR_DEBUG("secret driver %d %s returned %s",
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
              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 已提交
1291 1292 1293
    /* Network filter driver. Optional */
    for (i = 0; i < virNWFilterDriverTabCount; i++) {
        res = virNWFilterDriverTab[i]->open (ret, auth, flags);
1294
        VIR_DEBUG("nwfilter driver %d %s returned %s",
S
Stefan Berger 已提交
1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
              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;
        }
    }

1307
    return ret;
1308 1309

failed:
1310 1311
    virUnrefConnect(ret);

1312
    return NULL;
1313 1314
}

1315 1316
/**
 * virConnectOpen:
1317
 * @name: URI of the hypervisor
1318
 *
1319
 * This function should be called first to get a connection to the
1320 1321 1322
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1323
 *
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
 * 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
 *
1335
 * URIs are documented at http://libvirt.org/uri.html
1336 1337 1338 1339
 */
virConnectPtr
virConnectOpen (const char *name)
{
1340
    virConnectPtr ret = NULL;
1341 1342
    if (!initialized)
        if (virInitialize() < 0)
1343
            goto error;
1344

1345
    VIR_DEBUG("name=%s", name);
1346 1347 1348 1349 1350 1351 1352 1353
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1354 1355
}

1356
/**
1357
 * virConnectOpenReadOnly:
1358
 * @name: URI of the hypervisor
1359
 *
1360
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1361
 * library functionalities. The set of APIs usable are then restricted
1362
 * on the available methods to control the domains.
1363
 *
1364 1365 1366
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1367
 * Returns a pointer to the hypervisor connection or NULL in case of error
1368 1369
 *
 * URIs are documented at http://libvirt.org/uri.html
1370
 */
1371
virConnectPtr
1372 1373
virConnectOpenReadOnly(const char *name)
{
1374
    virConnectPtr ret = NULL;
1375 1376
    if (!initialized)
        if (virInitialize() < 0)
1377
            goto error;
1378

1379
    VIR_DEBUG("name=%s", name);
1380 1381 1382 1383 1384 1385 1386 1387
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1388 1389 1390 1391 1392 1393 1394 1395
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1396
 * This function should be called first to get a connection to the
1397
 * Hypervisor. If necessary, authentication will be performed fetching
1398 1399
 * credentials via the callback
 *
1400 1401 1402
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1403 1404 1405 1406 1407 1408 1409
 * 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,
1410
                   unsigned int flags)
1411
{
1412
    virConnectPtr ret = NULL;
1413 1414
    if (!initialized)
        if (virInitialize() < 0)
1415
            goto error;
1416

1417
    VIR_DEBUG("name=%s, auth=%p, flags=%x", NULLSTR(name), auth, flags);
1418 1419 1420 1421 1422 1423 1424 1425
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1426 1427 1428
}

/**
1429
 * virConnectClose:
D
Daniel Veillard 已提交
1430 1431 1432 1433 1434 1435 1436
 * @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.
 *
1437 1438 1439 1440 1441 1442 1443 1444
 * 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.
 *
1445
 * Returns the number of remaining references on success
1446 1447 1448 1449 1450 1451 1452
 * (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 已提交
1453 1454
 */
int
1455 1456
virConnectClose(virConnectPtr conn)
{
1457
    int ret = -1;
1458
    VIR_DEBUG("conn=%p", conn);
1459

1460 1461 1462
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1463
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1464
        goto error;
1465
    }
1466

1467 1468 1469 1470 1471 1472 1473 1474
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

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

1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
/**
 * 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 已提交
1491 1492
 *
 * Returns 0 in case of success, -1 in case of failure
1493 1494 1495 1496 1497
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
1498
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1499
        virDispatchError(NULL);
1500
        return -1;
1501 1502
    }
    virMutexLock(&conn->lock);
1503
    VIR_DEBUG("conn=%p refs=%d", conn, conn->refs);
1504 1505 1506 1507 1508
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1509 1510
/*
 * Not for public use.  This function is part of the internal
1511 1512 1513
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1514
virDrvSupportsFeature (virConnectPtr conn, int feature)
1515
{
1516
    int ret;
1517
    VIR_DEBUG("conn=%p, feature=%d", conn, feature);
1518

1519 1520 1521
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1522
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1523
        virDispatchError(NULL);
1524
        return -1;
1525
    }
1526

1527 1528 1529 1530
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1531 1532

    if (ret < 0)
1533
        virDispatchError(conn);
1534

1535
    return ret;
1536 1537
}

1538 1539 1540 1541 1542 1543 1544
/**
 * 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.
1545 1546 1547
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1548 1549
 */
const char *
1550 1551
virConnectGetType(virConnectPtr conn)
{
1552
    const char *ret;
1553
    VIR_DEBUG("conn=%p", conn);
1554

1555 1556
    virResetLastError();

D
Daniel Veillard 已提交
1557
    if (!VIR_IS_CONNECT(conn)) {
1558
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1559
        virDispatchError(NULL);
1560
        return NULL;
D
Daniel Veillard 已提交
1561
    }
1562 1563 1564 1565

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1566
    }
1567
    return conn->driver->name;
1568 1569
}

D
Daniel Veillard 已提交
1570
/**
1571
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1572
 * @conn: pointer to the hypervisor connection
1573
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1574
 *
1575
 * Get the version level of the Hypervisor running. This may work only with
1576
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1577
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1578
 *
1579 1580 1581
 * 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 已提交
1582
 */
1583
int
1584 1585
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1586
    VIR_DEBUG("conn=%p, hvVer=%p", conn, hvVer);
1587

1588 1589
    virResetLastError();

D
Daniel Veillard 已提交
1590
    if (!VIR_IS_CONNECT(conn)) {
1591
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1592
        virDispatchError(NULL);
1593
        return -1;
D
Daniel Veillard 已提交
1594
    }
1595

D
Daniel Veillard 已提交
1596
    if (hvVer == NULL) {
1597
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1598
        goto error;
D
Daniel Veillard 已提交
1599
    }
1600

1601 1602 1603 1604 1605 1606
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1607

1608
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1609 1610

error:
1611
    virDispatchError(conn);
1612
    return -1;
1613 1614
}

1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
/**
 * 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;
1630
    VIR_DEBUG("conn=%p, libVir=%p", conn, libVer);
1631 1632 1633 1634

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1635
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1636
        virDispatchError(NULL);
1637 1638 1639 1640
        return -1;
    }

    if (libVer == NULL) {
1641
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
        goto error;
    }

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

1652 1653 1654
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1655
error:
1656
    virDispatchError(conn);
1657 1658 1659
    return ret;
}

1660 1661 1662 1663 1664
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
1665
 * running (the result of the gethostname system call).  If
1666 1667 1668 1669 1670 1671 1672 1673 1674
 * 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)
{
1675
    VIR_DEBUG("conn=%p", conn);
1676

1677 1678
    virResetLastError();

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

1685 1686 1687 1688 1689 1690
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1691

1692
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1693 1694

error:
1695
    virDispatchError(conn);
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
    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)
{
1717
    char *name;
1718
    VIR_DEBUG("conn=%p", conn);
1719

1720 1721
    virResetLastError();

1722
    if (!VIR_IS_CONNECT(conn)) {
1723
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1724
        virDispatchError(NULL);
1725 1726 1727
        return NULL;
    }

1728
    name = (char *)xmlSaveUri(conn->uri);
1729
    if (!name) {
1730
        virReportOOMError();
1731
        goto error;
1732 1733
    }
    return name;
1734 1735

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

E
Eric Blake 已提交
1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
/**
 * 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 已提交
1756
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
E
Eric Blake 已提交
1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779

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

1780 1781 1782 1783 1784
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1785
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1786 1787 1788 1789 1790 1791 1792 1793 1794
 * 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)
{
1795
    VIR_DEBUG("conn=%p, type=%s", conn, type);
1796

1797 1798
    virResetLastError();

1799
    if (!VIR_IS_CONNECT(conn)) {
1800
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1801
        virDispatchError(NULL);
1802
        return -1;
1803 1804
    }

1805 1806 1807 1808 1809 1810
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1811

1812
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1813
error:
1814
    virDispatchError(conn);
1815
    return -1;
1816 1817
}

1818
/**
1819
 * virConnectListDomains:
1820 1821 1822 1823 1824 1825 1826 1827 1828
 * @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
1829 1830
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1831
    VIR_DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);
1832

1833 1834
    virResetLastError();

D
Daniel Veillard 已提交
1835
    if (!VIR_IS_CONNECT(conn)) {
1836
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1837
        virDispatchError(NULL);
1838
        return -1;
D
Daniel Veillard 已提交
1839
    }
1840

1841
    if ((ids == NULL) || (maxids < 0)) {
1842
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1843
        goto error;
D
Daniel Veillard 已提交
1844
    }
1845

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

1853
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1854
error:
1855
    virDispatchError(conn);
1856
    return -1;
D
Daniel Veillard 已提交
1857 1858
}

K
 
Karel Zak 已提交
1859 1860 1861 1862
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1863 1864
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1865 1866 1867
 * Returns the number of domain found or -1 in case of error
 */
int
1868 1869
virConnectNumOfDomains(virConnectPtr conn)
{
1870
    VIR_DEBUG("conn=%p", conn);
1871

1872 1873
    virResetLastError();

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

1880 1881 1882 1883 1884 1885
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1886

1887
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1888
error:
1889
    virDispatchError(conn);
1890
    return -1;
K
 
Karel Zak 已提交
1891 1892
}

1893 1894 1895 1896
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1897
 * Provides the connection pointer associated with a domain.  The
1898 1899 1900
 * reference counter on the connection is not increased by this
 * call.
 *
1901 1902 1903 1904
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1905 1906 1907 1908 1909
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1910
    VIR_DOMAIN_DEBUG(dom);
1911

1912 1913 1914
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1915
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1916
        virDispatchError(NULL);
1917 1918 1919 1920 1921
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1922
/**
1923
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1924
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1925
 * @xmlDesc: string containing an XML description of the domain
1926
 * @flags: bitwise-or of supported virDomainCreateFlags
D
Daniel Veillard 已提交
1927
 *
1928
 * Launch a new guest domain, based on an XML description similar
1929
 * to the one returned by virDomainGetXMLDesc()
1930
 * This function may require privileged access to the hypervisor.
1931 1932 1933
 * 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).
1934
 *
1935 1936 1937 1938 1939 1940 1941
 * 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 已提交
1942
 * client application crashes / loses its connection to the
1943
 * libvirtd daemon. Any domains marked for auto destroy will
1944
 * block attempts at migration, save-to-file, or snapshots.
1945
 *
D
Daniel Veillard 已提交
1946 1947
 * Returns a new domain object or NULL in case of failure
 */
1948
virDomainPtr
1949 1950
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1951
{
1952
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
1953

1954 1955
    virResetLastError();

D
Daniel Veillard 已提交
1956
    if (!VIR_IS_CONNECT(conn)) {
1957
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1958
        virDispatchError(NULL);
1959
        return NULL;
D
Daniel Veillard 已提交
1960 1961
    }
    if (xmlDesc == NULL) {
1962
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1963
        goto error;
D
Daniel Veillard 已提交
1964
    }
1965
    if (conn->flags & VIR_CONNECT_RO) {
1966
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1967
        goto error;
1968
    }
D
Daniel Veillard 已提交
1969

1970 1971 1972 1973 1974 1975 1976
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1977

1978
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1979
error:
1980
    virDispatchError(conn);
1981
    return NULL;
D
Daniel Veillard 已提交
1982 1983
}

1984 1985 1986 1987 1988 1989 1990 1991
/**
 * 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.
1992
 * This existing name will left indefinitely for API compatibility.
1993 1994 1995 1996 1997 1998 1999
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
{
2000
    return virDomainCreateXML(conn, xmlDesc, flags);
2001
}
2002

2003
/**
2004
 * virDomainLookupByID:
2005 2006 2007 2008
 * @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 已提交
2009 2010
 * 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.
2011
 *
2012 2013
 * 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.
2014
 */
2015
virDomainPtr
2016 2017
virDomainLookupByID(virConnectPtr conn, int id)
{
2018
    VIR_DEBUG("conn=%p, id=%d", conn, id);
2019

2020 2021
    virResetLastError();

D
Daniel Veillard 已提交
2022
    if (!VIR_IS_CONNECT(conn)) {
2023
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2024
        virDispatchError(NULL);
2025
        return NULL;
D
Daniel Veillard 已提交
2026 2027
    }
    if (id < 0) {
2028
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2029
        goto error;
D
Daniel Veillard 已提交
2030
    }
2031

2032 2033 2034 2035 2036 2037 2038
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
2039

2040
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2041 2042

error:
2043
    virDispatchError(conn);
2044
    return NULL;
2045 2046 2047 2048 2049
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
2050
 * @uuid: the raw UUID for the domain
2051 2052 2053
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
2054 2055
 * 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.
2056 2057
 */
virDomainPtr
2058 2059
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
2060
    VIR_UUID_DEBUG(conn, uuid);
2061

2062 2063
    virResetLastError();

D
Daniel Veillard 已提交
2064
    if (!VIR_IS_CONNECT(conn)) {
2065
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2066
        virDispatchError(NULL);
2067
        return NULL;
D
Daniel Veillard 已提交
2068 2069
    }
    if (uuid == NULL) {
2070
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2071
        goto error;
D
Daniel Veillard 已提交
2072
    }
2073

2074 2075 2076 2077 2078 2079 2080
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
2081

2082
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2083 2084

error:
2085
    virDispatchError(conn);
2086
    return NULL;
2087 2088
}

K
Karel Zak 已提交
2089 2090 2091 2092 2093 2094 2095
/**
 * 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.
 *
2096 2097
 * 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 已提交
2098 2099 2100 2101
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
2102
    unsigned char uuid[VIR_UUID_BUFLEN];
2103
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
2104

2105 2106
    virResetLastError();

K
Karel Zak 已提交
2107
    if (!VIR_IS_CONNECT(conn)) {
2108
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2109
        virDispatchError(NULL);
2110
        return NULL;
K
Karel Zak 已提交
2111 2112
    }
    if (uuidstr == NULL) {
2113
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2114
        goto error;
K
Karel Zak 已提交
2115
    }
2116 2117

    if (virUUIDParse(uuidstr, uuid) < 0) {
2118
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2119
        goto error;
K
Karel Zak 已提交
2120
    }
2121

K
Karel Zak 已提交
2122
    return virDomainLookupByUUID(conn, &uuid[0]);
2123 2124

error:
2125
    virDispatchError(conn);
2126
    return NULL;
K
Karel Zak 已提交
2127 2128
}

2129 2130 2131 2132 2133
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
2134
 * Try to lookup a domain on the given hypervisor based on its name.
2135
 *
2136 2137
 * 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.
2138 2139
 */
virDomainPtr
2140 2141
virDomainLookupByName(virConnectPtr conn, const char *name)
{
2142
    VIR_DEBUG("conn=%p, name=%s", conn, name);
2143

2144 2145
    virResetLastError();

D
Daniel Veillard 已提交
2146
    if (!VIR_IS_CONNECT(conn)) {
2147
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2148
        virDispatchError(NULL);
2149
        return NULL;
D
Daniel Veillard 已提交
2150 2151
    }
    if (name == NULL) {
2152
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2153
        goto error;
D
Daniel Veillard 已提交
2154
    }
2155

2156 2157 2158 2159 2160 2161 2162
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2163

2164
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2165 2166

error:
2167
    virDispatchError(conn);
2168
    return NULL;
2169 2170
}

D
Daniel Veillard 已提交
2171
/**
2172
 * virDomainDestroy:
D
Daniel Veillard 已提交
2173 2174 2175
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
2176 2177 2178
 * 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 已提交
2179
 *
2180 2181 2182 2183
 * If the domain is transient and has any snapshot metadata (see
 * virDomainSnapshotNum()), then that metadata will automatically
 * be deleted when the domain quits.
 *
D
Daniel Veillard 已提交
2184
 * Returns 0 in case of success and -1 in case of failure.
2185
 */
D
Daniel Veillard 已提交
2186
int
2187 2188
virDomainDestroy(virDomainPtr domain)
{
2189
    virConnectPtr conn;
2190

2191
    VIR_DOMAIN_DEBUG(domain);
2192

2193 2194
    virResetLastError();

D
Daniel Veillard 已提交
2195
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2196
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2197
        virDispatchError(NULL);
2198
        return -1;
D
Daniel Veillard 已提交
2199
    }
2200

2201
    conn = domain->conn;
2202
    if (conn->flags & VIR_CONNECT_RO) {
2203
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2204
        goto error;
2205
    }
2206

2207 2208 2209 2210 2211 2212 2213
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2214

2215
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2216 2217

error:
2218
    virDispatchError(conn);
2219
    return -1;
2220 2221
}

2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232
/**
 * 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)
2233 2234 2235
 * is equivalent to calling virDomainDestroy.  Using virDomainShutdown()
 * may produce cleaner results for the guest's disks, but depends on guest
 * support.
2236 2237 2238 2239 2240 2241 2242 2243 2244
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainDestroyFlags(virDomainPtr domain,
                      unsigned int flags)
{
    virConnectPtr conn;

E
Eric Blake 已提交
2245
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275

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

2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
/**
 * 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
2286 2287
virDomainFree(virDomainPtr domain)
{
2288
    VIR_DOMAIN_DEBUG(domain);
2289

2290 2291 2292
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2293
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2294
        virDispatchError(NULL);
2295
        return -1;
D
Daniel Veillard 已提交
2296
    }
2297 2298
    if (virUnrefDomain(domain) < 0) {
        virDispatchError(NULL);
2299
        return -1;
2300
    }
2301
    return 0;
D
Daniel Veillard 已提交
2302 2303
}

2304 2305
/**
 * virDomainRef:
D
Daniel Veillard 已提交
2306
 * @domain: the domain to hold a reference on
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
 *
 * 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 已提交
2318 2319
 *
 * Returns 0 in case of success and -1 in case of failure.
2320 2321 2322 2323 2324
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
2325
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2326
        virDispatchError(NULL);
2327
        return -1;
2328 2329
    }
    virMutexLock(&domain->conn->lock);
2330
    VIR_DOMAIN_DEBUG(domain, "refs=%d", domain->refs);
2331 2332 2333 2334 2335 2336
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
2337
/**
2338
 * virDomainSuspend:
D
Daniel Veillard 已提交
2339 2340 2341
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
2342
 * to CPU resources and I/O but the memory used by the domain at the
2343
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
2344
 * the domain.
2345
 * This function may require privileged access.
D
Daniel Veillard 已提交
2346 2347 2348 2349
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2350 2351
virDomainSuspend(virDomainPtr domain)
{
2352
    virConnectPtr conn;
2353

2354
    VIR_DOMAIN_DEBUG(domain);
2355

2356 2357
    virResetLastError();

D
Daniel Veillard 已提交
2358
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2359
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2360
        virDispatchError(NULL);
2361
        return -1;
D
Daniel Veillard 已提交
2362
    }
2363
    if (domain->conn->flags & VIR_CONNECT_RO) {
2364
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2365
        goto error;
2366
    }
D
Daniel Veillard 已提交
2367

2368 2369
    conn = domain->conn;

2370 2371 2372 2373 2374 2375 2376
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2377

2378
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2379 2380

error:
2381
    virDispatchError(domain->conn);
2382
    return -1;
D
Daniel Veillard 已提交
2383 2384 2385
}

/**
2386
 * virDomainResume:
D
Daniel Veillard 已提交
2387 2388
 * @domain: a domain object
 *
D
Dan Kenigsberg 已提交
2389
 * Resume a suspended domain, the process is restarted from the state where
2390
 * it was frozen by calling virSuspendDomain().
2391
 * This function may require privileged access
D
Daniel Veillard 已提交
2392 2393 2394 2395
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2396 2397
virDomainResume(virDomainPtr domain)
{
2398
    virConnectPtr conn;
2399

2400
    VIR_DOMAIN_DEBUG(domain);
2401

2402 2403
    virResetLastError();

D
Daniel Veillard 已提交
2404
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2405
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2406
        virDispatchError(NULL);
2407
        return -1;
D
Daniel Veillard 已提交
2408
    }
2409
    if (domain->conn->flags & VIR_CONNECT_RO) {
2410
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2411
        goto error;
2412
    }
D
Daniel Veillard 已提交
2413

2414 2415
    conn = domain->conn;

2416 2417 2418 2419 2420 2421 2422
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2423

2424
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2425 2426

error:
2427
    virDispatchError(domain->conn);
2428
    return -1;
D
Daniel Veillard 已提交
2429 2430
}

2431 2432 2433 2434 2435 2436
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2437
 * a file on disk. After the call, if successful, the domain is not
2438
 * listed as running anymore (this ends the life of a transient domain).
2439
 * Use virDomainRestore() to restore a domain after saving.
2440
 *
2441 2442 2443
 * See virDomainSaveFlags() for more control.  Also, a save file can
 * be inspected or modified slightly with virDomainSaveImageGetXMLDesc()
 * and virDomainSaveImageDefineXML().
2444
 *
2445 2446 2447
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2448 2449
virDomainSave(virDomainPtr domain, const char *to)
{
2450
    virConnectPtr conn;
2451 2452

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

2454 2455
    virResetLastError();

D
Daniel Veillard 已提交
2456
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2457
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2458
        virDispatchError(NULL);
2459
        return -1;
D
Daniel Veillard 已提交
2460
    }
2461
    if (domain->conn->flags & VIR_CONNECT_RO) {
2462
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2463
        goto error;
2464
    }
2465
    conn = domain->conn;
D
Daniel Veillard 已提交
2466
    if (to == NULL) {
2467
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2468
        goto error;
D
Daniel Veillard 已提交
2469
    }
2470

2471 2472 2473
    if (conn->driver->domainSave) {
        int ret;
        char *absolute_to;
2474

2475 2476 2477 2478 2479 2480
        /* 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;
        }
2481

2482 2483 2484
        ret = conn->driver->domainSave(domain, absolute_to);

        VIR_FREE(absolute_to);
2485

2486 2487 2488 2489
        if (ret < 0)
            goto error;
        return ret;
    }
2490

2491
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2492 2493

error:
2494
    virDispatchError(domain->conn);
2495
    return -1;
2496 2497
}

2498 2499 2500 2501 2502 2503 2504 2505 2506
/**
 * 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
2507
 * listed as running anymore (this ends the life of a transient domain).
2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521
 * 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.
 *
2522 2523 2524 2525 2526 2527
 * 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.
 *
2528 2529 2530
 * A save file can be inspected or modified slightly with
 * virDomainSaveImageGetXMLDesc() and virDomainSaveImageDefineXML().
 *
2531 2532 2533 2534 2535 2536 2537 2538
 * 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 已提交
2539
    VIR_DOMAIN_DEBUG(domain, "to=%s, dxml=%s, flags=%x",
2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
                     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;
    }

2559 2560 2561 2562 2563 2564
    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;
    }

2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
    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;
}

2592 2593
/**
 * virDomainRestore:
2594
 * @conn: pointer to the hypervisor connection
2595
 * @from: path to the input file
2596 2597 2598
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
2599 2600
 * See virDomainRestoreFlags() for more control.
 *
2601 2602 2603
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2604 2605
virDomainRestore(virConnectPtr conn, const char *from)
{
2606
    VIR_DEBUG("conn=%p, from=%s", conn, from);
2607

2608 2609
    virResetLastError();

D
Daniel Veillard 已提交
2610
    if (!VIR_IS_CONNECT(conn)) {
2611
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2612
        virDispatchError(NULL);
2613
        return -1;
D
Daniel Veillard 已提交
2614
    }
2615
    if (conn->flags & VIR_CONNECT_RO) {
2616
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2617
        goto error;
2618
    }
D
Daniel Veillard 已提交
2619
    if (from == NULL) {
2620
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2621
        goto error;
D
Daniel Veillard 已提交
2622 2623
    }

2624 2625 2626
    if (conn->driver->domainRestore) {
        int ret;
        char *absolute_from;
2627

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

2635 2636 2637 2638
        ret = conn->driver->domainRestore(conn, absolute_from);

        VIR_FREE(absolute_from);

2639 2640 2641 2642
        if (ret < 0)
            goto error;
        return ret;
    }
2643

2644
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2645 2646

error:
2647
    virDispatchError(conn);
2648
    return -1;
D
Daniel Veillard 已提交
2649 2650
}

2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671
/**
 * 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.
 *
2672 2673 2674 2675 2676 2677
 * 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.
 *
2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702
 * 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;
    }

2703 2704 2705 2706 2707 2708
    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;
    }

2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736
    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;
}

2737 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 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
/**
 * 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
2813
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824
 *
 * 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.
 *
2825 2826 2827 2828 2829 2830 2831
 * 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.
 *
2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856
 * 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;
    }

2857 2858 2859 2860 2861 2862
    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;
    }

2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890
    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 已提交
2891 2892 2893 2894
/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
2895
 * @flags: an OR'ed set of virDomainCoreDumpFlags
D
Daniel Veillard 已提交
2896 2897 2898
 *
 * 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
2899 2900
 * the remote host. Hypervisors may require  the user to manually ensure
 * proper permissions on the file named by @to.
D
Daniel Veillard 已提交
2901
 *
2902 2903 2904 2905
 * 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.
2906 2907
 * VIR_DUMP_RESET flag forces reset of the quest after dump.
 * The above three flags are mutually exclusive.
2908 2909 2910 2911 2912 2913
 *
 * 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 已提交
2914 2915 2916
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2917
virDomainCoreDump(virDomainPtr domain, const char *to, unsigned int flags)
D
Daniel Veillard 已提交
2918 2919
{
    virConnectPtr conn;
2920

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

2923 2924
    virResetLastError();

D
Daniel Veillard 已提交
2925
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2926
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2927
        virDispatchError(NULL);
2928
        return -1;
D
Daniel Veillard 已提交
2929 2930
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
2931
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2932
        goto error;
D
Daniel Veillard 已提交
2933 2934 2935
    }
    conn = domain->conn;
    if (to == NULL) {
2936
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2937
        goto error;
D
Daniel Veillard 已提交
2938 2939
    }

2940 2941 2942 2943 2944 2945
    if ((flags & VIR_DUMP_CRASH) && (flags & VIR_DUMP_LIVE)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("crash and live flags are mutually exclusive"));
        goto error;
    }

2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
    if ((flags & VIR_DUMP_CRASH) && (flags & VIR_DUMP_RESET)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                         _("crash and reset flags are mutually exclusive"));
        goto error;
    }

    if ((flags & VIR_DUMP_LIVE) && (flags & VIR_DUMP_RESET)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("live and reset flags are mutually exclusive"));
        goto error;
    }

2958 2959 2960
    if (conn->driver->domainCoreDump) {
        int ret;
        char *absolute_to;
D
Daniel Veillard 已提交
2961

2962 2963 2964 2965
        /* 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"));
2966 2967
            goto error;
        }
D
Daniel Veillard 已提交
2968

2969 2970 2971
        ret = conn->driver->domainCoreDump(domain, absolute_to, flags);

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

2973 2974 2975 2976
        if (ret < 0)
            goto error;
        return ret;
    }
2977

2978
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2979 2980

error:
2981
    virDispatchError(domain->conn);
2982
    return -1;
2983 2984
}

2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002
/**
 * 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
3003
 * the second head on the second card.
3004 3005 3006 3007 3008 3009 3010 3011 3012 3013
 *
 * 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 已提交
3014
    VIR_DOMAIN_DEBUG(domain, "stream=%p, flags=%x", stream, flags);
3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049

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

3050 3051 3052 3053
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
3054
 * Shutdown a domain, the domain object is still usable thereafter but
3055
 * the domain OS is being stopped. Note that the guest OS may ignore the
3056 3057 3058 3059 3060
 * request.  For guests that react to a shutdown request, the differences
 * from virDomainDestroy() are that the guests disk storage will be in a
 * stable state rather than having the (virtual) power cord pulled, and
 * this command returns as soon as the shutdown request is issued rather
 * than blocking until the guest is no longer running.
3061
 *
3062 3063 3064
 * If the domain is transient and has any snapshot metadata (see
 * virDomainSnapshotNum()), then that metadata will automatically
 * be deleted when the domain quits.
3065 3066 3067 3068
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3069 3070
virDomainShutdown(virDomainPtr domain)
{
3071
    virConnectPtr conn;
3072

3073
    VIR_DOMAIN_DEBUG(domain);
3074

3075 3076
    virResetLastError();

D
Daniel Veillard 已提交
3077
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3078
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3079
        virDispatchError(NULL);
3080
        return -1;
D
Daniel Veillard 已提交
3081
    }
3082
    if (domain->conn->flags & VIR_CONNECT_RO) {
3083
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3084
        goto error;
3085
    }
3086

3087 3088
    conn = domain->conn;

3089 3090 3091 3092 3093 3094 3095
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3096

3097
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3098 3099

error:
3100
    virDispatchError(domain->conn);
3101
    return -1;
3102 3103
}

3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117
/**
 * 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)
{
3118
    virConnectPtr conn;
3119

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

3122 3123
    virResetLastError();

3124
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3125
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3126
        virDispatchError(NULL);
3127
        return -1;
3128
    }
3129
    if (domain->conn->flags & VIR_CONNECT_RO) {
3130
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3131
        goto error;
3132
    }
3133

3134 3135
    conn = domain->conn;

3136 3137 3138 3139 3140 3141 3142
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
3143

3144
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
X
Xu He Jie 已提交
3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194

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

/**
 * virDomainReset:
 * @domain: a domain object
 * @flags: extra flags for the reboot operation, not used yet
 *
 * Reset a domain immediately without any guest OS shutdown.
 * Reset emulates the power reset button on a machine, where all
 * hardware sees the RST line set and reinitializes internal state.
 *
 * Note that there is a risk of data loss caused by reset without any
 * guest OS shutdown.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainReset(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;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3195 3196

error:
3197
    virDispatchError(domain->conn);
3198
    return -1;
3199 3200
}

3201
/**
3202
 * virDomainGetName:
3203 3204 3205 3206 3207 3208 3209 3210
 * @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 *
3211 3212
virDomainGetName(virDomainPtr domain)
{
3213
    VIR_DEBUG("domain=%p", domain);
3214

3215 3216
    virResetLastError();

D
Daniel Veillard 已提交
3217
    if (!VIR_IS_DOMAIN(domain)) {
3218
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3219
        virDispatchError(NULL);
3220
        return NULL;
D
Daniel Veillard 已提交
3221
    }
3222
    return domain->name;
3223 3224
}

3225 3226 3227
/**
 * virDomainGetUUID:
 * @domain: a domain object
3228
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
3229 3230 3231 3232 3233 3234
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
3235 3236
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
3237
    VIR_DOMAIN_DEBUG(domain, "uuid=%p", uuid);
3238

3239 3240
    virResetLastError();

D
Daniel Veillard 已提交
3241
    if (!VIR_IS_DOMAIN(domain)) {
3242
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3243
        virDispatchError(NULL);
3244
        return -1;
D
Daniel Veillard 已提交
3245 3246
    }
    if (uuid == NULL) {
3247
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3248
        virDispatchError(domain->conn);
3249
        return -1;
D
Daniel Veillard 已提交
3250 3251
    }

3252 3253
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

3254
    return 0;
3255 3256
}

K
Karel Zak 已提交
3257 3258 3259
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
3260
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
3261
 *
3262
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
3263 3264 3265 3266 3267 3268 3269
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
3270
    unsigned char uuid[VIR_UUID_BUFLEN];
3271 3272

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

3274 3275
    virResetLastError();

K
Karel Zak 已提交
3276
    if (!VIR_IS_DOMAIN(domain)) {
3277
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3278
        virDispatchError(NULL);
3279
        return -1;
K
Karel Zak 已提交
3280 3281
    }
    if (buf == NULL) {
3282
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3283
        goto error;
K
Karel Zak 已提交
3284
    }
3285

K
Karel Zak 已提交
3286
    if (virDomainGetUUID(domain, &uuid[0]))
3287
        goto error;
K
Karel Zak 已提交
3288

3289
    virUUIDFormat(uuid, buf);
3290
    return 0;
3291 3292

error:
3293
    virDispatchError(domain->conn);
3294
    return -1;
K
Karel Zak 已提交
3295 3296
}

3297
/**
3298
 * virDomainGetID:
3299 3300 3301 3302 3303 3304 3305
 * @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
3306 3307
virDomainGetID(virDomainPtr domain)
{
3308
    VIR_DOMAIN_DEBUG(domain);
3309

3310 3311
    virResetLastError();

D
Daniel Veillard 已提交
3312
    if (!VIR_IS_DOMAIN(domain)) {
3313
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3314
        virDispatchError(NULL);
3315
        return (unsigned int)-1;
D
Daniel Veillard 已提交
3316
    }
3317
    return domain->id;
3318 3319
}

3320 3321 3322 3323 3324 3325
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
3326 3327
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
3328 3329
 */
char *
3330 3331
virDomainGetOSType(virDomainPtr domain)
{
3332
    virConnectPtr conn;
3333

3334
    VIR_DOMAIN_DEBUG(domain);
3335

3336 3337 3338
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3339
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3340
        virDispatchError(NULL);
3341
        return NULL;
D
Daniel Veillard 已提交
3342
    }
3343

3344 3345
    conn = domain->conn;

3346 3347 3348 3349 3350 3351 3352
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
3353

3354
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3355 3356

error:
3357
    virDispatchError(domain->conn);
3358
    return NULL;
3359 3360
}

3361
/**
3362
 * virDomainGetMaxMemory:
3363
 * @domain: a domain object or NULL
3364
 *
3365 3366 3367 3368 3369 3370 3371
 * 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
3372 3373
virDomainGetMaxMemory(virDomainPtr domain)
{
3374
    virConnectPtr conn;
3375

3376
    VIR_DOMAIN_DEBUG(domain);
3377

3378 3379
    virResetLastError();

D
Daniel Veillard 已提交
3380
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3381
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3382
        virDispatchError(NULL);
3383
        return 0;
D
Daniel Veillard 已提交
3384
    }
3385

3386 3387
    conn = domain->conn;

3388 3389 3390 3391 3392 3393 3394
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
3395

3396
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3397 3398

error:
3399
    virDispatchError(domain->conn);
3400
    return 0;
3401 3402
}

D
Daniel Veillard 已提交
3403
/**
3404
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
3405 3406
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
3407
 *
D
Daniel Veillard 已提交
3408 3409 3410
 * 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.
3411
 * This function may require privileged access to the hypervisor.
D
Daniel Veillard 已提交
3412
 *
3413 3414 3415
 * This command is hypervisor-specific for whether active, persistent,
 * or both configurations are changed; for more control, use
 * virDomainSetMemoryFlags().
3416
 *
D
Daniel Veillard 已提交
3417 3418 3419
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3420 3421
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
3422
    virConnectPtr conn;
3423 3424

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

3426 3427
    virResetLastError();

3428
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3429
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3430
        virDispatchError(NULL);
3431
        return -1;
3432
    }
3433
    if (domain->conn->flags & VIR_CONNECT_RO) {
3434
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3435
        goto error;
3436
    }
3437
    if (!memory) {
3438
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3439
        goto error;
3440
    }
3441
    conn = domain->conn;
3442

3443 3444 3445 3446 3447 3448 3449
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3450

3451
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3452 3453

error:
3454
    virDispatchError(domain->conn);
3455
    return -1;
3456
}
3457

3458 3459 3460 3461
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
3462
 *
3463 3464 3465
 * 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.
3466
 * This function may require privileged access to the hypervisor.
3467
 *
3468 3469 3470
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
3471 3472 3473 3474 3475 3476
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
3477 3478

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

3480 3481
    virResetLastError();

3482
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3483
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3484
        virDispatchError(NULL);
3485
        return -1;
3486
    }
3487
    if (domain->conn->flags & VIR_CONNECT_RO) {
3488
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3489
        goto error;
3490
    }
3491
    if (!memory) {
3492
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3493
        goto error;
3494 3495 3496
    }

    conn = domain->conn;
3497

3498 3499 3500 3501 3502 3503 3504
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3505

3506
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3507 3508

error:
3509
    virDispatchError(domain->conn);
3510
    return -1;
D
Daniel Veillard 已提交
3511 3512
}

3513
/*
3514
 * virDomainSetMemoryFlags:
3515 3516 3517 3518 3519 3520 3521
 * @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.
3522
 * This function may require privileged access to the hypervisor.
3523
 *
3524 3525
 * @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
3526
 * a running domain and will fail if domain is not active.
3527
 * If VIR_DOMAIN_AFFECT_CONFIG is set, the change affects persistent state,
3528
 * and will fail for transient domains. If neither flag is specified
3529
 * (that is, @flags is VIR_DOMAIN_AFFECT_CURRENT), then an inactive domain
3530 3531
 * modifies persistent setup, while an active domain is hypervisor-dependent
 * on whether just live or both live and persistent state is changed.
3532 3533
 * If VIR_DOMAIN_MEM_MAXIMUM is set, the change affects domain's maximum memory
 * size rather than current memory size.
3534
 * Not all hypervisors can support all flag combinations.
3535 3536 3537 3538 3539 3540 3541 3542 3543 3544
 *
 * 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 已提交
3545
    VIR_DOMAIN_DEBUG(domain, "memory=%lu, flags=%x", memory, flags);
3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559

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

3560
    if (!memory) {
3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574
        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;
    }

3575 3576
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

3577 3578 3579 3580 3581
error:
    virDispatchError(domain->conn);
    return -1;
}

3582 3583 3584 3585
/**
 * virDomainSetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter objects
3586
 * @nparams: number of memory parameter (this value can be the same or
3587
 *          less than the number of parameters supported)
3588
 * @flags: bitwise-OR of virDomainModificationImpact
3589
 *
3590
 * Change all or a subset of the memory tunables.
3591
 * This function may require privileged access to the hypervisor.
3592 3593 3594 3595 3596
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetMemoryParameters(virDomainPtr domain,
3597
                             virTypedParameterPtr params,
3598 3599 3600
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;
3601

3602
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3603
                     params, nparams, flags);
3604 3605 3606 3607

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3608
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3609 3610 3611 3612
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
3613
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3614 3615 3616
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
3617
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629
        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;
    }

3630
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642

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
3643
 * @flags: one of virDomainModificationImpact
3644
 *
3645
 * Get all memory parameters, the @params array will be filled with the values
3646 3647
 * equal to the number of parameters suggested by @nparams
 *
3648 3649 3650
 * 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
3651
 * array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
3652 3653
 * again.
 *
3654
 * Here is a sample code snippet:
3655 3656 3657
 *
 * if ((virDomainGetMemoryParameters(dom, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
3658 3659
 *     if ((params = malloc(sizeof(*params) * nparams)) == NULL)
 *         goto error;
3660
 *     memset(params, 0, sizeof(*params) * nparams);
3661
 *     if (virDomainGetMemoryParameters(dom, params, &nparams, 0))
3662 3663
 *         goto error;
 * }
3664
 *
3665
 * This function may require privileged access to the hypervisor. This function
3666
 * expects the caller to allocate the @params.
3667 3668 3669 3670 3671
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
3672
                             virTypedParameterPtr params,
3673 3674 3675
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
3676

3677
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3678
                     params, (nparams) ? *nparams : -1, flags);
3679 3680 3681 3682

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3683
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3684 3685 3686
        virDispatchError(NULL);
        return -1;
    }
3687 3688
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3689
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700
        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;
    }
3701
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3702 3703 3704 3705 3706 3707

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

3708 3709 3710 3711
/**
 * virDomainSetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter objects
3712
 * @nparams: number of blkio parameters (this value can be the same or
3713
 *          less than the number of parameters supported)
3714
 * @flags: an OR'ed set of virDomainModificationImpact
3715
 *
3716
 * Change all or a subset of the blkio tunables.
3717
 * This function may require privileged access to the hypervisor.
3718 3719 3720 3721 3722
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetBlkioParameters(virDomainPtr domain,
3723
                             virTypedParameterPtr params,
3724 3725 3726 3727
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;

3728
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768
                     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
3769
 * @flags: an OR'ed set of virDomainModificationImpact
3770
 *
3771 3772 3773
 * 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.
3774
 *
3775
 * This function may require privileged access to the hypervisor. This function
3776 3777 3778 3779 3780 3781
 * expects the caller to allocate the @params.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetBlkioParameters(virDomainPtr domain,
3782
                             virTypedParameterPtr params,
3783 3784 3785 3786
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;

3787
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3788 3789 3790 3791 3792 3793 3794 3795 3796
                     params, (nparams) ? *nparams : -1, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
3797 3798
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817
        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;
}

3818 3819
/**
 * virDomainGetInfo:
3820
 * @domain: a domain object
3821
 * @info: pointer to a virDomainInfo structure allocated by the user
3822
 *
3823
 * Extract information about a domain. Note that if the connection
3824
 * used to get the domain is limited only a partial set of the information
3825 3826 3827 3828 3829
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3830 3831
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3832
    virConnectPtr conn;
3833 3834

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

3836 3837
    virResetLastError();

D
Daniel Veillard 已提交
3838
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3839
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3840
        virDispatchError(NULL);
3841
        return -1;
D
Daniel Veillard 已提交
3842 3843
    }
    if (info == NULL) {
3844
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3845
        goto error;
D
Daniel Veillard 已提交
3846
    }
3847

3848
    memset(info, 0, sizeof(virDomainInfo));
3849

3850 3851
    conn = domain->conn;

3852 3853 3854 3855 3856 3857 3858
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3859

3860
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3861 3862

error:
3863
    virDispatchError(domain->conn);
3864
    return -1;
3865
}
3866

3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887
/**
 * 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 已提交
3888 3889
    VIR_DOMAIN_DEBUG(domain, "state=%p, reason=%p, flags=%x",
                     state, reason, flags);
3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907

    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)
3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935
            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 已提交
3936
    VIR_DOMAIN_DEBUG(domain, "info=%p, flags=%x", info, flags);
3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955

    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)
3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

3967 3968 3969
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3970
 * @flags: an OR'ed set of virDomainXMLFlags
3971 3972
 *
 * Provide an XML description of the domain. The description may be reused
3973
 * later to relaunch the domain with virDomainCreateXML().
3974
 *
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984
 * 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.
 *
3985 3986 3987 3988
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3989
virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)
3990
{
3991
    virConnectPtr conn;
3992

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

3995 3996 3997
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3998
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3999
        virDispatchError(NULL);
4000
        return NULL;
D
Daniel Veillard 已提交
4001
    }
4002

4003 4004
    conn = domain->conn;

4005
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
4006
        virLibConnError(VIR_ERR_OPERATION_DENIED,
4007 4008 4009 4010
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

4011
    if (conn->driver->domainGetXMLDesc) {
4012
        char *ret;
4013
        ret = conn->driver->domainGetXMLDesc(domain, flags);
4014 4015 4016 4017
        if (!ret)
            goto error;
        return ret;
    }
4018

4019
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4020 4021

error:
4022
    virDispatchError(domain->conn);
4023
    return NULL;
4024
}
4025

4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
/**
 * 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 已提交
4045
    VIR_DEBUG("conn=%p, format=%s, config=%s, flags=%x",
4046
              conn, nativeFormat, nativeConfig, flags);
4047 4048 4049 4050

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4051
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4052
        virDispatchError(NULL);
4053
        return NULL;
4054 4055 4056
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
4057
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4058
        goto error;
4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071
    }

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

4072
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4073 4074

error:
4075
    virDispatchError(conn);
4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086
    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 已提交
4087
 * a native configuration file describing the domain.
4088 4089 4090 4091 4092 4093 4094 4095 4096 4097
 * 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 已提交
4098
    VIR_DEBUG("conn=%p, format=%s, xml=%s, flags=%x",
4099
              conn, nativeFormat, domainXml, flags);
4100 4101 4102 4103

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4104
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4105
        virDispatchError(NULL);
4106
        return NULL;
4107
    }
4108 4109 4110 4111
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
4112 4113

    if (nativeFormat == NULL || domainXml == NULL) {
4114
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4115
        goto error;
4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
    }

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

4129
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4130 4131

error:
4132
    virDispatchError(conn);
4133 4134 4135 4136
    return NULL;
}


4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152
/*
 * 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
 *
 */
4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
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;
4164 4165
    int cookielen = 0, ret;
    virDomainInfo info;
4166
    VIR_DOMAIN_DEBUG(domain,
E
Eric Blake 已提交
4167
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4168
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4169 4170 4171 4172 4173

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191

    /* 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) {
4192
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223
                         _("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;
}

4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242
/*
 * 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
 *
 */
4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255
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;
4256
    virDomainInfo info;
4257
    virErrorPtr orig_err = NULL;
4258
    int cancelled;
4259
    VIR_DOMAIN_DEBUG(domain,
E
Eric Blake 已提交
4260
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4261
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278

    /* 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.
     */
4279
    if (!domain->conn->driver->domainGetXMLDesc) {
4280
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
4281
        virDispatchError(domain->conn);
4282 4283
        return NULL;
    }
4284 4285 4286
    dom_xml = domain->conn->driver->domainGetXMLDesc(domain,
                                                     VIR_DOMAIN_XML_SECURE |
                                                     VIR_DOMAIN_XML_UPDATE_CPU);
4287 4288 4289
    if (!dom_xml)
        return NULL;

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

4295
    VIR_DEBUG("Prepare2 %p flags=%lx", dconn, flags);
4296 4297 4298 4299 4300 4301 4302 4303
    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) {
4304
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
4305
                         _("domainMigratePrepare2 did not set uri"));
4306
        virDispatchError(domain->conn);
4307 4308
        cancelled = 1;
        goto finish;
4309 4310 4311 4312 4313 4314 4315
    }
    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.
     */
4316
    VIR_DEBUG("Perform %p", domain->conn);
4317 4318 4319
    ret = domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth);

4320 4321 4322 4323
    /* Perform failed. Make sure Finish doesn't overwrite the error */
    if (ret < 0)
        orig_err = virSaveLastError();

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

finish:
4330 4331 4332 4333 4334
    /* 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;
4335
    VIR_DEBUG("Finish2 %p ret=%d", dconn, ret);
4336
    ddomain = dconn->driver->domainMigrateFinish2
4337
        (dconn, dname, cookie, cookielen, uri, flags, cancelled);
4338 4339

 done:
4340 4341 4342 4343
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
4344 4345 4346 4347 4348
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

4349

4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376
/*
 * 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,
4377
                         const char *xmlin,
4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392
                         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;
4393 4394
    int cancelled = 1;
    unsigned long protection = 0;
4395
    bool notify_source = true;
4396

4397
    VIR_DOMAIN_DEBUG(domain, "dconn=%p xmlin=%s, flags=%lx, "
4398 4399 4400
                     "dname=%s, uri=%s, bandwidth=%lu",
                     dconn, NULLSTR(xmlin), flags,
                     NULLSTR(dname), NULLSTR(uri), bandwidth);
4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411

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

4412 4413 4414 4415
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATE_CHANGE_PROTECTION))
        protection = VIR_MIGRATE_CHANGE_PROTECTION;

4416 4417
    VIR_DEBUG("Begin3 %p", domain->conn);
    dom_xml = domain->conn->driver->domainMigrateBegin3
4418
        (domain, xmlin, &cookieout, &cookieoutlen,
4419
         flags | protection, dname, bandwidth);
4420 4421 4422 4423 4424 4425 4426 4427
    if (!dom_xml)
        goto done;

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

4428
    VIR_DEBUG("Prepare3 %p flags=%lx", dconn, flags);
4429 4430 4431 4432 4433 4434 4435 4436
    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);
4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447
    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;
        }
    }
4448 4449 4450 4451 4452

    if (uri == NULL && uri_out == NULL) {
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("domainMigratePrepare3 did not set uri"));
        virDispatchError(domain->conn);
4453
        goto finish;
4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468
    }
    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;
4469
    /* dconnuri not relevant in non-P2P modes, so left NULL here */
4470
    ret = domain->conn->driver->domainMigratePerform3
4471
        (domain, NULL, cookiein, cookieinlen,
4472
         &cookieout, &cookieoutlen, NULL,
4473
         uri, flags | protection, dname, bandwidth);
4474 4475

    /* Perform failed. Make sure Finish doesn't overwrite the error */
4476
    if (ret < 0) {
4477
        orig_err = virSaveLastError();
4478 4479 4480 4481 4482
        /* Perform failed so we don't need to call confirm to let source know
         * about the failure.
         */
        notify_source = false;
    }
4483 4484 4485 4486 4487 4488

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

4489
finish:
4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502
    /*
     * 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;
4503
    ddomain = dconn->driver->domainMigrateFinish3
4504
        (dconn, dname, cookiein, cookieinlen, &cookieout, &cookieoutlen,
4505 4506 4507 4508 4509 4510 4511 4512 4513
         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.
4514
     */
4515
    cancelled = ddomain == NULL ? 1 : 0;
4516

4517 4518 4519 4520 4521 4522
    /* 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();

4523
confirm:
4524
    /*
4525 4526 4527
     * 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.
4528
     */
4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547
    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);
        }
    }
4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560

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


4561
 /*
4562
  * In normal migration, the libvirt client co-ordinates communication
4563
  * between the 2 libvirtd instances on source & dest hosts.
4564
  *
4565 4566 4567 4568
  * 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.
4569 4570 4571
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
4572
                           const char *xmlin,
4573 4574
                           unsigned long flags,
                           const char *dname,
4575
                           const char *dconnuri,
4576 4577 4578
                           const char *uri,
                           unsigned long bandwidth)
{
4579
    xmlURIPtr tempuri = NULL;
4580
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s, flags=%lx, dname=%s, "
4581 4582 4583
                     "dconnuri=%s, uri=%s, bandwidth=%lu",
                     NULLSTR(xmlin), flags, NULLSTR(dname),
                     NULLSTR(dconnuri), NULLSTR(uri), bandwidth);
4584

4585
    if (!domain->conn->driver->domainMigratePerform) {
4586
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4587
        virDispatchError(domain->conn);
4588 4589 4590
        return -1;
    }

4591
    tempuri = xmlParseURI(dconnuri);
4592
    if (!tempuri) {
4593
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4594 4595 4596 4597 4598
        virDispatchError(domain->conn);
        return -1;
    }

    if (!tempuri->server || STRPREFIX(tempuri->server, "localhost")) {
4599
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4600 4601 4602 4603 4604 4605
        virDispatchError(domain->conn);
        xmlFreeURI(tempuri);
        return -1;
    }
    xmlFreeURI(tempuri);

4606 4607 4608
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
4609 4610 4611 4612
    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,
4613
                                                           xmlin,
4614 4615 4616 4617
                                                           NULL, /* cookiein */
                                                           0,    /* cookieinlen */
                                                           NULL, /* cookieoutlen */
                                                           NULL, /* cookieoutlen */
4618
                                                           dconnuri,
4619 4620 4621 4622 4623 4624
                                                           uri,
                                                           flags,
                                                           dname,
                                                           bandwidth);
    } else {
        VIR_DEBUG("Using migration protocol 2");
4625 4626 4627 4628 4629
        if (xmlin) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to change target guest XML during migration"));
            return -1;
        }
4630 4631 4632 4633 4634
        if (uri) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to override peer2peer migration URI"));
            return -1;
        }
4635 4636 4637
        return domain->conn->driver->domainMigratePerform(domain,
                                                          NULL, /* cookie */
                                                          0,    /* cookielen */
4638
                                                          dconnuri,
4639 4640 4641 4642
                                                          flags,
                                                          dname,
                                                          bandwidth);
    }
4643 4644 4645
}


C
Chris Lalancette 已提交
4646
/*
4647
 * In normal migration, the libvirt client co-ordinates communication
4648
 * between the 2 libvirtd instances on source & dest hosts.
C
Chris Lalancette 已提交
4649
 *
4650 4651 4652
 * Some hypervisors support an alternative, direct migration where
 * there is no requirement for a libvirtd instance on the dest host.
 * In this case
4653
 *
4654 4655
 * 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 已提交
4656
 */
4657 4658
static int
virDomainMigrateDirect (virDomainPtr domain,
4659
                        const char *xmlin,
4660 4661 4662 4663 4664
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
4665 4666 4667 4668
    VIR_DOMAIN_DEBUG(domain,
                     "xmlin=%s, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
                     NULLSTR(xmlin), flags, NULLSTR(dname), NULLSTR(uri),
                     bandwidth);
4669

4670
    if (!domain->conn->driver->domainMigratePerform) {
4671
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4672
        virDispatchError(domain->conn);
4673 4674 4675
        return -1;
    }

C
Chris Lalancette 已提交
4676 4677 4678
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
4679 4680 4681
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATION_V3)) {
        VIR_DEBUG("Using migration protocol 3");
4682 4683
        /* dconn URI not relevant in direct migration, since no
         * target libvirtd is involved */
4684
        return domain->conn->driver->domainMigratePerform3(domain,
4685
                                                           xmlin,
4686 4687 4688 4689
                                                           NULL, /* cookiein */
                                                           0,    /* cookieinlen */
                                                           NULL, /* cookieoutlen */
                                                           NULL, /* cookieoutlen */
4690
                                                           NULL, /* dconnuri */
4691 4692 4693 4694 4695 4696
                                                           uri,
                                                           flags,
                                                           dname,
                                                           bandwidth);
    } else {
        VIR_DEBUG("Using migration protocol 2");
4697 4698 4699 4700 4701
        if (xmlin) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to change target guest XML during migration"));
            return -1;
        }
4702 4703 4704 4705 4706 4707 4708 4709
        return domain->conn->driver->domainMigratePerform(domain,
                                                          NULL, /* cookie */
                                                          0,    /* cookielen */
                                                          uri,
                                                          flags,
                                                          dname,
                                                          bandwidth);
    }
C
Chris Lalancette 已提交
4710 4711
}

4712

4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725
/**
 * 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:
4726 4727 4728
 *   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 已提交
4729 4730 4731 4732
 *   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.
4733
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
4734 4735 4736
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
4737 4738 4739 4740 4741
 *
 * 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.
4742 4743 4744 4745 4746 4747
 *
 * 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.
 *
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758
 * 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.
 *
4759
 * In either case it is typically only necessary to specify a
4760 4761
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789
 *
 * 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;
4790

4791 4792
    VIR_DOMAIN_DEBUG(domain,
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4793
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4794

4795 4796
    virResetLastError();

4797
    /* First checkout the source */
4798
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4799
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4800
        virDispatchError(NULL);
4801 4802
        return NULL;
    }
4803
    if (domain->conn->flags & VIR_CONNECT_RO) {
4804
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4805
        goto error;
4806 4807
    }

4808 4809
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
4810
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4811 4812 4813 4814
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
4815
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4816 4817 4818
        goto error;
    }

4819 4820 4821 4822 4823 4824
    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);
4825
                if (!dstURI)
4826 4827
                    return NULL;
            }
4828

4829
            VIR_DEBUG("Using peer2peer migration");
4830
            if (virDomainMigratePeer2Peer(domain, NULL, flags, dname,
4831
                                          uri ? uri : dstURI, NULL, bandwidth) < 0) {
4832 4833 4834 4835
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
4836

4837 4838 4839
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
4840
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4841 4842
            goto error;
        }
4843
    } else {
4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856
        /* 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;
4857
        if (flags & VIR_MIGRATE_TUNNELLED) {
4858
            virLibConnError(VIR_ERR_OPERATION_INVALID,
4859 4860 4861 4862
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
4863 4864
        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
4865
                                     VIR_DRV_FEATURE_MIGRATION_V3) &&
C
Chris Lalancette 已提交
4866
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
4867 4868
                                     VIR_DRV_FEATURE_MIGRATION_V3)) {
            VIR_DEBUG("Using migration protocol 3");
4869 4870
            ddomain = virDomainMigrateVersion3(domain, dconn, NULL,
                                               flags, dname, uri, bandwidth);
4871 4872 4873 4874 4875
        } 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");
4876 4877
            ddomain = virDomainMigrateVersion2(domain, dconn, flags,
                                               dname, uri, bandwidth);
4878 4879 4880 4881 4882
        } 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");
4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924
            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.
4925 4926 4927
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967
 *
 * 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.
 *
4968 4969 4970 4971 4972 4973 4974 4975
 * 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.
4976 4977 4978
 * @dxml cannot be used to rename the domain during migration (use
 * @dname for that purpose).  Domain name in @dxml must either match the
 * original domain name or @dname if it was specified.
4979
 *
4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994
 * 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;

4995 4996
    VIR_DOMAIN_DEBUG(domain,
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044
                     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 {
5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057
        /* 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;
5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095
        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);
5096
        } else {
5097
            /* This driver does not support any migration method */
5098
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
5099 5100
            goto error;
        }
5101 5102
    }

5103 5104
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
5105

5106
    return ddomain;
5107 5108

error:
5109
    virDispatchError(domain->conn);
5110
    return NULL;
5111 5112
}

5113 5114 5115 5116 5117 5118 5119 5120 5121 5122

/**
 * 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 已提交
5123
 * host given by duri.
5124 5125 5126 5127 5128
 *
 * 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
5129 5130 5131 5132
 *   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.
5133 5134 5135
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
5136
 *
5137 5138 5139 5140 5141 5142 5143 5144 5145 5146
 * 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
5147
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
5148
 * libvirt driver can connect to the destination libvirt.
5149
 *
5150 5151 5152 5153 5154 5155 5156
 * 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.
5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180
 *
 * 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)
{
5181
    VIR_DOMAIN_DEBUG(domain, "duri=%p, flags=%lx, dname=%s, bandwidth=%lu",
5182
                     NULLSTR(duri), flags, NULLSTR(dname), bandwidth);
5183 5184 5185 5186 5187

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
5188
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5189
        virDispatchError(NULL);
5190 5191 5192
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5193
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5194 5195 5196 5197
        goto error;
    }

    if (duri == NULL) {
5198
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5199 5200 5201 5202 5203 5204
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
5205
            VIR_DEBUG("Using peer2peer migration");
5206
            if (virDomainMigratePeer2Peer(domain, NULL, flags,
5207
                                          dname, duri, NULL, bandwidth) < 0)
5208 5209 5210
                goto error;
        } else {
            /* No peer to peer migration supported */
5211
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5212 5213 5214 5215 5216
            goto error;
        }
    } else {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_DIRECT)) {
5217
            VIR_DEBUG("Using direct migration");
5218 5219
            if (virDomainMigrateDirect(domain, NULL, flags,
                                       dname, duri, bandwidth) < 0)
5220 5221 5222
                goto error;
        } else {
            /* Cannot do a migration with only the perform step */
5223
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5224 5225 5226 5227 5228 5229 5230
            goto error;
        }
    }

    return 0;

error:
5231
    virDispatchError(domain->conn);
5232 5233 5234 5235
    return -1;
}


5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256
/**
 * 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.
5257 5258 5259
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317
 *
 * 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, "
5318
                     "flags=%lx, dname=%s, bandwidth=%lu",
5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368
                     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 已提交
5369 5370
/*
 * Not for public use.  This function is part of the internal
5371 5372 5373
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5374
virDomainMigratePrepare (virConnectPtr dconn,
5375 5376 5377 5378 5379 5380 5381
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
5382
{
J
John Levon 已提交
5383
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, "
5384
              "flags=%lx, dname=%s, bandwidth=%lu", dconn, cookie, cookielen,
J
John Levon 已提交
5385
              NULLSTR(uri_in), uri_out, flags, NULLSTR(dname), bandwidth);
5386

5387 5388
    virResetLastError();

5389
    if (!VIR_IS_CONNECT (dconn)) {
5390
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5391
        virDispatchError(NULL);
5392 5393 5394
        return -1;
    }

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

5400 5401 5402 5403 5404 5405 5406 5407 5408
    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;
    }
5409

5410
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5411 5412

error:
5413
    virDispatchError(dconn);
5414 5415 5416
    return -1;
}

D
Daniel Veillard 已提交
5417 5418
/*
 * Not for public use.  This function is part of the internal
5419 5420 5421
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5422
virDomainMigratePerform (virDomainPtr domain,
5423 5424 5425 5426 5427 5428 5429 5430
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
5431

5432
    VIR_DOMAIN_DEBUG(domain, "cookie=%p, cookielen=%d, uri=%s, flags=%lx, "
5433 5434
                     "dname=%s, bandwidth=%lu", cookie, cookielen, uri, flags,
                     NULLSTR(dname), bandwidth);
5435

5436 5437 5438
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
5439
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5440
        virDispatchError(NULL);
5441 5442 5443 5444
        return -1;
    }
    conn = domain->conn;

5445
    if (domain->conn->flags & VIR_CONNECT_RO) {
5446
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5447
        goto error;
5448 5449
    }

5450 5451 5452 5453 5454 5455 5456 5457 5458
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
5459

5460
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5461 5462

error:
5463
    virDispatchError(domain->conn);
5464 5465 5466
    return -1;
}

D
Daniel Veillard 已提交
5467 5468
/*
 * Not for public use.  This function is part of the internal
5469 5470 5471
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
5472
virDomainMigrateFinish (virConnectPtr dconn,
5473 5474 5475 5476 5477 5478
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
5479
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
5480
              "flags=%lx", dconn, NULLSTR(dname), cookie, cookielen,
J
John Levon 已提交
5481
              uri, flags);
5482

5483 5484
    virResetLastError();

5485
    if (!VIR_IS_CONNECT (dconn)) {
5486
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5487
        virDispatchError(NULL);
5488 5489 5490
        return NULL;
    }

5491
    if (dconn->flags & VIR_CONNECT_RO) {
5492
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5493
        goto error;
5494 5495
    }

5496 5497 5498 5499 5500 5501 5502 5503 5504
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
5505

5506
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5507 5508

error:
5509
    virDispatchError(dconn);
5510
    return NULL;
D
Daniel Veillard 已提交
5511 5512 5513
}


D
Daniel Veillard 已提交
5514 5515
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
5516 5517 5518
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5519 5520 5521 5522 5523 5524 5525 5526 5527
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 已提交
5528
{
J
John Levon 已提交
5529
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p,"
5530
              "flags=%lx, dname=%s, bandwidth=%lu, dom_xml=%s", dconn,
J
John Levon 已提交
5531 5532
              cookie, cookielen, uri_in, uri_out, flags, NULLSTR(dname),
              bandwidth, dom_xml);
D
Daniel Veillard 已提交
5533

5534 5535
    virResetLastError();

D
Daniel Veillard 已提交
5536
    if (!VIR_IS_CONNECT (dconn)) {
5537
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5538
        virDispatchError(NULL);
D
Daniel Veillard 已提交
5539 5540 5541
        return -1;
    }

5542
    if (dconn->flags & VIR_CONNECT_RO) {
5543
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5544
        goto error;
5545 5546
    }

5547 5548 5549 5550 5551 5552 5553 5554 5555 5556
    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 已提交
5557

5558
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5559 5560

error:
5561
    virDispatchError(dconn);
D
Daniel Veillard 已提交
5562 5563 5564
    return -1;
}

D
Daniel Veillard 已提交
5565 5566
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
5567 5568 5569
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
5570 5571 5572 5573 5574 5575 5576
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
5577
{
J
John Levon 已提交
5578
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
5579
              "flags=%lx, retcode=%d", dconn, NULLSTR(dname), cookie,
J
John Levon 已提交
5580
              cookielen, uri, flags, retcode);
D
Daniel Veillard 已提交
5581

5582 5583
    virResetLastError();

D
Daniel Veillard 已提交
5584
    if (!VIR_IS_CONNECT (dconn)) {
5585
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5586
        virDispatchError(NULL);
D
Daniel Veillard 已提交
5587 5588 5589
        return NULL;
    }

5590
    if (dconn->flags & VIR_CONNECT_RO) {
5591
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5592
        goto error;
5593 5594
    }

5595 5596 5597 5598 5599 5600 5601 5602 5603 5604
    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 已提交
5605

5606
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5607 5608

error:
5609
    virDispatchError(dconn);
D
Daniel Veillard 已提交
5610
    return NULL;
5611 5612 5613
}


C
Chris Lalancette 已提交
5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625
/*
 * 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)
{
5626
    VIR_DEBUG("conn=%p, stream=%p, flags=%lx, dname=%s, "
5627
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
5628 5629 5630 5631 5632
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
5633
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5634
        virDispatchError(NULL);
C
Chris Lalancette 已提交
5635 5636 5637 5638
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
5639
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
5640 5641 5642 5643
        goto error;
    }

    if (conn != st->conn) {
5644
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
5645 5646 5647 5648
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
5649
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
5650 5651 5652 5653 5654 5655 5656
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

5657
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
5658 5659

error:
5660
    virDispatchError(conn);
C
Chris Lalancette 已提交
5661 5662 5663
    return -1;
}

5664 5665 5666 5667 5668 5669
/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
char *
virDomainMigrateBegin3(virDomainPtr domain,
5670
                       const char *xmlin,
5671 5672 5673 5674 5675 5676 5677 5678
                       char **cookieout,
                       int *cookieoutlen,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    virConnectPtr conn;

5679
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s cookieout=%p, cookieoutlen=%p, "
5680
                     "flags=%lx, dname=%s, bandwidth=%lu",
5681
                     NULLSTR(xmlin), cookieout, cookieoutlen, flags,
5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699
                     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;
5700
        xml = conn->driver->domainMigrateBegin3(domain, xmlin,
5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733
                                                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)
{
5734 5735 5736 5737 5738
    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);
5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 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

    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)

{
5790 5791 5792
    VIR_DEBUG("conn=%p, stream=%p, cookiein=%p, cookieinlen=%d, cookieout=%p, "
              "cookieoutlen=%p, flags=%lx, dname=%s, bandwidth=%lu, "
              "dom_xml=%s",
5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838
              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,
5839
                         const char *xmlin,
5840 5841 5842 5843
                         const char *cookiein,
                         int cookieinlen,
                         char **cookieout,
                         int *cookieoutlen,
5844
                         const char *dconnuri,
5845 5846 5847 5848 5849 5850 5851
                         const char *uri,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
{
    virConnectPtr conn;

5852
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s cookiein=%p, cookieinlen=%d, "
5853
                     "cookieout=%p, cookieoutlen=%p, dconnuri=%s, "
5854
                     "uri=%s, flags=%lx, dname=%s, bandwidth=%lu",
5855
                     NULLSTR(xmlin), cookiein, cookieinlen,
5856 5857
                     cookieout, cookieoutlen, NULLSTR(dconnuri),
                     NULLSTR(uri), flags, NULLSTR(dname), bandwidth);
5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874

    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;
5875
        ret = conn->driver->domainMigratePerform3(domain, xmlin,
5876 5877
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
5878
                                                  dconnuri, uri,
5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896
                                                  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.
 */
5897
virDomainPtr
5898 5899 5900 5901 5902 5903
virDomainMigrateFinish3(virConnectPtr dconn,
                        const char *dname,
                        const char *cookiein,
                        int cookieinlen,
                        char **cookieout,
                        int *cookieoutlen,
5904
                        const char *dconnuri,
5905 5906
                        const char *uri,
                        unsigned long flags,
5907
                        int cancelled)
5908 5909
{
    VIR_DEBUG("dconn=%p, dname=%s, cookiein=%p, cookieinlen=%d, cookieout=%p,"
5910
              "cookieoutlen=%p, dconnuri=%s, uri=%s, flags=%lx, retcode=%d",
5911
              dconn, NULLSTR(dname), cookiein, cookieinlen, cookieout,
5912
              cookieoutlen, NULLSTR(dconnuri), NULLSTR(uri), flags, cancelled);
5913 5914 5915 5916 5917 5918

    virResetLastError();

    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
5919
        return NULL;
5920 5921 5922 5923 5924 5925 5926 5927
    }

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

    if (dconn->driver->domainMigrateFinish3) {
5928
        virDomainPtr ret;
5929 5930 5931
        ret = dconn->driver->domainMigrateFinish3(dconn, dname,
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
5932
                                                  dconnuri, uri, flags,
5933 5934
                                                  cancelled);
        if (!ret)
5935 5936 5937 5938 5939 5940 5941 5942
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(dconn);
5943
    return NULL;
5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959
}


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

5960 5961
    VIR_DOMAIN_DEBUG(domain,
                     "cookiein=%p, cookieinlen=%d, flags=%lx, cancelled=%d",
5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
                     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 已提交
5995

5996 5997 5998 5999
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
6000
 *
6001 6002 6003 6004 6005
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
6006 6007
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
6008
    VIR_DEBUG("conn=%p, info=%p", conn, info);
6009

6010 6011
    virResetLastError();

6012
    if (!VIR_IS_CONNECT(conn)) {
6013
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6014
        virDispatchError(NULL);
6015
        return -1;
6016 6017
    }
    if (info == NULL) {
6018
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6019
        goto error;
6020 6021
    }

6022 6023 6024 6025 6026 6027 6028
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6029

6030
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6031 6032

error:
6033
    virDispatchError(conn);
6034
    return -1;
6035
}
6036

6037 6038 6039 6040 6041 6042
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
6043 6044
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
6045 6046 6047 6048 6049
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
6050
    VIR_DEBUG("conn=%p", conn);
6051

6052 6053
    virResetLastError();

6054
    if (!VIR_IS_CONNECT (conn)) {
6055
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6056
        virDispatchError(NULL);
6057 6058 6059
        return NULL;
    }

6060 6061 6062 6063 6064
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
6065
        VIR_DEBUG("conn=%p ret=%s", conn, ret);
6066 6067
        return ret;
    }
6068

6069
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6070 6071

error:
6072
    virDispatchError(conn);
6073 6074 6075
    return NULL;
}

6076 6077 6078
/**
 * virNodeGetCPUStats:
 * @conn: pointer to the hypervisor connection.
6079
 * @cpuNum: number of node cpu. (VIR_NODE_CPU_STATS_ALL_CPUS means total cpu
6080 6081 6082 6083 6084 6085 6086 6087
 *          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
6088
 * VIR_NODE_CPU_STATS_ALL_CPUS to @cpuNum.
6089 6090 6091 6092 6093 6094
 * 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
6095
 * array, i.e. (sizeof(@virNodeCPUStats) * @nparams) bytes and call
6096 6097 6098 6099 6100 6101
 * the API again.
 *
 * Here is a sample code snippet:
 *
 * if ((virNodeGetCPUStats(conn, cpuNum, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
6102
 *     if ((params = malloc(sizeof(virNodeCPUStats) * nparams)) == NULL)
6103
 *         goto error;
6104
 *     memset(params, 0, sizeof(virNodeCPUStats) * nparams);
6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131
 *     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,
6132
                        virNodeCPUStatsPtr params,
6133 6134
                        int *nparams, unsigned int flags)
{
6135
    VIR_DEBUG("conn=%p, cpuNum=%d, params=%p, nparams=%d, flags=%x",
6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146
              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) ||
6147
        ((cpuNum < 0) && (cpuNum != VIR_NODE_CPU_STATS_ALL_CPUS))) {
6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165
        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;
}

6166 6167 6168
/**
 * virNodeGetMemoryStats:
 * @conn: pointer to the hypervisor connection.
6169 6170
 * @cellNum: number of node cell. (VIR_NODE_MEMORY_STATS_ALL_CELLS means total
 *           cell statistics)
6171 6172 6173 6174 6175 6176 6177
 * @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
6178
 * VIR_NODE_MEMORY_STATS_ALL_CELLS to @cellNum.
6179 6180 6181 6182 6183 6184
 * 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
6185
 * array, i.e. (sizeof(@virNodeMemoryStats) * @nparams) bytes and call
6186 6187 6188 6189 6190 6191
 * the API again.
 *
 * Here is the sample code snippet:
 *
 * if ((virNodeGetMemoryStats(conn, cellNum, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
6192
 *     if ((params = malloc(sizeof(virNodeMemoryStats) * nparams)) == NULL)
6193
 *         goto error;
6194
 *     memset(params, cellNum, 0, sizeof(virNodeMemoryStats) * nparams);
6195 6196 6197 6198 6199 6200 6201 6202 6203
 *     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:
 *
6204
 * VIR_NODE_MEMORY_STATS_TOTAL:
6205
 *     The total memory usage.(KB)
6206
 * VIR_NODE_MEMORY_STATS_FREE:
6207 6208
 *     The free memory usage.(KB)
 *     On linux, this usage includes buffers and cached.
6209
 * VIR_NODE_MEMORY_STATS_BUFFERS:
6210
 *     The buffers memory usage.(KB)
6211
 * VIR_NODE_MEMORY_STATS_CACHED:
6212 6213 6214 6215 6216 6217
 *     The cached memory usage.(KB)
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virNodeGetMemoryStats (virConnectPtr conn,
                           int cellNum,
6218
                           virNodeMemoryStatsPtr params,
6219 6220
                           int *nparams, unsigned int flags)
{
6221
    VIR_DEBUG("conn=%p, cellNum=%d, params=%p, nparams=%d, flags=%x",
6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232
              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) ||
6233
        ((cellNum < 0) && (cellNum != VIR_NODE_MEMORY_STATS_ALL_CELLS))) {
6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251
        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;
}

6252 6253 6254
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
6255
 *
D
Daniel Veillard 已提交
6256
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
6257 6258
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
6259
 *
D
Daniel Veillard 已提交
6260
 * Returns the available free memory in bytes or 0 in case of error
6261 6262 6263 6264
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
6265
    VIR_DEBUG("conn=%p", conn);
6266

6267 6268
    virResetLastError();

6269
    if (!VIR_IS_CONNECT (conn)) {
6270
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6271
        virDispatchError(NULL);
6272 6273 6274
        return 0;
    }

6275
    if (conn->driver->nodeGetFreeMemory) {
6276
        unsigned long long ret;
6277
        ret = conn->driver->nodeGetFreeMemory (conn);
6278 6279 6280 6281
        if (ret == 0)
            goto error;
        return ret;
    }
6282

6283
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6284 6285

error:
6286
    virDispatchError(conn);
6287 6288 6289
    return 0;
}

6290 6291 6292
/**
 * virDomainGetSchedulerType:
 * @domain: pointer to domain object
6293 6294
 * @nparams: pointer to number of scheduler parameters, can be NULL
 *           (return value)
6295
 *
6296
 * Get the scheduler type and the number of scheduler parameters.
6297 6298 6299 6300 6301 6302 6303 6304
 *
 * Returns NULL in case of error. The caller must free the returned string.
 */
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
{
    virConnectPtr conn;
    char *schedtype;
6305 6306

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

6308 6309
    virResetLastError();

6310
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6311
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6312
        virDispatchError(NULL);
6313 6314 6315 6316 6317 6318
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
6319 6320
        if (!schedtype)
            goto error;
6321 6322 6323
        return schedtype;
    }

6324
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6325 6326

error:
6327
    virDispatchError(domain->conn);
6328 6329 6330 6331 6332 6333 6334
    return NULL;
}


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
6335
 * @params: pointer to scheduler parameter objects
6336
 *          (return value)
6337 6338
 * @nparams: pointer to number of scheduler parameter objects
 *          (this value must be at least as large as the returned value
6339 6340
 *           nparams of virDomainGetSchedulerType)
 *
6341 6342
 * 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
6343 6344 6345
 * @params.  It is hypervisor specific whether this returns the live or
 * persistent state; for more control, use
 * virDomainGetSchedulerParametersFlags.
6346 6347 6348 6349 6350
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
6351
                                virTypedParameterPtr params, int *nparams)
6352 6353
{
    virConnectPtr conn;
6354 6355

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

6357 6358
    virResetLastError();

6359
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6360
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6361
        virDispatchError(NULL);
6362 6363
        return -1;
    }
6364 6365 6366 6367 6368 6369

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

6370 6371
    conn = domain->conn;

6372 6373 6374 6375 6376 6377 6378
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
6379

6380
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6381 6382

error:
6383
    virDispatchError(domain->conn);
6384 6385 6386
    return -1;
}

6387 6388 6389 6390 6391 6392 6393 6394
/**
 * 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)
6395
 * @flags: one of virDomainModificationImpact
6396 6397 6398 6399
 *
 * Get the scheduler parameters, the @params array will be filled with the
 * values.
 *
6400 6401
 * The value of @flags can be exactly VIR_DOMAIN_AFFECT_CURRENT,
 * VIR_DOMAIN_AFFECT_LIVE, or VIR_DOMAIN_AFFECT_CONFIG.
6402 6403 6404 6405 6406 6407 6408 6409 6410 6411
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParametersFlags(virDomainPtr domain,
                                     virTypedParameterPtr params, int *nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

6412
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%p, flags=%x",
6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445
                     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;
}

6446 6447 6448 6449
/**
 * virDomainSetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
6450 6451
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
6452 6453
 *           nparams of virDomainGetSchedulerType)
 *
6454 6455 6456 6457
 * 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.
6458 6459 6460 6461
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
6462
virDomainSetSchedulerParameters(virDomainPtr domain,
6463
                                virTypedParameterPtr params, int nparams)
6464 6465
{
    virConnectPtr conn;
6466 6467

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

6469 6470
    virResetLastError();

6471
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6472
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6473
        virDispatchError(NULL);
6474 6475
        return -1;
    }
6476 6477 6478 6479 6480 6481

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

6482
    if (domain->conn->flags & VIR_CONNECT_RO) {
6483
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6484
        goto error;
6485
    }
6486 6487
    conn = domain->conn;

6488 6489 6490 6491 6492 6493 6494
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
6495

6496
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507

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


/**
 * virDomainSetSchedulerParametersFlags:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
6508 6509
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
6510
 *           nparams of virDomainGetSchedulerType)
6511
 * @flags: bitwise-OR of virDomainModificationImpact
6512
 *
6513
 * Change a subset or all scheduler parameters.  The value of @flags
6514 6515 6516
 * 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
6517
 * flags are supported.
6518 6519 6520 6521 6522
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetSchedulerParametersFlags(virDomainPtr domain,
6523
                                     virTypedParameterPtr params,
6524 6525 6526 6527 6528
                                     int nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

6529
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
6530 6531 6532 6533 6534 6535 6536 6537 6538
                     params, nparams, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
6539 6540 6541 6542 6543 6544

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

6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562
    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__);
6563 6564

error:
6565
    virDispatchError(domain->conn);
6566 6567 6568 6569
    return -1;
}


6570
/**
6571
 * virDomainBlockStats:
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 6597 6598
 * @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 };
6599 6600

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

6602 6603
    virResetLastError();

6604
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6605
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6606
        virDispatchError(NULL);
6607 6608
        return -1;
    }
6609
    if (!path || !stats || size > sizeof stats2) {
6610
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6611 6612
        goto error;
    }
6613 6614 6615 6616
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
6617
            goto error;
6618 6619 6620 6621 6622

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

6623
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6624 6625

error:
6626
    virDispatchError(dom->conn);
6627 6628 6629
    return -1;
}

O
Osier Yang 已提交
6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 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 6698 6699 6700
/**
 * virDomainBlockStatsFlags:
 * @dom: pointer to domain object
 * @path: path to the block device
 * @params: pointer to block stats parameter object
 *          (return value)
 * @nparams: pointer to number of block stats
 * @flags: unused, always passes 0
 *
 * This function is to get block stats parameters for block
 * devices attached to the domain.
 *
 * The @path 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.
 *
 * The @params array will be filled with the value 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. (Note that block device of different type
 * might support different parameters numbers, so it might be necessary to compute
 * @nparams for each block device type). The caller should then allocate @params
 * array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
 * again. See virDomainGetMemoryParameters for more details.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virDomainBlockStatsFlags (virDomainPtr dom,
                              const char *path,
                              virTypedParameterPtr params,
                              int *nparams,
                              unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "path=%s, params=%p, nparams=%d, flags=%x",
                     path, params, nparams ? *nparams : -1, flags);

    virResetLastError();

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

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

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


6701
/**
6702
 * virDomainInterfaceStats:
6703 6704 6705 6706 6707 6708 6709 6710 6711 6712
 * @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 已提交
6713
 * Domains may have more than one network interface.  To get stats for
6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728
 * 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 };
6729 6730 6731

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

6733 6734
    virResetLastError();

6735
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6736
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6737
        virDispatchError(NULL);
6738 6739
        return -1;
    }
6740
    if (!path || !stats || size > sizeof stats2) {
6741
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6742 6743
        goto error;
    }
6744 6745 6746 6747
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
6748
            goto error;
6749 6750 6751 6752 6753

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

6754
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6755 6756

error:
6757
    virDispatchError(dom->conn);
6758 6759 6760
    return -1;
}

6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787
/**
 * 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).
6788 6789
 * VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON:
 *     Current balloon value (in kb).
6790 6791 6792 6793 6794 6795 6796 6797
 *
 * 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;
6798

E
Eric Blake 已提交
6799 6800
    VIR_DOMAIN_DEBUG(dom, "stats=%p, nr_stats=%u, flags=%x",
                     stats, nr_stats, flags);
6801 6802 6803 6804

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6805
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6806
        virDispatchError(NULL);
6807 6808
        return -1;
    }
6809

6810 6811 6812 6813 6814 6815 6816 6817
    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) {
6818 6819
        nr_stats_ret = conn->driver->domainMemoryStats (dom, stats, nr_stats,
                                                        flags);
6820 6821 6822 6823 6824
        if (nr_stats_ret == -1)
            goto error;
        return nr_stats_ret;
    }

6825
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6826 6827

error:
6828
    virDispatchError(dom->conn);
6829 6830 6831
    return -1;
}

R
Richard W.M. Jones 已提交
6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864
/**
 * 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 已提交
6865 6866 6867 6868
 * 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 已提交
6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879
 * 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;
6880

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

6884 6885
    virResetLastError();

R
Richard W.M. Jones 已提交
6886
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6887
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6888
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
6889 6890 6891
        return -1;
    }
    conn = dom->conn;
6892

6893
    if (dom->conn->flags & VIR_CONNECT_RO) {
6894
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6895
        goto error;
6896 6897
    }

R
Richard W.M. Jones 已提交
6898
    if (!path) {
6899
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
6900
                           _("path is NULL"));
6901
        goto error;
R
Richard W.M. Jones 已提交
6902 6903 6904 6905
    }

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

6911 6912 6913 6914 6915 6916 6917 6918
    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 已提交
6919

6920
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6921 6922

error:
6923
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
6924 6925
    return -1;
}
6926

R
Richard W.M. Jones 已提交
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
/**
 * 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;
6966

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

6970 6971
    virResetLastError();

R
Richard W.M. Jones 已提交
6972
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6973
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6974
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
6975 6976 6977 6978
        return -1;
    }
    conn = dom->conn;

6979
    if (dom->conn->flags & VIR_CONNECT_RO) {
6980
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6981
        goto error;
6982 6983
    }

6984
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
6985 6986 6987 6988 6989 6990
     * 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.
     *
6991
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
6992 6993 6994
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
6995 6996 6997
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
6998 6999 7000 7001 7002 7003 7004 7005
     * 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.
     */
7006

7007 7008
    /* Exactly one of these two flags must be set.  */
    if (!(flags & VIR_MEMORY_VIRTUAL) == !(flags & VIR_MEMORY_PHYSICAL)) {
7009
        virLibDomainError(VIR_ERR_INVALID_ARG,
7010
                     _("flags parameter must include VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
7011
        goto error;
R
Richard W.M. Jones 已提交
7012 7013 7014 7015
    }

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

7021 7022 7023 7024 7025 7026 7027 7028
    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 已提交
7029

7030
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7031 7032

error:
7033
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
7034 7035 7036
    return -1;
}

7037

7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052
/**
 * 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;
7053

E
Eric Blake 已提交
7054
    VIR_DOMAIN_DEBUG(domain, "info=%p, flags=%x", info, flags);
7055 7056 7057 7058

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7059
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7060
        virDispatchError(NULL);
7061
        return -1;
7062
    }
7063
    if (path == NULL || info == NULL) {
7064
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079
        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;
    }

7080
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7081 7082 7083 7084 7085 7086 7087

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


7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098
/************************************************************************
 *									*
 *		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
 *
7099 7100
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
7101 7102
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
7103 7104 7105 7106 7107
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
7108
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
7109

7110 7111
    virResetLastError();

7112
    if (!VIR_IS_CONNECT(conn)) {
7113
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7114
        virDispatchError(NULL);
7115
        return NULL;
7116
    }
7117
    if (conn->flags & VIR_CONNECT_RO) {
7118
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7119
        goto error;
7120
    }
7121
    if (xml == NULL) {
7122
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7123
        goto error;
7124 7125
    }

7126 7127 7128 7129 7130 7131 7132
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
7133

7134
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7135 7136

error:
7137
    virDispatchError(conn);
7138
    return NULL;
7139 7140 7141 7142 7143 7144
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
O
Osier Yang 已提交
7145 7146 7147 7148 7149
 * 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
7150 7151 7152
 * virDomainHasManagedSaveImage()), or if it is inactive and has any
 * snapshot metadata (see virDomainSnapshotNum()), then the undefine will
 * fail. See virDomainUndefineFlags() for more control.
7153 7154 7155 7156 7157
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
7158
    virConnectPtr conn;
7159

7160
    VIR_DOMAIN_DEBUG(domain);
7161

7162 7163
    virResetLastError();

7164
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7165
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7166
        virDispatchError(NULL);
7167
        return -1;
7168
    }
7169 7170
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7171
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7172
        goto error;
7173 7174
    }

7175 7176 7177 7178 7179 7180 7181
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
7182

7183
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7184 7185

error:
7186
    virDispatchError(domain->conn);
7187
    return -1;
7188 7189
}

O
Osier Yang 已提交
7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202
/**
 * 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.
 *
7203 7204 7205 7206 7207 7208 7209 7210 7211
 * If the domain is inactive and has any snapshot metadata (see
 * virDomainSnapshotNum()), then including
 * VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA in @flags will also remove
 * that metadata.  Omitting the flag will cause the undefine of an
 * inactive domain to fail.  Active snapshots will retain snapshot
 * metadata until the (now-transient) domain halts, regardless of
 * whether this flag is present.  On hypervisors where snapshots do
 * not use libvirt metadata, this flag has no effect.
 *
O
Osier Yang 已提交
7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250
 * 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;
}


7251 7252 7253 7254
/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
7255
 * Provides the number of defined but inactive domains.
7256 7257 7258 7259 7260 7261
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
7262
    VIR_DEBUG("conn=%p", conn);
7263

7264 7265
    virResetLastError();

7266
    if (!VIR_IS_CONNECT(conn)) {
7267
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7268
        virDispatchError(NULL);
7269
        return -1;
7270 7271
    }

7272 7273 7274 7275 7276 7277 7278
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7279

7280
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7281 7282

error:
7283
    virDispatchError(conn);
7284
    return -1;
7285 7286 7287 7288 7289 7290 7291 7292
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
7293 7294
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
7295
 *
7296 7297 7298
 * Returns the number of names provided in the array or -1 in case of error
 */
int
7299
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
7300
                             int maxnames) {
7301
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7302

7303 7304
    virResetLastError();

7305
    if (!VIR_IS_CONNECT(conn)) {
7306
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7307
        virDispatchError(NULL);
7308
        return -1;
7309 7310
    }

7311
    if ((names == NULL) || (maxnames < 0)) {
7312
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7313
        goto error;
7314 7315
    }

7316 7317 7318 7319 7320 7321 7322
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7323

7324
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7325 7326

error:
7327
    virDispatchError(conn);
7328
    return -1;
7329 7330 7331 7332 7333 7334
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
7335
 * Launch a defined domain. If the call succeeds the domain moves from the
7336 7337 7338
 * 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().
7339 7340 7341 7342 7343
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
7344
    virConnectPtr conn;
7345

7346
    VIR_DOMAIN_DEBUG(domain);
7347

7348 7349
    virResetLastError();

7350
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7351
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7352
        virDispatchError(NULL);
7353
        return -1;
7354
    }
7355 7356
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7357
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7358
        goto error;
7359
    }
7360

7361 7362 7363 7364 7365 7366 7367
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
7368

7369
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7370 7371

error:
7372
    virDispatchError(domain->conn);
7373
    return -1;
7374 7375
}

7376 7377 7378 7379 7380 7381 7382 7383
/**
 * 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.
 *
7384 7385 7386 7387 7388 7389
 * 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.
7390 7391 7392 7393
 *
 * 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 已提交
7394
 * client application crashes / loses its connection to the
7395
 * libvirtd daemon. Any domains marked for auto destroy will
7396
 * block attempts at migration, save-to-file, or snapshots.
7397
 *
7398 7399 7400 7401 7402 7403
 * 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.
 *
7404 7405 7406
 * 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.
 *
7407 7408 7409 7410 7411
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) {
    virConnectPtr conn;
7412

7413
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
7414 7415 7416 7417

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7418
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7419
        virDispatchError(NULL);
7420
        return -1;
7421 7422 7423
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7424
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435
        goto error;
    }

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

7436
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7437 7438 7439 7440 7441 7442

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

7443 7444 7445
/**
 * virDomainGetAutostart:
 * @domain: a domain object
7446
 * @autostart: the value returned
7447
 *
7448
 * Provides a boolean value indicating whether the domain
7449 7450 7451 7452 7453 7454 7455
 * 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,
7456 7457 7458
                      int *autostart)
{
    virConnectPtr conn;
7459 7460

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

7462 7463 7464
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7465
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7466
        virDispatchError(NULL);
7467
        return -1;
7468 7469
    }
    if (!autostart) {
7470
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7471
        goto error;
7472 7473
    }

7474 7475
    conn = domain->conn;

7476 7477 7478 7479 7480 7481 7482
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7483

7484
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7485 7486

error:
7487
    virDispatchError(domain->conn);
7488
    return -1;
7489 7490 7491 7492 7493
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
7494
 * @autostart: whether the domain should be automatically started 0 or 1
7495 7496 7497 7498 7499 7500 7501 7502
 *
 * 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,
7503 7504 7505
                      int autostart)
{
    virConnectPtr conn;
7506 7507

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

7509 7510 7511
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7512
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7513
        virDispatchError(NULL);
7514
        return -1;
7515 7516
    }

7517 7518
    conn = domain->conn;

7519
    if (domain->conn->flags & VIR_CONNECT_RO) {
7520
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7521
        goto error;
7522 7523
    }

7524 7525 7526 7527 7528 7529 7530
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7531

7532
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7533 7534

error:
7535
    virDispatchError(domain->conn);
7536
    return -1;
7537 7538
}

7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551
/**
 * 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;
7552
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582

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

7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600
/**
 * 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,
7601
                     int nkeycodes,
7602 7603 7604
                     unsigned int flags)
{
    virConnectPtr conn;
7605
    VIR_DOMAIN_DEBUG(domain, "codeset=%u, holdtime=%u, nkeycodes=%u, flags=%x",
7606 7607 7608 7609 7610
                     codeset, holdtime, nkeycodes, flags);

    virResetLastError();

    if (keycodes == NULL ||
7611
        nkeycodes <= 0 || nkeycodes > VIR_DOMAIN_SEND_KEY_MAX_KEYS) {
7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644
        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;
}

7645 7646 7647 7648 7649 7650 7651 7652
/**
 * 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.
7653
 * This function may require privileged access to the hypervisor.
7654
 *
7655
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
7656 7657 7658
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
7659
 *
7660 7661 7662 7663 7664 7665
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
7666
    virConnectPtr conn;
7667 7668

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

7670 7671
    virResetLastError();

7672
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7673
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7674
        virDispatchError(NULL);
7675
        return -1;
7676
    }
7677
    if (domain->conn->flags & VIR_CONNECT_RO) {
7678
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7679
        goto error;
7680
    }
7681

7682
    if (nvcpus < 1) {
7683
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7684
        goto error;
7685
    }
7686
    conn = domain->conn;
7687

7688 7689 7690 7691 7692 7693 7694
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
7695

7696
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7697 7698

error:
7699
    virDispatchError(domain->conn);
7700
    return -1;
7701 7702
}

E
Eric Blake 已提交
7703 7704 7705 7706 7707 7708 7709 7710 7711
/**
 * 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.
7712
 * This function may require privileged access to the hypervisor.
E
Eric Blake 已提交
7713
 *
7714
 * @flags may include VIR_DOMAIN_AFFECT_LIVE to affect a running
E
Eric Blake 已提交
7715
 * domain (which may fail if domain is not active), or
7716
 * VIR_DOMAIN_AFFECT_CONFIG to affect the next boot via the XML
E
Eric Blake 已提交
7717
 * description of the domain.  Both flags may be set.
7718 7719 7720 7721
 * 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 已提交
7722 7723
 *
 * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then
7724
 * VIR_DOMAIN_AFFECT_LIVE must be clear, and only the maximum virtual
E
Eric Blake 已提交
7725 7726 7727 7728
 * 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.
7729
 * Not all hypervisors can support all flag combinations.
E
Eric Blake 已提交
7730 7731 7732 7733 7734 7735 7736 7737 7738
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

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

7740
    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u, flags=%x", nvcpus, flags);
E
Eric Blake 已提交
7741 7742 7743 7744

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7745
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
7746
        virDispatchError(NULL);
7747
        return -1;
E
Eric Blake 已提交
7748 7749
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
7750
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
7751 7752 7753 7754
        goto error;
    }

    /* Perform some argument validation common to all implementations.  */
7755
    if (nvcpus < 1 || (unsigned short) nvcpus != nvcpus) {
7756
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768
        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;
    }

7769
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782

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
7783
 * not support it.  This function may require privileged access to the
E
Eric Blake 已提交
7784 7785
 * hypervisor.
 *
7786 7787 7788 7789 7790 7791 7792
 * 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 已提交
7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804
 *
 * 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;
7805

7806
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
E
Eric Blake 已提交
7807 7808 7809 7810

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7811
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
7812
        virDispatchError(NULL);
7813
        return -1;
E
Eric Blake 已提交
7814 7815
    }

7816 7817
    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) && (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
7818
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830
        goto error;
    }
    conn = domain->conn;

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

7831
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
7832 7833 7834 7835 7836 7837

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

7838 7839 7840 7841 7842
/**
 * 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 已提交
7843 7844 7845
 *      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.
7846 7847 7848 7849
 * @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.
7850
 *
7851
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
7852
 * This function may require privileged access to the hypervisor.
7853
 *
7854 7855 7856
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
7857 7858 7859 7860 7861 7862
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
7863
    virConnectPtr conn;
7864 7865 7866

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

7868 7869
    virResetLastError();

7870
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7871
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7872
        virDispatchError(NULL);
7873
        return -1;
7874
    }
7875
    if (domain->conn->flags & VIR_CONNECT_RO) {
7876
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7877
        goto error;
7878
    }
7879

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

7885 7886
    conn = domain->conn;

7887 7888 7889 7890 7891 7892 7893
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
7894

7895
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7896 7897

error:
7898
    virDispatchError(domain->conn);
7899
    return -1;
7900 7901
}

7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916
/**
 * 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.
7917
 * This function may require privileged access to the hypervisor.
7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929
 *
 * @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 已提交
7930
 * See also virDomainGetVcpuPinInfo for querying this information.
7931
 *
7932 7933 7934 7935 7936 7937 7938 7939 7940
 * 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;

7941
    VIR_DOMAIN_DEBUG(domain, "vcpu=%u, cpumap=%p, maplen=%d, flags=%x",
7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979
                     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;

}

7980
/**
E
Eric Blake 已提交
7981
 * virDomainGetVcpuPinInfo:
7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004
 * @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 已提交
8005
virDomainGetVcpuPinInfo (virDomainPtr domain, int ncpumaps,
8006 8007 8008 8009
                         unsigned char *cpumaps, int maplen, unsigned int flags)
{
    virConnectPtr conn;

8010
    VIR_DOMAIN_DEBUG(domain, "ncpumaps=%d, cpumaps=%p, maplen=%d, flags=%x",
8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028
                     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 已提交
8029
    if (conn->driver->domainGetVcpuPinInfo) {
8030
        int ret;
E
Eric Blake 已提交
8031
        ret = conn->driver->domainGetVcpuPinInfo (domain, ncpumaps,
8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044
                                                  cpumaps, maplen, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

8045 8046 8047 8048 8049
/**
 * 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 已提交
8050
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
8051
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
8052
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
8053 8054 8055 8056 8057 8058 8059
 *	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...).
8060
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
8061
 *
8062
 * Extract information about virtual CPUs of domain, store it in info array
8063 8064 8065
 * and also in cpumaps if this pointer isn't NULL.  This call may fail
 * on an inactive domain.
 *
E
Eric Blake 已提交
8066
 * See also virDomainGetVcpuPinInfo for querying just cpumaps, including on
8067
 * an inactive domain.
8068 8069 8070 8071 8072
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
8073
                  unsigned char *cpumaps, int maplen)
8074
{
8075
    virConnectPtr conn;
8076 8077 8078

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

8080 8081
    virResetLastError();

8082
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8083
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8084
        virDispatchError(NULL);
8085
        return -1;
8086 8087
    }
    if ((info == NULL) || (maxinfo < 1)) {
8088
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8089
        goto error;
8090
    }
8091 8092 8093

    /* Ensure that domainGetVcpus (aka remoteDomainGetVcpus) does not
       try to memcpy anything into a NULL pointer.  */
8094 8095
    if (!cpumaps ? maplen != 0
        : (maplen <= 0 || INT_MULTIPLY_OVERFLOW(maxinfo, maplen))) {
8096
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8097
        goto error;
8098
    }
8099

8100 8101
    conn = domain->conn;

8102 8103 8104 8105 8106 8107 8108 8109
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
8110

8111
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8112 8113

error:
8114
    virDispatchError(domain->conn);
8115
    return -1;
8116
}
8117

8118 8119 8120
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
8121
 *
8122 8123
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
8124
 * the same as virConnectGetMaxVcpus(). If the guest is running
8125
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
8126
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
8127 8128 8129 8130
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
8131 8132
virDomainGetMaxVcpus(virDomainPtr domain)
{
8133
    virConnectPtr conn;
8134

8135
    VIR_DOMAIN_DEBUG(domain);
8136

8137 8138
    virResetLastError();

8139
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8140
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8141
        virDispatchError(NULL);
8142
        return -1;
8143 8144 8145 8146
    }

    conn = domain->conn;

8147 8148 8149 8150 8151 8152 8153
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
8154

8155
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8156 8157

error:
8158
    virDispatchError(domain->conn);
8159
    return -1;
8160 8161
}

8162 8163 8164 8165 8166
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
8167 8168 8169
 * 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.
8170
 *
8171
 * Returns 0 in case of success, -1 in case of failure
8172 8173 8174 8175 8176 8177
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

8178 8179
    VIR_DOMAIN_DEBUG(domain, "seclabel=%p", seclabel);

8180
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8181
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8182
        virDispatchError(NULL);
8183 8184 8185 8186
        return -1;
    }

    if (seclabel == NULL) {
8187
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8188
        goto error;
8189 8190 8191 8192
    }

    conn = domain->conn;

8193 8194 8195 8196 8197 8198 8199 8200
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

8201
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8202

8203
error:
8204
    virDispatchError(domain->conn);
8205
    return -1;
8206 8207 8208 8209 8210 8211 8212
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
8213 8214 8215
 * 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.
8216
 *
8217
 * Returns 0 in case of success, -1 in case of failure
8218 8219 8220 8221
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
8222
    VIR_DEBUG("conn=%p secmodel=%p", conn, secmodel);
8223

8224
    if (!VIR_IS_CONNECT(conn)) {
8225
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8226
        virDispatchError(NULL);
8227 8228 8229 8230
        return -1;
    }

    if (secmodel == NULL) {
8231
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8232 8233 8234 8235 8236 8237 8238 8239 8240
        goto error;
    }

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

8243
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8244

8245
error:
8246
    virDispatchError(conn);
8247
    return -1;
8248
}
8249

8250 8251 8252 8253
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
8254
 *
8255 8256
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
8257
 *
8258 8259 8260 8261
 * 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.
 *
8262 8263 8264
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8265
virDomainAttachDevice(virDomainPtr domain, const char *xml)
8266 8267
{
    virConnectPtr conn;
8268 8269

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

8271 8272
    virResetLastError();

8273
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8274
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8275
        virDispatchError(NULL);
8276
        return -1;
8277
    }
8278 8279 8280 8281 8282 8283

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

8284
    if (domain->conn->flags & VIR_CONNECT_RO) {
8285
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8286
        goto error;
8287 8288 8289
    }
    conn = domain->conn;

8290
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
8291 8292 8293 8294 8295 8296 8297
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

8298
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311

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
8312
 * to control how the device is attached.  VIR_DOMAIN_AFFECT_CURRENT
J
Jim Fehlig 已提交
8313
 * specifies that the device allocation is made based on current domain
8314
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
J
Jim Fehlig 已提交
8315
 * allocated to the active domain instance only and is not added to the
8316
 * persisted domain configuration.  VIR_DOMAIN_AFFECT_CONFIG
J
Jim Fehlig 已提交
8317 8318 8319 8320 8321 8322
 * 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.
 *
8323 8324 8325 8326
 * 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 已提交
8327 8328 8329 8330 8331 8332 8333
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
8334

8335
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
J
Jim Fehlig 已提交
8336 8337 8338 8339

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8340
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8341
        virDispatchError(NULL);
8342
        return -1;
J
Jim Fehlig 已提交
8343
    }
8344 8345 8346 8347 8348 8349

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

J
Jim Fehlig 已提交
8350
    if (domain->conn->flags & VIR_CONNECT_RO) {
8351
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
8352 8353 8354 8355 8356
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
8357
        int ret;
J
Jim Fehlig 已提交
8358
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
8359 8360 8361 8362
        if (ret < 0)
            goto error;
        return ret;
    }
8363

8364
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8365 8366

error:
8367
    virDispatchError(domain->conn);
8368
    return -1;
8369 8370 8371 8372 8373 8374
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
8375
 *
8376 8377
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
8378 8379 8380 8381
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8382
virDomainDetachDevice(virDomainPtr domain, const char *xml)
8383 8384
{
    virConnectPtr conn;
8385 8386

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

8388 8389
    virResetLastError();

8390
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8391
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8392
        virDispatchError(NULL);
8393
        return -1;
8394
    }
8395 8396 8397 8398 8399 8400

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

8401
    if (domain->conn->flags & VIR_CONNECT_RO) {
8402
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8403
        goto error;
8404 8405 8406
    }
    conn = domain->conn;

8407 8408 8409
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
8410 8411 8412 8413 8414
         if (ret < 0)
             goto error;
         return ret;
     }

8415
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428

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
8429
 * to control how the device is detached.  VIR_DOMAIN_AFFECT_CURRENT
J
Jim Fehlig 已提交
8430
 * specifies that the device allocation is removed based on current domain
8431
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
J
Jim Fehlig 已提交
8432
 * deallocated from the active domain instance only and is not from the
8433
 * persisted domain configuration.  VIR_DOMAIN_AFFECT_CONFIG
J
Jim Fehlig 已提交
8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446
 * 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;
8447

8448
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
J
Jim Fehlig 已提交
8449 8450 8451 8452

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8453
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8454
        virDispatchError(NULL);
8455
        return -1;
J
Jim Fehlig 已提交
8456
    }
8457 8458 8459 8460 8461 8462

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

J
Jim Fehlig 已提交
8463
    if (domain->conn->flags & VIR_CONNECT_RO) {
8464
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
8465 8466 8467 8468 8469 8470 8471
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
8472 8473 8474 8475 8476
        if (ret < 0)
            goto error;
        return ret;
    }

8477
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490

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
8491
 * to control how the device is changed.  VIR_DOMAIN_AFFECT_CURRENT
8492
 * specifies that the device change is made based on current domain
8493
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
8494
 * changed on the active domain instance only and is not added to the
8495
 * persisted domain configuration. VIR_DOMAIN_AFFECT_CONFIG
8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512
 * 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;
8513

8514
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
8515 8516 8517 8518

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8519
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8520
        virDispatchError(NULL);
8521
        return -1;
8522
    }
8523 8524 8525 8526 8527 8528

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

8529
    if (domain->conn->flags & VIR_CONNECT_RO) {
8530
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8531 8532 8533 8534 8535 8536 8537
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
8538 8539 8540 8541
        if (ret < 0)
            goto error;
        return ret;
    }
8542

8543
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8544 8545

error:
8546
    virDispatchError(domain->conn);
8547
    return -1;
8548
}
8549

8550 8551 8552 8553 8554 8555 8556 8557 8558 8559
/**
 * 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
8560
 * with the amount of free memory in bytes for each cell requested,
8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571
 * 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)
{
8572
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
8573 8574
          conn, freeMems, startCell, maxCells);

8575 8576
    virResetLastError();

8577
    if (!VIR_IS_CONNECT(conn)) {
8578
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8579
        virDispatchError(NULL);
8580
        return -1;
8581 8582
    }

D
Daniel Veillard 已提交
8583
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
8584
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8585
        goto error;
8586 8587
    }

8588 8589 8590 8591 8592 8593 8594
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
8595

8596
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8597 8598

error:
8599
    virDispatchError(conn);
8600 8601 8602
    return -1;
}

8603 8604 8605 8606
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
8607
 * Provides the connection pointer associated with a network.  The
8608 8609 8610
 * reference counter on the connection is not increased by this
 * call.
 *
8611 8612 8613 8614
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
8615 8616 8617 8618 8619
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
8620
    VIR_DEBUG("net=%p", net);
8621

8622 8623 8624
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
8625
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8626
        virDispatchError(NULL);
8627 8628 8629 8630 8631
        return NULL;
    }
    return net->conn;
}

8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642
/**
 * 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)
{
8643
    VIR_DEBUG("conn=%p", conn);
8644

8645 8646
    virResetLastError();

8647
    if (!VIR_IS_CONNECT(conn)) {
8648
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8649
        virDispatchError(NULL);
8650
        return -1;
8651 8652
    }

8653 8654 8655 8656 8657 8658 8659
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8660

8661
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8662 8663

error:
8664
    virDispatchError(conn);
8665
    return -1;
8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678
}

/**
 * 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
8679
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
8680
{
8681
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8682

8683 8684
    virResetLastError();

8685
    if (!VIR_IS_CONNECT(conn)) {
8686
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8687
        virDispatchError(NULL);
8688
        return -1;
8689 8690
    }

8691
    if ((names == NULL) || (maxnames < 0)) {
8692
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8693
        goto error;
8694 8695
    }

8696 8697 8698 8699 8700 8701 8702
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8703

8704
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8705 8706

error:
8707
    virDispatchError(conn);
8708
    return -1;
8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721
}

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

8724 8725
    virResetLastError();

8726
    if (!VIR_IS_CONNECT(conn)) {
8727
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8728
        virDispatchError(NULL);
8729
        return -1;
8730 8731
    }

8732 8733 8734 8735 8736 8737 8738
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8739

8740
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8741 8742

error:
8743
    virDispatchError(conn);
8744
    return -1;
8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757
}

/**
 * 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
8758
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
8759 8760
                              int maxnames)
{
8761
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8762

8763 8764
    virResetLastError();

8765
    if (!VIR_IS_CONNECT(conn)) {
8766
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8767
        virDispatchError(NULL);
8768
        return -1;
8769 8770
    }

8771
    if ((names == NULL) || (maxnames < 0)) {
8772
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8773
        goto error;
8774 8775
    }

8776 8777 8778 8779 8780 8781 8782 8783
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8784

8785
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8786 8787

error:
8788
    virDispatchError(conn);
8789
    return -1;
8790 8791 8792 8793 8794 8795 8796 8797 8798
}

/**
 * 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.
 *
8799 8800
 * 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.
8801 8802 8803 8804
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
8805
    VIR_DEBUG("conn=%p, name=%s", conn, name);
8806

8807 8808
    virResetLastError();

8809
    if (!VIR_IS_CONNECT(conn)) {
8810
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8811
        virDispatchError(NULL);
8812
        return NULL;
8813 8814
    }
    if (name == NULL) {
8815
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8816
        goto  error;
8817 8818
    }

8819 8820 8821 8822 8823 8824 8825
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8826

8827
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8828 8829

error:
8830
    virDispatchError(conn);
8831
    return NULL;
8832 8833 8834 8835 8836 8837 8838 8839 8840
}

/**
 * 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.
 *
8841 8842
 * 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.
8843 8844 8845 8846
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
8847
    VIR_UUID_DEBUG(conn, uuid);
8848

8849 8850
    virResetLastError();

8851
    if (!VIR_IS_CONNECT(conn)) {
8852
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8853
        virDispatchError(NULL);
8854
        return NULL;
8855 8856
    }
    if (uuid == NULL) {
8857
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8858
        goto error;
8859 8860
    }

8861 8862 8863 8864 8865 8866 8867
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
8868

8869
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8870 8871

error:
8872
    virDispatchError(conn);
8873
    return NULL;
8874 8875 8876 8877 8878 8879 8880 8881 8882
}

/**
 * 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.
 *
8883 8884
 * 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.
8885 8886 8887 8888 8889
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
8890
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
8891

8892 8893
    virResetLastError();

8894
    if (!VIR_IS_CONNECT(conn)) {
8895
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8896
        virDispatchError(NULL);
8897
        return NULL;
8898 8899
    }
    if (uuidstr == NULL) {
8900
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8901
        goto error;
8902 8903
    }

8904
    if (virUUIDParse(uuidstr, uuid) < 0) {
8905
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8906
        goto error;
8907 8908 8909
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
8910 8911

error:
8912
    virDispatchError(conn);
8913
    return NULL;
8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928
}

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

8931 8932
    virResetLastError();

8933
    if (!VIR_IS_CONNECT(conn)) {
8934
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8935
        virDispatchError(NULL);
8936
        return NULL;
8937 8938
    }
    if (xmlDesc == NULL) {
8939
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8940
        goto error;
8941 8942
    }
    if (conn->flags & VIR_CONNECT_RO) {
8943
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8944
        goto error;
8945 8946
    }

8947 8948 8949 8950 8951 8952 8953
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
8954

8955
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8956 8957

error:
8958
    virDispatchError(conn);
8959
    return NULL;
8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971
}

/**
 * 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
8972 8973
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
8974
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
8975

8976 8977
    virResetLastError();

8978
    if (!VIR_IS_CONNECT(conn)) {
8979
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8980
        virDispatchError(NULL);
8981
        return NULL;
8982 8983
    }
    if (conn->flags & VIR_CONNECT_RO) {
8984
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8985
        goto error;
8986 8987
    }
    if (xml == NULL) {
8988
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8989
        goto error;
8990 8991
    }

8992 8993 8994 8995 8996 8997 8998
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
8999

9000
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9001 9002

error:
9003
    virDispatchError(conn);
9004
    return NULL;
9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017
}

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

9020 9021
    virResetLastError();

9022
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9023
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9024
        virDispatchError(NULL);
9025
        return -1;
9026 9027 9028
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9029
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9030
        goto error;
9031 9032
    }

9033 9034 9035 9036 9037 9038 9039
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
9040

9041
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9042 9043

error:
9044
    virDispatchError(network->conn);
9045
    return -1;
9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057
}

/**
 * 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
9058 9059
virNetworkCreate(virNetworkPtr network)
{
9060
    virConnectPtr conn;
9061
    VIR_DEBUG("network=%p", network);
9062

9063 9064
    virResetLastError();

9065
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9066
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9067
        virDispatchError(NULL);
9068
        return -1;
9069 9070 9071
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9072
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9073
        goto error;
9074 9075
    }

9076 9077 9078 9079 9080 9081 9082
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
9083

9084
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9085 9086

error:
9087
    virDispatchError(network->conn);
9088
    return -1;
9089 9090 9091 9092 9093 9094 9095
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
9096 9097 9098
 * 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
9099 9100 9101 9102 9103 9104 9105
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
9106
    VIR_DEBUG("network=%p", network);
9107

9108 9109
    virResetLastError();

9110
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9111
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9112
        virDispatchError(NULL);
9113
        return -1;
9114 9115 9116 9117
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9118
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9119
        goto error;
9120 9121
    }

9122 9123 9124 9125 9126 9127 9128
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
9129

9130
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9131 9132

error:
9133
    virDispatchError(network->conn);
9134
    return -1;
9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148
}

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

9151 9152 9153
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9154
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9155
        virDispatchError(NULL);
9156
        return -1;
9157
    }
9158 9159
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
9160
        return -1;
9161
    }
9162
    return 0;
9163 9164
}

9165 9166
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
9167
 * @network: the network to hold a reference on
9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178
 *
 * 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 已提交
9179 9180
 *
 * Returns 0 in case of success, -1 in case of failure.
9181 9182 9183 9184 9185
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
9186
        virLibConnError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9187
        virDispatchError(NULL);
9188
        return -1;
9189 9190
    }
    virMutexLock(&network->conn->lock);
9191
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
9192 9193 9194 9195 9196
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208
/**
 * 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)
{
9209
    VIR_DEBUG("network=%p", network);
9210

9211 9212
    virResetLastError();

9213
    if (!VIR_IS_NETWORK(network)) {
9214
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9215
        virDispatchError(NULL);
9216
        return NULL;
9217
    }
9218
    return network->name;
9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232
}

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

9235 9236
    virResetLastError();

9237
    if (!VIR_IS_NETWORK(network)) {
9238
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9239
        virDispatchError(NULL);
9240
        return -1;
9241 9242
    }
    if (uuid == NULL) {
9243
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9244
        goto error;
9245 9246 9247 9248
    }

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

9249
    return 0;
9250 9251

error:
9252
    virDispatchError(network->conn);
9253
    return -1;
9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269
}

/**
 * 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];
9270
    VIR_DEBUG("network=%p, buf=%p", network, buf);
9271

9272 9273
    virResetLastError();

9274
    if (!VIR_IS_NETWORK(network)) {
9275
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9276
        virDispatchError(NULL);
9277
        return -1;
9278 9279
    }
    if (buf == NULL) {
9280
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9281
        goto error;
9282 9283 9284
    }

    if (virNetworkGetUUID(network, &uuid[0]))
9285
        goto error;
9286

9287
    virUUIDFormat(uuid, buf);
9288
    return 0;
9289 9290

error:
9291
    virDispatchError(network->conn);
9292
    return -1;
9293 9294 9295 9296 9297
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
9298
 * @flags: an OR'ed set of extraction flags, not used yet
9299 9300 9301 9302 9303 9304 9305 9306
 *
 * 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 *
9307
virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
9308
{
9309
    virConnectPtr conn;
9310
    VIR_DEBUG("network=%p, flags=%x", network, flags);
9311

9312 9313 9314
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9315
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9316
        virDispatchError(NULL);
9317
        return NULL;
9318 9319
    }

9320 9321
    conn = network->conn;

9322
    if (conn->networkDriver && conn->networkDriver->networkGetXMLDesc) {
9323
        char *ret;
9324
        ret = conn->networkDriver->networkGetXMLDesc(network, flags);
9325 9326 9327 9328
        if (!ret)
            goto error;
        return ret;
    }
9329

9330
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9331 9332

error:
9333
    virDispatchError(network->conn);
9334
    return NULL;
9335
}
9336 9337 9338 9339 9340

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
9341
 * Provides a bridge interface name to which a domain may connect
9342 9343 9344 9345 9346 9347 9348 9349
 * 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)
{
9350
    virConnectPtr conn;
9351
    VIR_DEBUG("network=%p", network);
9352

9353 9354 9355
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9356
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9357
        virDispatchError(NULL);
9358
        return NULL;
9359 9360
    }

9361 9362
    conn = network->conn;

9363 9364 9365 9366 9367 9368 9369
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
9370

9371
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9372 9373

error:
9374
    virDispatchError(network->conn);
9375
    return NULL;
9376
}
9377 9378 9379 9380

/**
 * virNetworkGetAutostart:
 * @network: a network object
9381
 * @autostart: the value returned
9382
 *
9383
 * Provides a boolean value indicating whether the network
9384 9385 9386 9387 9388 9389 9390
 * 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,
9391 9392 9393
                       int *autostart)
{
    virConnectPtr conn;
9394
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
9395

9396 9397 9398
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9399
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9400
        virDispatchError(NULL);
9401
        return -1;
9402 9403
    }
    if (!autostart) {
9404
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9405
        goto error;
9406 9407
    }

9408 9409
    conn = network->conn;

9410 9411 9412 9413 9414 9415 9416
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9417

9418
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9419 9420

error:
9421
    virDispatchError(network->conn);
9422
    return -1;
9423 9424 9425 9426 9427
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
9428
 * @autostart: whether the network should be automatically started 0 or 1
9429 9430 9431 9432 9433 9434 9435 9436
 *
 * 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,
9437 9438 9439
                       int autostart)
{
    virConnectPtr conn;
9440
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
9441

9442 9443 9444
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9445
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9446
        virDispatchError(NULL);
9447
        return -1;
9448 9449
    }

9450
    if (network->conn->flags & VIR_CONNECT_RO) {
9451
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9452
        goto error;
9453 9454
    }

9455 9456
    conn = network->conn;

9457 9458 9459 9460 9461 9462 9463
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9464

9465
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9466 9467

error:
9468
    virDispatchError(network->conn);
9469
    return -1;
9470
}
9471

D
Daniel Veillard 已提交
9472 9473
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
9474
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486
 *
 * 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
9487
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
9488
{
9489
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9490 9491 9492

    virResetLastError();

9493
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
9494
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9495
        virDispatchError(NULL);
D
Daniel Veillard 已提交
9496 9497
        return NULL;
    }
9498
    return iface->conn;
D
Daniel Veillard 已提交
9499 9500 9501 9502 9503 9504
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
9505
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
9506
 *
9507
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
9508 9509 9510 9511
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
9512
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
9513 9514 9515 9516

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9517
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9518
        virDispatchError(NULL);
9519
        return -1;
D
Daniel Veillard 已提交
9520 9521 9522 9523 9524 9525 9526 9527 9528 9529
    }

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

9530
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9531 9532

error:
9533
    virDispatchError(conn);
D
Daniel Veillard 已提交
9534 9535 9536 9537 9538 9539 9540 9541 9542
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
9543 9544
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
9545 9546 9547 9548 9549 9550
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
9551
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
9552 9553 9554 9555

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9556
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9557
        virDispatchError(NULL);
9558
        return -1;
D
Daniel Veillard 已提交
9559 9560 9561
    }

    if ((names == NULL) || (maxnames < 0)) {
9562
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573
        goto error;
    }

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

9574
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9575 9576

error:
9577
    virDispatchError(conn);
D
Daniel Veillard 已提交
9578 9579 9580
    return -1;
}

9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591
/**
 * 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)
{
9592
    VIR_DEBUG("conn=%p", conn);
9593 9594 9595 9596

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9597
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9598
        virDispatchError(NULL);
9599
        return -1;
9600 9601 9602 9603 9604 9605 9606 9607 9608 9609
    }

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

9610
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9611 9612

error:
9613
    virDispatchError(conn);
9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632
    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)
{
9633
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
9634 9635 9636 9637

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9638
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9639
        virDispatchError(NULL);
9640
        return -1;
9641 9642 9643
    }

    if ((names == NULL) || (maxnames < 0)) {
9644
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655
        goto error;
    }

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

9656
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9657 9658

error:
9659
    virDispatchError(conn);
9660 9661 9662
    return -1;
}

D
Daniel Veillard 已提交
9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675
/**
 * 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)
{
9676
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
9677 9678 9679 9680

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9681
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9682
        virDispatchError(NULL);
9683
        return NULL;
D
Daniel Veillard 已提交
9684 9685
    }
    if (name == NULL) {
9686
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697
        goto  error;
    }

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

9698
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9699 9700

error:
9701
    virDispatchError(conn);
D
Daniel Veillard 已提交
9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717
    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)
{
9718
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
9719 9720 9721 9722

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9723
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9724
        virDispatchError(NULL);
9725
        return NULL;
D
Daniel Veillard 已提交
9726 9727
    }
    if (macstr == NULL) {
9728
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739
        goto  error;
    }

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

9740
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9741 9742

error:
9743
    virDispatchError(conn);
D
Daniel Veillard 已提交
9744 9745 9746 9747 9748
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
9749
 * @iface: an interface object
D
Daniel Veillard 已提交
9750 9751 9752 9753 9754 9755 9756
 *
 * 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 *
9757
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
9758
{
9759
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9760 9761 9762

    virResetLastError();

9763
    if (!VIR_IS_INTERFACE(iface)) {
9764
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9765
        virDispatchError(NULL);
9766
        return NULL;
D
Daniel Veillard 已提交
9767
    }
9768
    return iface->name;
D
Daniel Veillard 已提交
9769 9770 9771 9772
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
9773
 * @iface: an interface object
D
Daniel Veillard 已提交
9774
 *
L
Laine Stump 已提交
9775
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
9776 9777 9778 9779 9780 9781 9782
 * 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 *
9783
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
9784
{
9785
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9786 9787 9788

    virResetLastError();

9789
    if (!VIR_IS_INTERFACE(iface)) {
9790
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9791
        virDispatchError(NULL);
9792
        return NULL;
D
Daniel Veillard 已提交
9793
    }
9794
    return iface->mac;
D
Daniel Veillard 已提交
9795 9796 9797 9798
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
9799
 * @iface: an interface object
9800 9801 9802 9803 9804
 * @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 已提交
9805
 *
9806 9807 9808 9809 9810
 * 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 已提交
9811 9812 9813 9814 9815
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
9816
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
9817 9818
{
    virConnectPtr conn;
9819
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
9820 9821 9822

    virResetLastError();

9823
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9824
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9825
        virDispatchError(NULL);
9826
        return NULL;
D
Daniel Veillard 已提交
9827 9828
    }

9829
    conn = iface->conn;
D
Daniel Veillard 已提交
9830 9831 9832

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
9833
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
9834 9835 9836 9837 9838
        if (!ret)
            goto error;
        return ret;
    }

9839
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9840 9841

error:
9842
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
9843 9844 9845 9846 9847 9848 9849 9850 9851
    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
 *
9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863

 * 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 已提交
9864 9865 9866 9867 9868 9869
 *
 * Returns NULL in case of error, a pointer to the interface otherwise
 */
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
9870
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
D
Daniel Veillard 已提交
9871 9872 9873 9874

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9875
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9876
        virDispatchError(NULL);
9877
        return NULL;
D
Daniel Veillard 已提交
9878 9879
    }
    if (conn->flags & VIR_CONNECT_RO) {
9880
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9881 9882 9883
        goto error;
    }
    if (xml == NULL) {
9884
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895
        goto error;
    }

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

9896
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9897 9898

error:
9899
    virDispatchError(conn);
D
Daniel Veillard 已提交
9900 9901 9902 9903 9904
    return NULL;
}

/**
 * virInterfaceUndefine:
9905
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
9906 9907 9908 9909
 *
 * Undefine an interface, ie remove it from the config.
 * This does not free the associated virInterfacePtr object.
 *
9910 9911 9912 9913 9914 9915 9916 9917 9918 9919
 * 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 已提交
9920 9921 9922
 * Returns 0 in case of success, -1 in case of error
 */
int
9923
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
9924
    virConnectPtr conn;
9925
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
9926 9927 9928

    virResetLastError();

9929
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9930
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9931
        virDispatchError(NULL);
9932
        return -1;
D
Daniel Veillard 已提交
9933
    }
9934
    conn = iface->conn;
D
Daniel Veillard 已提交
9935
    if (conn->flags & VIR_CONNECT_RO) {
9936
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9937 9938 9939 9940 9941
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
9942
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
9943 9944 9945 9946 9947
        if (ret < 0)
            goto error;
        return ret;
    }

9948
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9949 9950

error:
9951
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
9952 9953 9954 9955 9956
    return -1;
}

/**
 * virInterfaceCreate:
9957
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
9958 9959
 * @flags: and OR'ed set of extraction flags, not used yet
 *
9960
 * Activate an interface (i.e. call "ifup").
D
Daniel Veillard 已提交
9961
 *
9962 9963 9964 9965 9966
 * 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 已提交
9967 9968 9969
 * Returns 0 in case of success, -1 in case of error
 */
int
9970
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
9971 9972
{
    virConnectPtr conn;
9973
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
9974 9975 9976

    virResetLastError();

9977
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
9978
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9979
        virDispatchError(NULL);
9980
        return -1;
D
Daniel Veillard 已提交
9981
    }
9982
    conn = iface->conn;
D
Daniel Veillard 已提交
9983
    if (conn->flags & VIR_CONNECT_RO) {
9984
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
9985 9986 9987 9988 9989
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
9990
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
9991 9992 9993 9994 9995
        if (ret < 0)
            goto error;
        return ret;
    }

9996
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9997 9998

error:
9999
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
10000 10001 10002 10003 10004
    return -1;
}

/**
 * virInterfaceDestroy:
10005
 * @iface: an interface object
D
Daniel Veillard 已提交
10006 10007 10008 10009 10010 10011
 * @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.
 *
10012 10013 10014 10015 10016 10017 10018

 * 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 已提交
10019 10020 10021
 * Returns 0 in case of success and -1 in case of failure.
 */
int
10022
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
10023 10024
{
    virConnectPtr conn;
10025
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
10026 10027 10028

    virResetLastError();

10029
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10030
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10031
        virDispatchError(NULL);
10032
        return -1;
D
Daniel Veillard 已提交
10033 10034
    }

10035
    conn = iface->conn;
D
Daniel Veillard 已提交
10036
    if (conn->flags & VIR_CONNECT_RO) {
10037
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
10038 10039 10040 10041 10042
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
10043
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
10044 10045 10046 10047 10048
        if (ret < 0)
            goto error;
        return ret;
    }

10049
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10050 10051

error:
10052
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
10053 10054 10055 10056 10057
    return -1;
}

/**
 * virInterfaceRef:
10058
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
10059 10060 10061 10062 10063 10064 10065 10066 10067
 *
 * 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 已提交
10068
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
10069 10070 10071 10072 10073
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
10074
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
10075
{
10076
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
10077
        virLibConnError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10078
        virDispatchError(NULL);
10079
        return -1;
D
Daniel Veillard 已提交
10080
    }
10081
    virMutexLock(&iface->conn->lock);
10082
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
10083 10084
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
10085 10086 10087 10088 10089
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
10090
 * @iface: an interface object
D
Daniel Veillard 已提交
10091 10092 10093 10094 10095 10096 10097
 *
 * 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
10098
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
10099
{
10100
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
10101 10102 10103

    virResetLastError();

10104
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10105
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10106
        virDispatchError(NULL);
10107
        return -1;
D
Daniel Veillard 已提交
10108
    }
10109 10110
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
10111
        return -1;
10112
    }
10113
    return 0;
D
Daniel Veillard 已提交
10114 10115
}

10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135
/**
 * 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)
{
10136
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182

    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)
{
10183
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
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 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229

    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)
{
10230
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260

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

10261 10262 10263

/**
 * virStoragePoolGetConnect:
10264
 * @pool: pointer to a pool
10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278
 *
 * 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)
{
10279
    VIR_DEBUG("pool=%p", pool);
10280

10281 10282 10283
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
10284
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10285
        virDispatchError(NULL);
10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301
        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)
{
10302
    VIR_DEBUG("conn=%p", conn);
10303

10304 10305
    virResetLastError();

10306
    if (!VIR_IS_CONNECT(conn)) {
10307
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10308
        virDispatchError(NULL);
10309
        return -1;
10310 10311
    }

10312 10313 10314 10315 10316 10317 10318
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
10319

10320
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10321 10322

error:
10323
    virDispatchError(conn);
10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343
    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)
{
10344
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
10345

10346 10347
    virResetLastError();

10348
    if (!VIR_IS_CONNECT(conn)) {
10349
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10350
        virDispatchError(NULL);
10351
        return -1;
10352 10353 10354
    }

    if ((names == NULL) || (maxnames < 0)) {
10355
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10356
        goto error;
10357 10358
    }

10359 10360 10361 10362 10363 10364 10365
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
10366

10367
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10368

10369
error:
10370
    virDispatchError(conn);
10371
    return -1;
10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385
}


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

10388 10389
    virResetLastError();

10390
    if (!VIR_IS_CONNECT(conn)) {
10391
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10392
        virDispatchError(NULL);
10393
        return -1;
10394 10395
    }

10396 10397 10398 10399 10400 10401 10402
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
10403

10404
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10405 10406

error:
10407
    virDispatchError(conn);
10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428
    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)
{
10429
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
10430

10431 10432
    virResetLastError();

10433
    if (!VIR_IS_CONNECT(conn)) {
10434
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10435
        virDispatchError(NULL);
10436
        return -1;
10437 10438 10439
    }

    if ((names == NULL) || (maxnames < 0)) {
10440
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10441
        goto error;
10442 10443
    }

10444 10445 10446 10447 10448 10449 10450
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
10451

10452
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10453 10454

error:
10455
    virDispatchError(conn);
10456 10457 10458 10459
    return -1;
}


10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486
/**
 * 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)
{
10487
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%x",
O
Osier Yang 已提交
10488
              conn, NULLSTR(type), NULLSTR(srcSpec), flags);
10489 10490 10491

    virResetLastError();

10492
    if (!VIR_IS_CONNECT(conn)) {
10493
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10494
        virDispatchError(NULL);
10495
        return NULL;
10496 10497
    }
    if (type == NULL) {
10498
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10499
        goto error;
10500 10501
    }

10502
    if (conn->flags & VIR_CONNECT_RO) {
10503
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10504
        goto error;
10505 10506
    }

10507 10508 10509 10510 10511 10512 10513
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
10514

10515
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10516 10517

error:
10518
    virDispatchError(conn);
10519 10520 10521 10522
    return NULL;
}


10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535
/**
 * 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)
{
10536
    VIR_DEBUG("conn=%p, name=%s", conn, name);
10537

10538 10539
    virResetLastError();

10540
    if (!VIR_IS_CONNECT(conn)) {
10541
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10542
        virDispatchError(NULL);
10543
        return NULL;
10544 10545
    }
    if (name == NULL) {
10546
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10547
        goto error;
10548 10549
    }

10550 10551 10552 10553 10554 10555 10556
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
10557

10558
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10559 10560

error:
10561
    virDispatchError(conn);
10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578
    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)
{
10579
    VIR_UUID_DEBUG(conn, uuid);
10580

10581 10582
    virResetLastError();

10583
    if (!VIR_IS_CONNECT(conn)) {
10584
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10585
        virDispatchError(NULL);
10586
        return NULL;
10587 10588
    }
    if (uuid == NULL) {
10589
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10590
        goto error;
10591 10592
    }

10593 10594 10595 10596 10597 10598 10599
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
10600

10601
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10602

10603
error:
10604
    virDispatchError(conn);
10605
    return NULL;
10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619
}


/**
 * 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,
10620
                                 const char *uuidstr)
10621 10622
{
    unsigned char uuid[VIR_UUID_BUFLEN];
10623
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
10624

10625 10626
    virResetLastError();

10627
    if (!VIR_IS_CONNECT(conn)) {
10628
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10629
        virDispatchError(NULL);
10630
        return NULL;
10631 10632
    }
    if (uuidstr == NULL) {
10633
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10634
        goto error;
10635 10636 10637
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
10638
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10639
        goto error;
10640 10641 10642
    }

    return virStoragePoolLookupByUUID(conn, uuid);
10643 10644

error:
10645
    virDispatchError(conn);
10646
    return NULL;
10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660
}


/**
 * 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)
{
10661
    VIR_DEBUG("vol=%p", vol);
10662

10663 10664 10665
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10666
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10667
        virDispatchError(NULL);
10668
        return NULL;
10669 10670
    }

10671 10672 10673 10674 10675 10676 10677
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
10678

10679
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10680

10681
error:
10682
    virDispatchError(vol->conn);
10683
    return NULL;
10684 10685 10686 10687 10688 10689
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
10690
 * @flags: future flags, use 0 for now
10691 10692
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
10693
 * pool is not persistent, so its definition will disappear
10694 10695 10696 10697 10698 10699 10700 10701 10702
 * 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 已提交
10703
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
10704

10705 10706
    virResetLastError();

10707
    if (!VIR_IS_CONNECT(conn)) {
10708
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10709
        virDispatchError(NULL);
10710
        return NULL;
10711 10712
    }
    if (xmlDesc == NULL) {
10713
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10714
        goto error;
10715 10716
    }
    if (conn->flags & VIR_CONNECT_RO) {
10717
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10718
        goto error;
10719 10720
    }

10721 10722 10723 10724 10725 10726 10727
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
10728

10729
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10730 10731

error:
10732
    virDispatchError(conn);
10733 10734 10735 10736 10737 10738 10739
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
10740
 * @flags: future flags, use 0 for now
10741 10742
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
10743
 * pool is persistent, until explicitly undefined.
10744 10745 10746 10747 10748 10749 10750 10751
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
E
Eric Blake 已提交
10752
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
10753

10754 10755
    virResetLastError();

10756
    if (!VIR_IS_CONNECT(conn)) {
10757
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10758
        virDispatchError(NULL);
10759
        return NULL;
10760 10761
    }
    if (conn->flags & VIR_CONNECT_RO) {
10762
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10763
        goto error;
10764 10765
    }
    if (xml == NULL) {
10766
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10767
        goto error;
10768 10769
    }

10770 10771 10772 10773 10774 10775 10776
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
10777

10778
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10779

10780
error:
10781
    virDispatchError(conn);
10782
    return NULL;
10783 10784 10785 10786 10787
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
10788
 * @flags: future flags, use 0 for now
O
Osier Yang 已提交
10789 10790 10791 10792
 * @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.
10793 10794 10795 10796 10797 10798 10799 10800 10801 10802
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
10803
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10804

10805 10806
    virResetLastError();

10807
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10808
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
10809
        virDispatchError(NULL);
10810
        return -1;
10811 10812 10813
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10814
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10815
        goto error;
10816 10817
    }

10818 10819 10820 10821 10822 10823 10824
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10825

10826
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10827

10828
error:
10829
    virDispatchError(pool->conn);
10830
    return -1;
10831 10832 10833 10834 10835 10836 10837 10838 10839
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
10840
 * Returns 0 on success, -1 on failure
10841 10842 10843 10844 10845
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
10846
    VIR_DEBUG("pool=%p", pool);
10847

10848 10849
    virResetLastError();

10850
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10851
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
10852
        virDispatchError(NULL);
10853
        return -1;
10854 10855 10856
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10857
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10858
        goto error;
10859 10860
    }

10861 10862 10863 10864 10865 10866 10867
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
10868

10869
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10870

10871
error:
10872
    virDispatchError(pool->conn);
10873
    return -1;
10874 10875 10876 10877 10878 10879
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
10880
 * @flags: future flags, use 0 for now
10881 10882 10883 10884 10885 10886 10887 10888 10889 10890
 *
 * 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 已提交
10891
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10892

10893 10894
    virResetLastError();

10895
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10896
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10897
        virDispatchError(NULL);
10898
        return -1;
10899 10900 10901
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10902
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10903
        goto error;
10904 10905
    }

10906 10907 10908 10909 10910 10911 10912
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10913

10914
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10915

10916
error:
10917
    virDispatchError(pool->conn);
10918
    return -1;
10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937
}


/**
 * 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;
10938
    VIR_DEBUG("pool=%p", pool);
10939

10940 10941
    virResetLastError();

10942
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10943
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10944
        virDispatchError(NULL);
10945
        return -1;
10946 10947 10948 10949
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10950
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10951
        goto error;
10952 10953
    }

10954 10955 10956 10957 10958 10959 10960
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
10961

10962
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10963 10964

error:
10965
    virDispatchError(pool->conn);
10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984
    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;
10985
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
10986

10987 10988
    virResetLastError();

10989
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
10990
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10991
        virDispatchError(NULL);
10992
        return -1;
10993 10994 10995 10996
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10997
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10998
        goto error;
10999 11000
    }

11001 11002 11003 11004 11005 11006 11007
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11008

11009
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11010 11011

error:
11012
    virDispatchError(pool->conn);
11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028
    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)
{
11029
    VIR_DEBUG("pool=%p", pool);
11030

11031 11032 11033
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11034
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11035
        virDispatchError(NULL);
11036
        return -1;
11037
    }
11038 11039
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
11040
        return -1;
11041
    }
11042
    return 0;
11043 11044 11045 11046

}


11047 11048
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
11049
 * @pool: the pool to hold a reference on
11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060
 *
 * 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 已提交
11061 11062
 *
 * Returns 0 in case of success, -1 in case of failure.
11063 11064 11065 11066 11067
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
11068
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11069
        virDispatchError(NULL);
11070
        return -1;
11071 11072
    }
    virMutexLock(&pool->conn->lock);
11073
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
11074 11075 11076 11077 11078
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

11079 11080 11081 11082 11083 11084 11085 11086 11087
/**
 * 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
 *
11088
 * Returns 0 if the volume list was refreshed, -1 on failure
11089 11090 11091 11092 11093 11094
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
E
Eric Blake 已提交
11095
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11096

11097 11098
    virResetLastError();

11099
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11100
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11101
        virDispatchError(NULL);
11102
        return -1;
11103 11104 11105 11106
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11107
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11108
        goto error;
11109 11110
    }

11111 11112 11113 11114 11115 11116 11117
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11118

11119
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11120 11121

error:
11122
    virDispatchError(pool->conn);
11123 11124 11125 11126 11127 11128 11129 11130 11131 11132
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
11133
 * Returns the name of the pool, or NULL on error
11134 11135 11136 11137
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
11138
    VIR_DEBUG("pool=%p", pool);
11139

11140 11141
    virResetLastError();

11142
    if (!VIR_IS_STORAGE_POOL(pool)) {
11143
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11144
        virDispatchError(NULL);
11145
        return NULL;
11146
    }
11147
    return pool->name;
11148 11149 11150 11151 11152 11153 11154 11155 11156 11157
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
11158
 * Returns 0 on success, or -1 on error;
11159 11160 11161 11162 11163
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
11164
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
11165

11166 11167
    virResetLastError();

11168
    if (!VIR_IS_STORAGE_POOL(pool)) {
11169
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11170
        virDispatchError(NULL);
11171
        return -1;
11172 11173
    }
    if (uuid == NULL) {
11174
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11175
        goto error;
11176 11177 11178 11179
    }

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

11180
    return 0;
11181

11182
error:
11183
    virDispatchError(pool->conn);
11184
    return -1;
11185 11186 11187 11188 11189 11190 11191 11192 11193
}

/**
 * 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
 *
11194
 * Returns 0 on success, or -1 on error;
11195 11196 11197 11198 11199 11200
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
11201
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
11202

11203 11204
    virResetLastError();

11205
    if (!VIR_IS_STORAGE_POOL(pool)) {
11206
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11207
        virDispatchError(NULL);
11208
        return -1;
11209 11210
    }
    if (buf == NULL) {
11211
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11212
        goto error;
11213 11214 11215
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
11216
        goto error;
11217 11218

    virUUIDFormat(uuid, buf);
11219
    return 0;
11220

11221
error:
11222
    virDispatchError(pool->conn);
11223
    return -1;
11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234
}


/**
 * 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
 *
11235
 * Returns 0 on success, or -1 on failure.
11236 11237 11238 11239 11240 11241
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
11242
    VIR_DEBUG("pool=%p, info=%p", pool, info);
11243

11244 11245
    virResetLastError();

11246
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11247
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11248
        virDispatchError(NULL);
11249
        return -1;
11250 11251
    }
    if (info == NULL) {
11252
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11253
        goto error;
11254 11255 11256 11257 11258 11259
    }

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

    conn = pool->conn;

11260 11261 11262 11263 11264 11265 11266
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
11267

11268
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11269

11270
error:
11271
    virDispatchError(pool->conn);
11272
    return -1;
11273 11274 11275 11276 11277 11278
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
11279
 * @flags: flags for XML format options (set of virDomainXMLFlags)
11280 11281 11282 11283 11284
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
11285
 * Returns a XML document, or NULL on error
11286 11287 11288 11289 11290 11291
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
11292
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11293

11294 11295 11296
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11297
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11298
        virDispatchError(NULL);
11299
        return NULL;
11300 11301 11302 11303
    }

    conn = pool->conn;

11304 11305 11306 11307 11308 11309 11310
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
11311

11312
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11313

11314
error:
11315
    virDispatchError(pool->conn);
11316
    return NULL;
11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327
}


/**
 * 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
 *
11328
 * Returns 0 on success, -1 on failure
11329 11330 11331 11332 11333 11334
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
11335
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
11336

11337 11338 11339
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11340
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11341
        virDispatchError(NULL);
11342
        return -1;
11343 11344
    }
    if (!autostart) {
11345
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11346
        goto error;
11347 11348 11349 11350
    }

    conn = pool->conn;

11351 11352 11353 11354 11355 11356 11357
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
11358

11359
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11360 11361

error:
11362
    virDispatchError(pool->conn);
11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
11374
 * Returns 0 on success, -1 on failure
11375 11376 11377 11378 11379 11380
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
11381
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
11382

11383 11384 11385
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11386
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11387
        virDispatchError(NULL);
11388
        return -1;
11389 11390
    }

11391
    if (pool->conn->flags & VIR_CONNECT_RO) {
11392
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11393
        goto error;
11394 11395
    }

11396 11397
    conn = pool->conn;

11398 11399 11400 11401 11402 11403 11404
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
11405

11406
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11407 11408

error:
11409
    virDispatchError(pool->conn);
11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424
    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)
{
11425
    VIR_DEBUG("pool=%p", pool);
11426

11427 11428
    virResetLastError();

11429
    if (!VIR_IS_STORAGE_POOL(pool)) {
11430
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11431
        virDispatchError(NULL);
11432
        return -1;
11433 11434
    }

11435 11436 11437 11438 11439 11440 11441
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
11442

11443
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11444 11445

error:
11446
    virDispatchError(pool->conn);
11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466
    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)
{
11467
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
11468

11469 11470
    virResetLastError();

11471
    if (!VIR_IS_STORAGE_POOL(pool)) {
11472
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11473
        virDispatchError(NULL);
11474
        return -1;
11475 11476 11477
    }

    if ((names == NULL) || (maxnames < 0)) {
11478
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11479
        goto error;
11480 11481
    }

11482 11483 11484 11485 11486 11487 11488
    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;
    }
11489

11490
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11491 11492

error:
11493
    virDispatchError(pool->conn);
11494 11495 11496 11497 11498 11499
    return -1;
}


/**
 * virStorageVolGetConnect:
11500
 * @vol: pointer to a pool
11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514
 *
 * 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)
{
11515
    VIR_DEBUG("vol=%p", vol);
11516

11517 11518
    virResetLastError();

11519
    if (!VIR_IS_STORAGE_VOL (vol)) {
11520
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11521
        virDispatchError(NULL);
11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535
        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
 *
11536
 * Returns a storage volume, or NULL if not found / error
11537 11538 11539 11540 11541
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
11542
    VIR_DEBUG("pool=%p, name=%s", pool, name);
11543

11544 11545
    virResetLastError();

11546
    if (!VIR_IS_STORAGE_POOL(pool)) {
11547
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11548
        virDispatchError(NULL);
11549
        return NULL;
11550 11551
    }
    if (name == NULL) {
11552
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11553
        goto error;
11554 11555
    }

11556 11557 11558 11559 11560 11561 11562
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
11563

11564
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11565 11566

error:
11567
    virDispatchError(pool->conn);
11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580
    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
 *
11581
 * Returns a storage volume, or NULL if not found / error
11582 11583 11584 11585 11586
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
11587
    VIR_DEBUG("conn=%p, key=%s", conn, key);
11588

11589 11590
    virResetLastError();

11591
    if (!VIR_IS_CONNECT(conn)) {
11592
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11593
        virDispatchError(NULL);
11594
        return NULL;
11595 11596
    }
    if (key == NULL) {
11597
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11598
        goto error;
11599 11600
    }

11601 11602 11603 11604 11605 11606 11607
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
11608

11609
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11610 11611

error:
11612
    virDispatchError(conn);
11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623
    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
 *
11624
 * Returns a storage volume, or NULL if not found / error
11625 11626 11627 11628 11629
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
11630
    VIR_DEBUG("conn=%p, path=%s", conn, path);
11631

11632 11633
    virResetLastError();

11634
    if (!VIR_IS_CONNECT(conn)) {
11635
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11636
        virDispatchError(NULL);
11637
        return NULL;
11638 11639
    }
    if (path == NULL) {
11640
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11641
        goto error;
11642 11643
    }

11644 11645 11646 11647 11648 11649 11650
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
11651

11652
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11653 11654

error:
11655
    virDispatchError(conn);
11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
11667
 * Returns the volume name, or NULL on error
11668 11669 11670 11671
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
11672
    VIR_DEBUG("vol=%p", vol);
11673

11674 11675
    virResetLastError();

11676
    if (!VIR_IS_STORAGE_VOL(vol)) {
11677
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11678
        virDispatchError(NULL);
11679
        return NULL;
11680
    }
11681
    return vol->name;
11682 11683 11684 11685 11686 11687 11688 11689
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
11690
 * unique, so the same volume will have the same
11691 11692
 * key no matter what host it is accessed from
 *
11693
 * Returns the volume key, or NULL on error
11694 11695 11696 11697
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
11698
    VIR_DEBUG("vol=%p", vol);
11699

11700 11701
    virResetLastError();

11702
    if (!VIR_IS_STORAGE_VOL(vol)) {
11703
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11704
        virDispatchError(NULL);
11705
        return NULL;
11706
    }
11707
    return vol->key;
11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720
}


/**
 * 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
 *
11721
 * Returns the storage volume, or NULL on error
11722 11723 11724 11725 11726 11727
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
11728
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11729

11730 11731
    virResetLastError();

11732
    if (!VIR_IS_STORAGE_POOL(pool)) {
11733
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11734
        virDispatchError(NULL);
11735
        return NULL;
11736 11737
    }

11738 11739 11740 11741 11742
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

11743
    if (pool->conn->flags & VIR_CONNECT_RO) {
11744
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11745
        goto error;
11746 11747
    }

11748 11749 11750 11751 11752 11753 11754
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
11755

11756
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11757 11758

error:
11759
    virDispatchError(pool->conn);
11760 11761 11762 11763
    return NULL;
}


11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775
/**
 * 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.
 *
11776
 * Returns the storage volume, or NULL on error
11777 11778 11779 11780 11781 11782 11783
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
11784
    VIR_DEBUG("pool=%p, flags=%x, clonevol=%p", pool, flags, clonevol);
11785 11786 11787 11788

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
11789
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11790
        virDispatchError(NULL);
11791
        return NULL;
11792 11793 11794
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
11795
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11796
        goto error;
11797 11798
    }

11799 11800 11801 11802 11803
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

11804 11805
    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
11806
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819
        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;
    }

11820
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11821 11822

error:
11823
    virDispatchError(pool->conn);
11824 11825 11826 11827
    return NULL;
}


11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854
/**
 * 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 已提交
11855
    VIR_DEBUG("vol=%p, stream=%p, offset=%llu, length=%llu, flags=%x",
11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925
              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 已提交
11926
    VIR_DEBUG("vol=%p, stream=%p, offset=%llu, length=%llu, flags=%x",
11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967
              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;
}


11968 11969 11970
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
11971
 * @flags: future flags, use 0 for now
11972 11973 11974
 *
 * Delete the storage volume from the pool
 *
11975
 * Returns 0 on success, or -1 on error
11976 11977 11978 11979 11980 11981
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
11982
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
11983

11984 11985
    virResetLastError();

11986
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
11987
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11988
        virDispatchError(NULL);
11989
        return -1;
11990 11991 11992 11993
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11994
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11995
        goto error;
11996 11997
    }

11998 11999 12000 12001 12002 12003 12004
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12005

12006
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12007 12008

error:
12009
    virDispatchError(vol->conn);
12010 12011 12012 12013
    return -1;
}


12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027
/**
 * 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;
12028
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
12029 12030 12031 12032

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
12033
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12034
        virDispatchError(NULL);
12035
        return -1;
12036 12037 12038 12039
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12040
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

12053
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12054 12055 12056 12057 12058 12059 12060

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


12061 12062 12063 12064 12065
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
12066
 * storage volume continues to exist.
12067
 *
12068
 * Returns 0 on success, or -1 on error
12069 12070 12071 12072
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
12073
    VIR_DEBUG("vol=%p", vol);
12074

12075 12076
    virResetLastError();

12077
    if (!VIR_IS_STORAGE_VOL(vol)) {
12078
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12079
        virDispatchError(NULL);
12080
        return -1;
12081
    }
12082 12083
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
12084
        return -1;
12085
    }
12086
    return 0;
12087 12088 12089
}


12090 12091
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
12092
 * @vol: the vol to hold a reference on
12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103
 *
 * 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 已提交
12104 12105
 *
 * Returns 0 in case of success, -1 in case of failure.
12106 12107 12108 12109 12110
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
12111
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12112
        virDispatchError(NULL);
12113
        return -1;
12114 12115
    }
    virMutexLock(&vol->conn->lock);
12116
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
12117 12118 12119 12120 12121
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

12122 12123 12124 12125 12126 12127 12128 12129
/**
 * 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
 *
12130
 * Returns 0 on success, or -1 on failure
12131 12132 12133 12134 12135 12136
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
12137
    VIR_DEBUG("vol=%p, info=%p", vol, info);
12138

12139 12140
    virResetLastError();

12141
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
12142
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12143
        virDispatchError(NULL);
12144
        return -1;
12145 12146
    }
    if (info == NULL) {
12147
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12148
        goto error;
12149 12150 12151 12152 12153 12154
    }

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

    conn = vol->conn;

12155 12156 12157 12158 12159 12160 12161
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
12162

12163
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12164 12165

error:
12166
    virDispatchError(vol->conn);
12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178
    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
 *
12179
 * Returns the XML document, or NULL on error
12180 12181 12182 12183 12184 12185
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
12186
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
12187

12188 12189
    virResetLastError();

12190
    if (!VIR_IS_STORAGE_VOL(vol)) {
12191
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12192
        virDispatchError(NULL);
12193
        return NULL;
12194 12195 12196 12197
    }

    conn = vol->conn;

12198 12199 12200 12201 12202 12203 12204
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
12205

12206
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12207

12208
error:
12209
    virDispatchError(vol->conn);
12210
    return NULL;
12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223
}


/**
 * 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
 *
12224 12225
 * Returns the storage volume path, or NULL on error. The
 * caller must free() the returned path after use.
12226 12227 12228 12229 12230
 */
char *
virStorageVolGetPath(virStorageVolPtr vol)
{
    virConnectPtr conn;
12231
    VIR_DEBUG("vol=%p", vol);
12232

12233 12234
    virResetLastError();

12235
    if (!VIR_IS_STORAGE_VOL(vol)) {
12236
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12237
        virDispatchError(NULL);
12238
        return NULL;
12239 12240 12241 12242
    }

    conn = vol->conn;

12243 12244 12245 12246 12247 12248 12249
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
12250

12251
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12252 12253

error:
12254
    virDispatchError(vol->conn);
12255 12256
    return NULL;
}
12257 12258


12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274
/**
 * 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)
{
12275
    VIR_DEBUG("conn=%p, cap=%s, flags=%x", conn, NULLSTR(cap), flags);
12276

12277 12278
    virResetLastError();

12279
    if (!VIR_IS_CONNECT(conn)) {
12280
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12281
        virDispatchError(NULL);
12282
        return -1;
12283 12284
    }

12285 12286 12287 12288 12289 12290 12291
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12292

12293
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12294 12295

error:
12296
    virDispatchError(conn);
12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321
    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)
{
12322
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%x",
12323 12324
          conn, cap, names, maxnames, flags);

12325 12326
    virResetLastError();

12327
    if (!VIR_IS_CONNECT(conn)) {
12328
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12329
        virDispatchError(NULL);
12330
        return -1;
12331
    }
12332
    if ((names == NULL) || (maxnames < 0)) {
12333
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12334
        goto error;
12335 12336
    }

12337 12338 12339 12340 12341 12342 12343
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12344

12345
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12346 12347

error:
12348
    virDispatchError(conn);
12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363
    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)
{
12364
    VIR_DEBUG("conn=%p, name=%p", conn, name);
12365

12366 12367
    virResetLastError();

12368
    if (!VIR_IS_CONNECT(conn)) {
12369
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12370
        virDispatchError(NULL);
12371 12372 12373 12374
        return NULL;
    }

    if (name == NULL) {
12375
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12376
        goto error;
12377 12378
    }

12379 12380 12381 12382 12383 12384 12385
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
12386

12387
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12388 12389

error:
12390
    virDispatchError(conn);
12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402
    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.
 *
12403
 * Returns the XML document, or NULL on error
12404 12405 12406
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
E
Eric Blake 已提交
12407
    VIR_DEBUG("dev=%p, conn=%p, flags=%x", dev, dev ? dev->conn : NULL, flags);
12408

12409 12410
    virResetLastError();

12411
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12412
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12413
        virDispatchError(NULL);
12414 12415 12416
        return NULL;
    }

12417
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetXMLDesc) {
12418
        char *ret;
12419
        ret = dev->conn->deviceMonitor->deviceGetXMLDesc(dev, flags);
12420 12421 12422 12423
        if (!ret)
            goto error;
        return ret;
    }
12424

12425
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12426 12427

error:
12428
    virDispatchError(dev->conn);
12429 12430 12431 12432 12433 12434 12435 12436
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12437 12438 12439
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
12440 12441 12442
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
12443
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12444 12445

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12446
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12447
        virDispatchError(NULL);
12448 12449 12450 12451 12452 12453 12454 12455 12456 12457
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12458 12459
 * Accessor for the parent of the device
 *
12460 12461 12462 12463 12464
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
12465
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12466

12467 12468
    virResetLastError();

12469
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12470
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12471
        virDispatchError(NULL);
12472 12473 12474
        return NULL;
    }

12475 12476 12477 12478
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
12479
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12480
            virDispatchError(dev->conn);
12481 12482 12483 12484
            return NULL;
        }
    }
    return dev->parent;
12485 12486 12487 12488 12489 12490
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12491 12492
 * Accessor for the number of capabilities supported by the device.
 *
12493 12494 12495 12496
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
12497
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12498

12499 12500
    virResetLastError();

12501
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12502
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12503
        virDispatchError(NULL);
12504 12505 12506
        return -1;
    }

12507 12508 12509 12510 12511 12512 12513
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
12514

12515
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12516 12517

error:
12518
    virDispatchError(dev->conn);
12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535
    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)
{
12536
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
12537 12538
          dev, dev ? dev->conn : NULL, names, maxnames);

12539 12540
    virResetLastError();

12541
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12542
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12543
        virDispatchError(NULL);
12544 12545 12546
        return -1;
    }

12547 12548 12549 12550 12551
    if (names == NULL || maxnames < 0) {
        virLibNodeDeviceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

12552 12553 12554 12555 12556 12557 12558
    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;
    }
12559

12560
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12561 12562

error:
12563
    virDispatchError(dev->conn);
12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578
    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)
{
12579
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12580

12581 12582
    virResetLastError();

12583
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12584
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12585
        virDispatchError(NULL);
12586
        return -1;
12587
    }
12588 12589
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
12590
        return -1;
12591
    }
12592
    return 0;
12593 12594 12595
}


12596 12597
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
12598
 * @dev: the dev to hold a reference on
12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609
 *
 * 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 已提交
12610 12611
 *
 * Returns 0 in case of success, -1 in case of failure.
12612 12613 12614 12615 12616
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
12617
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12618
        virDispatchError(NULL);
12619
        return -1;
12620 12621
    }
    virMutexLock(&dev->conn->lock);
12622
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
12623 12624 12625 12626 12627
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

12628
/**
D
Daniel Veillard 已提交
12629
 * virNodeDeviceDettach:
12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643
 * @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 已提交
12644 12645
 *
 * Returns 0 in case of success, -1 in case of failure.
12646 12647 12648 12649
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
12650
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12651 12652 12653 12654

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12655
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12656
        virDispatchError(NULL);
12657
        return -1;
12658 12659
    }

12660 12661 12662 12663 12664
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12665 12666 12667 12668 12669 12670 12671 12672
    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12673
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12674 12675

error:
12676
    virDispatchError(dev->conn);
12677
    return -1;
12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691
}

/**
 * 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 已提交
12692 12693
 *
 * Returns 0 in case of success, -1 in case of failure.
12694 12695 12696 12697
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
12698
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12699 12700 12701 12702

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12703
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12704
        virDispatchError(NULL);
12705
        return -1;
12706 12707
    }

12708 12709 12710 12711 12712
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12713 12714 12715 12716 12717 12718 12719 12720
    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12721
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12722 12723

error:
12724
    virDispatchError(dev->conn);
12725
    return -1;
12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741
}

/**
 * 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 已提交
12742 12743
 *
 * Returns 0 in case of success, -1 in case of failure.
12744 12745 12746 12747
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
12748
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12749 12750 12751 12752

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12753
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12754
        virDispatchError(NULL);
12755
        return -1;
12756 12757
    }

12758 12759 12760 12761 12762
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12763 12764 12765 12766 12767 12768 12769 12770
    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12771
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12772 12773

error:
12774
    virDispatchError(dev->conn);
12775
    return -1;
12776 12777
}

12778

12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794
/**
 * 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)
{
12795
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
12796 12797 12798 12799

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12800
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12801
        virDispatchError(NULL);
12802 12803 12804 12805
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
12806
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12807 12808 12809 12810
        goto error;
    }

    if (xmlDesc == NULL) {
12811
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

12823
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12824 12825

error:
12826
    virDispatchError(conn);
12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842
    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)
{
12843
    VIR_DEBUG("dev=%p", dev);
12844 12845 12846 12847

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12848
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12849
        virDispatchError(NULL);
12850
        return -1;
12851 12852 12853
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
12854
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

12868
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12869 12870

error:
12871
    virDispatchError(dev->conn);
12872 12873 12874 12875
    return -1;
}


12876 12877 12878 12879 12880 12881 12882 12883 12884
/*
 * 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 已提交
12885
 * @freecb: optional function to deallocate opaque when not used anymore
12886
 *
12887 12888 12889 12890 12891 12892
 * 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
12893
 *
12894 12895
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
12896 12897
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
12898 12899 12900
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
12901 12902 12903 12904 12905
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
12906 12907
                              void *opaque,
                              virFreeCallback freecb)
12908
{
12909
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
12910
    virResetLastError();
12911 12912

    if (!VIR_IS_CONNECT(conn)) {
12913
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12914
        virDispatchError(NULL);
12915
        return -1;
12916 12917
    }
    if (cb == NULL) {
12918
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12919
        goto error;
12920 12921
    }

12922 12923 12924 12925 12926 12927 12928 12929
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

12930
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12931
error:
12932
    virDispatchError(conn);
12933 12934 12935 12936 12937 12938 12939 12940
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
12941 12942 12943 12944 12945 12946
 * 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
12947 12948 12949 12950 12951 12952 12953
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
12954
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
12955 12956

    virResetLastError();
12957 12958

    if (!VIR_IS_CONNECT(conn)) {
12959
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12960
        virDispatchError(NULL);
12961
        return -1;
12962 12963
    }
    if (cb == NULL) {
12964
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12965 12966 12967 12968 12969 12970 12971 12972
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
12973 12974
    }

12975
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12976
error:
12977
    virDispatchError(conn);
12978 12979
    return -1;
}
12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995

/**
 * 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)
{
12996
    VIR_DEBUG("secret=%p", secret);
12997 12998 12999 13000

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
13001
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13002
        virDispatchError(NULL);
13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023
        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)) {
13024
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13025
        virDispatchError(NULL);
13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

13039
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13040 13041

error:
13042
    virDispatchError(conn);
13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063
    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)) {
13064
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13065
        virDispatchError(NULL);
13066 13067 13068
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
13069
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081
        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;
    }

13082
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13083 13084

error:
13085
    virDispatchError(conn);
13086 13087 13088 13089
    return -1;
}

/**
13090 13091 13092
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
13093
 *
13094 13095
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
13096
 *
13097 13098
 * 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.
13099 13100
 */
virSecretPtr
13101
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
13102
{
13103
    VIR_UUID_DEBUG(conn, uuid);
13104 13105 13106 13107

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13108
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13109
        virDispatchError(NULL);
13110
        return NULL;
13111 13112
    }
    if (uuid == NULL) {
13113
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13114 13115 13116
        goto error;
    }

13117 13118
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
13119
        virSecretPtr ret;
13120 13121
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
13122 13123 13124 13125
            goto error;
        return ret;
    }

13126
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13127 13128

error:
13129
    virDispatchError(conn);
13130 13131 13132
    return NULL;
}

13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147
/**
 * 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];
13148
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
13149 13150 13151 13152

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13153
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13154
        virDispatchError(NULL);
13155
        return NULL;
13156 13157
    }
    if (uuidstr == NULL) {
13158
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13159 13160
        goto error;
    }
13161 13162

    if (virUUIDParse(uuidstr, uuid) < 0) {
13163
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13164 13165 13166 13167 13168 13169
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
13170
    virDispatchError(conn);
13171 13172 13173 13174
    return NULL;
}


13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192
/**
 * 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)
{
13193
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
13194 13195 13196 13197

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13198
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13199
        virDispatchError(NULL);
13200
        return NULL;
13201 13202
    }
    if (usageID == NULL) {
13203
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

13216
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13217 13218

error:
13219
    virDispatchError(conn);
13220 13221 13222 13223
    return NULL;
}


13224 13225 13226 13227 13228 13229
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
13230
 * If XML specifies a UUID, locates the specified secret and replaces all
13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241
 * 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)
{
13242
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
13243 13244 13245 13246

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13247
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13248
        virDispatchError(NULL);
13249 13250 13251
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
13252
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13253 13254 13255
        goto error;
    }
    if (xml == NULL) {
13256
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268
        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;
    }

13269
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13270 13271

error:
13272
    virDispatchError(conn);
13273 13274 13275 13276
    return NULL;
}

/**
13277
 * virSecretGetUUID:
13278
 * @secret: A virSecret secret
13279
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
13280 13281 13282
 *
 * Fetches the UUID of the secret.
 *
13283 13284
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
13285
 */
13286 13287
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
13288 13289 13290 13291 13292 13293
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13294
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13295
        virDispatchError(NULL);
13296 13297 13298
        return -1;
    }
    if (uuid == NULL) {
13299
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13300
        virDispatchError(secret->conn);
13301
        return -1;
13302 13303
    }

13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322
    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];
13323
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
13324 13325

    virResetLastError();
13326

13327
    if (!VIR_IS_SECRET(secret)) {
13328
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13329
        virDispatchError(NULL);
13330
        return -1;
13331 13332
    }
    if (buf == NULL) {
13333
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13334 13335 13336 13337 13338 13339 13340
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
13341
    return 0;
13342 13343

error:
13344
    virDispatchError(secret->conn);
13345
    return -1;
13346 13347
}

13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363
/**
 * 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)
{
13364
    VIR_DEBUG("secret=%p", secret);
13365 13366 13367 13368

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
13369
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13370
        virDispatchError(NULL);
13371
        return -1;
13372
    }
13373
    return secret->usageType;
13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394
}

/**
 * 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)
{
13395
    VIR_DEBUG("secret=%p", secret);
13396 13397 13398 13399

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
13400
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13401
        virDispatchError(NULL);
13402
        return NULL;
13403
    }
13404
    return secret->usageID;
13405 13406
}

13407

13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422
/**
 * 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;

13423
    VIR_DEBUG("secret=%p, flags=%x", secret, flags);
13424 13425 13426 13427

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13428
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13429
        virDispatchError(NULL);
13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442
        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;
    }

13443
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13444 13445

error:
13446
    virDispatchError(conn);
13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466
    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;

13467
    VIR_DEBUG("secret=%p, value=%p, value_size=%zu, flags=%x", secret, value,
13468 13469 13470 13471 13472
              value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13473
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13474
        virDispatchError(NULL);
13475 13476 13477 13478
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13479
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13480 13481 13482
        goto error;
    }
    if (value == NULL) {
13483
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495
        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;
    }

13496
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13497 13498

error:
13499
    virDispatchError(conn);
13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518
    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;

13519
    VIR_DEBUG("secret=%p, value_size=%p, flags=%x", secret, value_size, flags);
13520 13521 13522 13523

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13524
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13525
        virDispatchError(NULL);
13526 13527 13528 13529
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13530
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13531 13532 13533
        goto error;
    }
    if (value_size == NULL) {
13534
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13535 13536 13537 13538 13539 13540
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->getValue != NULL) {
        unsigned char *ret;

13541
        ret = conn->secretDriver->getValue(secret, value_size, flags, 0);
13542 13543 13544 13545 13546
        if (ret == NULL)
            goto error;
        return ret;
    }

13547
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13548 13549

error:
13550
    virDispatchError(conn);
13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572
    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)) {
13573
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13574
        virDispatchError(NULL);
13575 13576 13577 13578
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13579
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

13592
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13593 13594

error:
13595
    virDispatchError(conn);
13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618
    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)) {
13619
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13620
        virDispatchError(NULL);
13621 13622 13623
        return -1;
    }
    virMutexLock(&secret->conn->lock);
13624
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
13636
 * Returns 0 on success, or -1 on error
13637 13638 13639 13640
 */
int
virSecretFree(virSecretPtr secret)
{
13641
    VIR_DEBUG("secret=%p", secret);
13642 13643 13644 13645

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13646
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13647
        virDispatchError(NULL);
13648 13649
        return -1;
    }
13650 13651
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
13652
        return -1;
13653
    }
13654 13655
    return 0;
}
13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682


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

13683
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
13684 13685 13686 13687

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13688
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13689
        virDispatchError(NULL);
13690
        return NULL;
13691 13692 13693 13694 13695
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;
13696 13697
    else
        virDispatchError(conn);
13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717

    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))) {
13718
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13719
        virDispatchError(NULL);
13720
        return -1;
13721 13722
    }
    virMutexLock(&stream->conn->lock);
13723
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738
    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
13739
 * it should call virStreamFinish to wait for successful
13740
 * confirmation from the driver, or detect any error.
13741 13742
 *
 * This method may not be used if a stream source has been
13743
 * registered.
13744 13745 13746 13747 13748
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
13749
 * An example using this with a hypothetical file upload
13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797
 * 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)
{
13798
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
13799 13800 13801 13802

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13803
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13804
        virDispatchError(NULL);
13805
        return -1;
13806 13807
    }

13808 13809 13810 13811 13812
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823
    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;
    }

13824
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13825 13826

error:
13827
    virDispatchError(stream->conn);
13828 13829 13830 13831 13832 13833 13834
    return -1;
}


/**
 * virStreamRecv:
 * @stream: pointer to the stream object
13835
 * @data: buffer to read into from stream
13836 13837
 * @nbytes: size of @data buffer
 *
13838
 * Reads a series of bytes from the stream. This method may
13839 13840 13841 13842 13843 13844 13845
 * 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 已提交
13846
 * An example using this with a hypothetical file download
13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897
 * 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)
{
13898
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
13899 13900 13901 13902

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13903
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13904
        virDispatchError(NULL);
13905
        return -1;
13906 13907
    }

13908 13909 13910 13911 13912
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923
    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;
    }

13924
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13925 13926

error:
13927
    virDispatchError(stream->conn);
13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941
    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 已提交
13942
 * An example using this with a hypothetical file upload
13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963
 * 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);
 *
13964
 * Returns 0 if all the data was successfully sent. The caller
13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978
 * 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;
13979
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
13980 13981 13982 13983

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
13984
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13985
        virDispatchError(NULL);
13986
        return -1;
13987 13988
    }

13989 13990 13991 13992 13993
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

13994
    if (stream->flags & VIR_STREAM_NONBLOCK) {
13995
        virLibConnError(VIR_ERR_OPERATION_INVALID,
13996 13997 13998 13999 14000
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
14001
        virReportOOMError();
14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027
        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)
14028
        virDispatchError(stream->conn);
14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043

    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 已提交
14044
 * An example using this with a hypothetical file download
14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065
 * 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);
 *
14066
 * Returns 0 if all the data was successfully received. The caller
14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080
 * 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;
14081
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
14082 14083 14084 14085

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14086
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14087
        virDispatchError(NULL);
14088
        return -1;
14089 14090
    }

14091 14092 14093 14094 14095
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

14096
    if (stream->flags & VIR_STREAM_NONBLOCK) {
14097
        virLibConnError(VIR_ERR_OPERATION_INVALID,
14098 14099 14100 14101 14102 14103
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
14104
        virReportOOMError();
14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130
        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)
14131
        virDispatchError(stream->conn);
14132 14133 14134 14135 14136 14137

    return ret;
}


/**
M
Matthias Bolte 已提交
14138
 * virStreamEventAddCallback:
14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157
 * @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)
{
14158
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
14159 14160 14161 14162

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14163
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14164
        virDispatchError(NULL);
14165
        return -1;
14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

14177
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14178 14179

error:
14180
    virDispatchError(stream->conn);
14181 14182 14183 14184 14185
    return -1;
}


/**
M
Matthias Bolte 已提交
14186
 * virStreamEventUpdateCallback:
14187 14188 14189 14190 14191 14192
 * @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 已提交
14193
 * is guaranteed to succeed if a callback is already registered
14194 14195 14196 14197 14198 14199
 *
 * Returns 0 on success, -1 if no callback is registered
 */
int virStreamEventUpdateCallback(virStreamPtr stream,
                                 int events)
{
14200
    VIR_DEBUG("stream=%p, events=%d", stream, events);
14201 14202 14203 14204

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14205
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14206
        virDispatchError(NULL);
14207
        return -1;
14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

14219
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14220 14221

error:
14222
    virDispatchError(stream->conn);
14223 14224 14225 14226
    return -1;
}

/**
M
Matthias Bolte 已提交
14227
 * virStreamEventRemoveCallback:
14228 14229
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
14230
 * Remove an event callback from the stream
14231 14232 14233 14234 14235
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
14236
    VIR_DEBUG("stream=%p", stream);
14237 14238 14239 14240

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14241
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14242
        virDispatchError(NULL);
14243
        return -1;
14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14255
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14256 14257

error:
14258
    virDispatchError(stream->conn);
14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278
    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)
{
14279
    VIR_DEBUG("stream=%p", stream);
14280 14281 14282 14283

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14284
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14285
        virDispatchError(NULL);
14286
        return -1;
14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14298
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14299 14300

error:
14301
    virDispatchError(stream->conn);
14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319
    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)
{
14320
    VIR_DEBUG("stream=%p", stream);
14321 14322 14323 14324

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14325
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14326
        virDispatchError(NULL);
14327
        return -1;
14328 14329
    }

14330 14331 14332 14333 14334 14335
    if (!stream->driver) {
        VIR_DEBUG("aborting unused stream");
        return 0;
    }

    if (stream->driver->streamAbort) {
14336 14337 14338 14339 14340 14341 14342
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14343
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14344 14345

error:
14346
    virDispatchError(stream->conn);
14347 14348 14349 14350 14351 14352 14353 14354 14355 14356
    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 已提交
14357
 * There must not be an active data transfer in progress
14358 14359 14360 14361 14362 14363 14364 14365
 * 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)
{
14366
    VIR_DEBUG("stream=%p", stream);
14367 14368 14369 14370

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14371
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14372
        virDispatchError(NULL);
14373
        return -1;
14374 14375 14376 14377
    }

    /* XXX Enforce shutdown before free'ing resources ? */

14378 14379
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
14380
        return -1;
14381
    }
14382
    return 0;
14383
}
14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395


/**
 * 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)
{
14396
    VIR_DEBUG("dom=%p", dom);
14397 14398 14399 14400

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14401
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14402
        virDispatchError(NULL);
14403
        return -1;
14404 14405 14406 14407 14408 14409 14410 14411 14412
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14413
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14414
error:
14415
    virDispatchError(dom->conn);
14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429
    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)
{
14430
    VIR_DOMAIN_DEBUG(dom);
14431 14432 14433 14434

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14435
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14436
        virDispatchError(NULL);
14437
        return -1;
14438 14439 14440 14441 14442 14443 14444 14445 14446
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14447
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14448
error:
14449
    virDispatchError(dom->conn);
14450 14451 14452
    return -1;
}

14453 14454 14455 14456 14457 14458 14459 14460 14461 14462
/**
 * 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)
{
14463
    VIR_DOMAIN_DEBUG(dom);
14464 14465 14466 14467

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14468
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14469
        virDispatchError(NULL);
14470
        return -1;
14471 14472 14473 14474 14475 14476 14477 14478 14479
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14480
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14481 14482 14483 14484 14485
error:
    virDispatchError(dom->conn);
    return -1;
}

14486 14487 14488 14489 14490 14491 14492 14493 14494 14495
/**
 * 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)
{
14496
    VIR_DEBUG("net=%p", net);
14497 14498 14499 14500

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
14501
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14502
        virDispatchError(NULL);
14503
        return -1;
14504 14505 14506 14507 14508 14509 14510 14511 14512
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

14513
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14514
error:
14515
    virDispatchError(net->conn);
14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530
    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)
{
14531
    VIR_DEBUG("net=%p", net);
14532 14533 14534 14535

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
14536
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14537
        virDispatchError(NULL);
14538
        return -1;
14539 14540 14541 14542 14543 14544 14545 14546 14547
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

14548
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14549
error:
14550
    virDispatchError(net->conn);
14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564
    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)
{
14565
    VIR_DEBUG("pool=%p", pool);
14566 14567 14568 14569

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
14570
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14571
        virDispatchError(NULL);
14572
        return -1;
14573 14574 14575 14576 14577 14578 14579 14580 14581
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

14582
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14583
error:
14584
    virDispatchError(pool->conn);
14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599
    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)
{
14600
    VIR_DEBUG("pool=%p", pool);
14601 14602 14603 14604

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
14605
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14606
        virDispatchError(NULL);
14607
        return -1;
14608 14609 14610 14611 14612 14613 14614 14615 14616
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

14617
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14618
error:
14619
    virDispatchError(pool->conn);
14620 14621 14622 14623
    return -1;
}


S
Stefan Berger 已提交
14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635

/**
 * 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)
{
14636
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
14637 14638 14639 14640

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14641
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653
        virDispatchError(NULL);
        return -1;
    }

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

14654
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674

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)
{
14675
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
14676 14677 14678 14679

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14680
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14681 14682 14683 14684 14685
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
14686
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697
        goto error;
    }

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

14698
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718

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)
{
14719
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
14720 14721 14722 14723

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14724
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14725
        virDispatchError(NULL);
14726
        return NULL;
S
Stefan Berger 已提交
14727 14728
    }
    if (name == NULL) {
14729
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

14741
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760

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)
{
14761
    VIR_UUID_DEBUG(conn, uuid);
S
Stefan Berger 已提交
14762 14763 14764 14765

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14766
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14767
        virDispatchError(NULL);
14768
        return NULL;
S
Stefan Berger 已提交
14769 14770
    }
    if (uuid == NULL) {
14771
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

14783
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14784 14785 14786 14787 14788 14789 14790

error:
    virDispatchError(conn);
    return NULL;
}

/**
14791
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803
 * @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];
14804
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
S
Stefan Berger 已提交
14805 14806 14807 14808

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14809
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14810
        virDispatchError(NULL);
14811
        return NULL;
S
Stefan Berger 已提交
14812 14813
    }
    if (uuidstr == NULL) {
14814
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14815 14816 14817 14818
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
14819
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841
        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)
{
14842
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
14843 14844 14845 14846

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
14847
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869
        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)
{
14870
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
14871 14872 14873 14874

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
14875
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14876
        virDispatchError(NULL);
14877
        return NULL;
S
Stefan Berger 已提交
14878
    }
14879
    return nwfilter->name;
S
Stefan Berger 已提交
14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893
}

/**
 * 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)
{
14894
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
14895 14896 14897 14898

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
14899
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14900 14901 14902 14903
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
14904
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930
        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];
14931
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
14932 14933 14934 14935

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
14936
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
14937 14938 14939 14940
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
14941
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969
        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)
{
14970
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
14971 14972 14973 14974

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14975
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14976
        virDispatchError(NULL);
14977
        return NULL;
S
Stefan Berger 已提交
14978 14979
    }
    if (xmlDesc == NULL) {
14980
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14981 14982 14983
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
14984
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
14985 14986 14987 14988 14989
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
E
Eric Blake 已提交
14990
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc);
S
Stefan Berger 已提交
14991 14992 14993 14994 14995
        if (!ret)
            goto error;
        return ret;
    }

14996
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017

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;
15018
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
15019 15020 15021 15022

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
15023
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15024 15025 15026 15027 15028 15029
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15030
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

15042
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061

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 *
15062
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
S
Stefan Berger 已提交
15063 15064
{
    virConnectPtr conn;
15065
    VIR_DEBUG("nwfilter=%p, flags=%x", nwfilter, flags);
S
Stefan Berger 已提交
15066 15067 15068 15069

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
15070
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15071
        virDispatchError(NULL);
15072
        return NULL;
S
Stefan Berger 已提交
15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084
    }

    conn = nwfilter->conn;

    if (conn->nwfilterDriver && conn->nwfilterDriver->getXMLDesc) {
        char *ret;
        ret = conn->nwfilterDriver->getXMLDesc (nwfilter, flags);
        if (!ret)
            goto error;
        return ret;
    }

15085
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113

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))) {
15114
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15115 15116 15117 15118
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
15119
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
15120 15121 15122 15123 15124 15125
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


15126 15127 15128 15129 15130 15131 15132 15133 15134 15135
/**
 * 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)
{
15136
    VIR_DEBUG("iface=%p", iface);
15137 15138 15139 15140

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
15141
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15142
        virDispatchError(NULL);
15143
        return -1;
15144 15145 15146 15147 15148 15149 15150 15151 15152
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

15153
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15154
error:
15155
    virDispatchError(iface->conn);
15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169
    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)
{
15170
    VIR_DEBUG("conn=%p", conn);
15171 15172 15173 15174

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15175
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15176
        virDispatchError(NULL);
15177
        return -1;
15178 15179 15180 15181 15182 15183 15184 15185 15186
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

15187
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15188
error:
15189
    virDispatchError(conn);
15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206
    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)
{
15207
    VIR_DEBUG("conn=%p", conn);
15208 15209 15210 15211

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15212
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15213
        virDispatchError(NULL);
15214
        return -1;
15215 15216 15217 15218 15219 15220 15221 15222 15223
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

15224
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15225
error:
15226
    virDispatchError(conn);
15227 15228
    return -1;
}
J
Jiri Denemark 已提交
15229 15230 15231 15232 15233


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
15234 15235 15236 15237
 * @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 已提交
15238 15239 15240 15241 15242 15243 15244 15245
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
15246
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
15247 15248 15249 15250

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15251
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15252
        virDispatchError(NULL);
J
Jiri Denemark 已提交
15253 15254 15255
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
15256
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268
        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;
    }

15269
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
15270 15271

error:
15272
    virDispatchError(conn);
J
Jiri Denemark 已提交
15273 15274
    return VIR_CPU_COMPARE_ERROR;
}
15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297


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

15298
    VIR_DEBUG("conn=%p, xmlCPUs=%p, ncpus=%u, flags=%x",
15299 15300 15301 15302 15303 15304 15305 15306 15307
              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)) {
15308
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15309 15310 15311 15312
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
15313
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325
        goto error;
    }

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

15326
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15327 15328 15329 15330 15331

error:
    virDispatchError(conn);
    return NULL;
}
15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347


/**
 * 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;
15348 15349

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
15350 15351 15352 15353

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15354
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15355
        virDispatchError(NULL);
15356
        return -1;
15357 15358
    }
    if (info == NULL) {
15359
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374
        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;
    }

15375
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15376 15377 15378 15379 15380

error:
    virDispatchError(domain->conn);
    return -1;
}
15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397


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

15398
    VIR_DOMAIN_DEBUG(domain);
15399 15400 15401 15402

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15403
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15404
        virDispatchError(NULL);
15405
        return -1;
15406 15407 15408 15409
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15410
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421
        goto error;
    }

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

15422
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15423 15424 15425 15426 15427

error:
    virDispatchError(conn);
    return -1;
}
15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448


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

15449
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%x", downtime, flags);
15450 15451 15452 15453

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15454
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15455 15456 15457 15458 15459 15460
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15461
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15462 15463 15464 15465 15466 15467 15468 15469 15470
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

15471
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15472 15473 15474 15475 15476
error:
    virDispatchError(conn);
    return -1;
}

15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495
/**
 * 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;

15496
    VIR_DOMAIN_DEBUG(domain, "bandwidth=%lu, flags=%x", bandwidth, flags);
15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517

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

15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551
    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;
    }

15552 15553
    conn = domain->conn;

15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569
    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;
    }

15570 15571 15572 15573 15574 15575
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597
/**
 * 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.
15598 15599
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616
 * 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)
{
15617 15618 15619
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

15620 15621 15622
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15623
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15624
        virDispatchError(NULL);
15625
        return -1;
15626 15627 15628
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
15629
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15630
        virDispatchError(conn);
15631
        return -1;
15632 15633
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
15634
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645
        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;
    }

15646
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15647 15648 15649 15650
error:
    virDispatchError(conn);
    return -1;
}
15651

15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665
/**
 * 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)
{
15666
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
15667 15668 15669 15670

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15671
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15672
        virDispatchError(NULL);
15673
        return -1;
15674 15675
    }
    if (callbackID < 0) {
15676
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15677 15678 15679 15680 15681 15682 15683 15684 15685 15686
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

15687
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15688 15689 15690 15691
error:
    virDispatchError(conn);
    return -1;
}
15692 15693 15694 15695

/**
 * virDomainManagedSave:
 * @dom: pointer to the domain
15696
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
15697 15698 15699 15700 15701 15702 15703 15704
 *
 * 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.
15705 15706 15707
 * 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.
15708
 *
15709 15710 15711 15712 15713
 * 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.
 *
15714 15715 15716 15717 15718 15719
 * 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.
 *
15720 15721 15722 15723 15724 15725
 * Returns 0 in case of success or -1 in case of failure
 */
int virDomainManagedSave(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

15726
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
15727 15728 15729 15730

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
15731
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15732 15733 15734 15735 15736 15737
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15738
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15739 15740 15741
        goto error;
    }

15742 15743 15744 15745 15746 15747
    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;
    }

15748 15749 15750 15751 15752 15753 15754 15755 15756
    if (conn->driver->domainManagedSave) {
        int ret;

        ret = conn->driver->domainManagedSave(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

15757
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779

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;

15780
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
15781 15782 15783 15784

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
15785
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800
        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;
    }

15801
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
15813
 * Remove any managed save image for this domain.
15814 15815 15816 15817 15818 15819 15820
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

15821
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
15822 15823 15824 15825

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
15826
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15827 15828 15829 15830 15831 15832
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15833
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845
        goto error;
    }

    if (conn->driver->domainManagedSaveRemove) {
        int ret;

        ret = conn->driver->domainManagedSaveRemove(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

15846
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15847 15848 15849 15850 15851

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
15852

15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925
/**
 * virDomainSnapshotGetName:
 * @snapshot: a snapshot object
 *
 * Get the public name for that snapshot
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * as its lifetime will be the same as the snapshot object.
 */
const char *
virDomainSnapshotGetName(virDomainSnapshotPtr snapshot)
{
    VIR_DEBUG("snapshot=%p", snapshot);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }
    return snapshot->name;
}

/**
 * virDomainSnapshotGetDomain:
 * @snapshot: a snapshot object
 *
 * Get the domain that a snapshot was created for
 *
 * Returns the domain or NULL.
 */
virDomainPtr
virDomainSnapshotGetDomain(virDomainSnapshotPtr snapshot)
{
    VIR_DEBUG("snapshot=%p", snapshot);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }
    return snapshot->domain;
}

/**
 * virDomainSnapshotGetConnect:
 * @snapshot: a snapshot object
 *
 * Get the connection that owns the domain that a snapshot was created for
 *
 * Returns the connection or NULL.
 */
virConnectPtr
virDomainSnapshotGetConnect(virDomainSnapshotPtr snapshot)
{
    VIR_DEBUG("snapshot=%p", snapshot);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }
    return snapshot->domain->conn;
}

C
Chris Lalancette 已提交
15926 15927 15928 15929
/**
 * virDomainSnapshotCreateXML:
 * @domain: a domain object
 * @xmlDesc: string containing an XML description of the domain
15930
 * @flags: bitwise-OR of virDomainSnapshotCreateFlags
C
Chris Lalancette 已提交
15931 15932 15933 15934
 *
 * Creates a new snapshot of a domain based on the snapshot xml
 * contained in xmlDesc.
 *
15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969
 * 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.
 *
15970 15971 15972 15973 15974 15975
 * If @flags includes VIR_DOMAIN_SNAPSHOT_CREATE_HALT, then the domain
 * will be inactive after the snapshot completes, regardless of whether
 * it was active before; otherwise, a running domain will still be
 * running after the snapshot.  This flag is invalid on transient domains,
 * and is incompatible with VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE.
 *
15976 15977 15978 15979 15980 15981
 * If @flags includes VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY, then the
 * snapshot will be limited to the disks described in @xmlDesc, and no
 * VM state will be saved.  For an active guest, the disk image may be
 * inconsistent (as if power had been pulled), and specifying this
 * with the VIR_DOMAIN_SNAPSHOT_CREATE_HALT flag risks data loss.
 *
C
Chris Lalancette 已提交
15982 15983 15984 15985 15986 15987 15988 15989 15990
 * Returns an (opaque) virDomainSnapshotPtr on success, NULL on failure.
 */
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
                           const char *xmlDesc,
                           unsigned int flags)
{
    virConnectPtr conn;

15991
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%x", xmlDesc, flags);
C
Chris Lalancette 已提交
15992 15993 15994 15995

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15996
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
15997 15998 15999 16000 16001
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
16002 16003 16004 16005 16006 16007

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

C
Chris Lalancette 已提交
16008
    if (conn->flags & VIR_CONNECT_RO) {
16009
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
16010 16011 16012
        goto error;
    }

16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024
    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;
    }
16025 16026 16027 16028 16029 16030
    if ((flags & VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE) &&
        (flags & VIR_DOMAIN_SNAPSHOT_CREATE_HALT)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                   _("redefine and halt flags are mutually exclusive"));
        goto error;
    }
16031

C
Chris Lalancette 已提交
16032 16033 16034 16035 16036 16037 16038 16039
    if (conn->driver->domainSnapshotCreateXML) {
        virDomainSnapshotPtr ret;
        ret = conn->driver->domainSnapshotCreateXML(domain, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }

16040
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16041 16042 16043 16044 16045 16046 16047 16048
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotGetXMLDesc:
 * @snapshot: a domain snapshot object
16049
 * @flags: bitwise-OR of subset of virDomainXMLFlags
C
Chris Lalancette 已提交
16050 16051 16052
 *
 * Provide an XML description of the domain snapshot.
 *
16053 16054 16055 16056 16057
 * 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.
 *
C
Chris Lalancette 已提交
16058 16059 16060 16061 16062 16063 16064 16065
 * 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;
16066
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16067 16068 16069 16070

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16071
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16072 16073
                                  __FUNCTION__);
        virDispatchError(NULL);
16074
        return NULL;
C
Chris Lalancette 已提交
16075 16076 16077 16078 16079
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
16080
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
16081 16082 16083 16084
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

16085
    if (conn->driver->domainSnapshotGetXMLDesc) {
C
Chris Lalancette 已提交
16086
        char *ret;
16087
        ret = conn->driver->domainSnapshotGetXMLDesc(snapshot, flags);
C
Chris Lalancette 已提交
16088 16089 16090 16091 16092
        if (!ret)
            goto error;
        return ret;
    }

16093
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16094 16095 16096 16097 16098 16099 16100 16101
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotNum:
 * @domain: a domain object
16102 16103 16104
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
 *
 * Provides the number of domain snapshots for this domain.
C
Chris Lalancette 已提交
16105
 *
16106
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_ROOTS, then the result is
16107 16108 16109 16110
 * filtered to the number of snapshots that have no parents.  Likewise,
 * if @flags includes VIR_DOMAIN_SNAPSHOT_LIST_LEAVES, then the result is
 * filtered to the number of snapshots that have no children.  Both flags
 * can be used together to find unrelated snapshots.
C
Chris Lalancette 已提交
16111
 *
16112 16113 16114 16115 16116 16117
 * 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 已提交
16118 16119 16120 16121 16122
 */
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
16123

E
Eric Blake 已提交
16124
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
16125 16126 16127 16128

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16129
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141
        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;
    }

16142
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16143 16144 16145 16146 16147 16148 16149 16150 16151 16152
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotListNames:
 * @domain: a domain object
 * @names: array to collect the list of names of snapshots
 * @nameslen: size of @names
16153
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
C
Chris Lalancette 已提交
16154 16155 16156
 *
 * Collect the list of domain snapshots for the given domain, and store
 * their names in @names.  Caller is responsible for freeing each member
16157 16158 16159 16160
 * 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
16161 16162 16163 16164
 * filtered to the number of snapshots that have no parents.  Likewise,
 * if @flags includes VIR_DOMAIN_SNAPSHOT_LIST_LEAVES, then the result is
 * filtered to the number of snapshots that have no children.  Both flags
 * can be used together to find unrelated snapshots.
16165 16166 16167 16168 16169
 *
 * 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 已提交
16170 16171 16172 16173 16174 16175 16176 16177 16178
 *
 * 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;

16179
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%x",
16180
                     names, nameslen, flags);
C
Chris Lalancette 已提交
16181 16182 16183 16184

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16185
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16186 16187 16188 16189 16190 16191 16192
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
16193
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204
        goto error;
    }

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

16205
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16206 16207 16208 16209 16210
error:
    virDispatchError(conn);
    return -1;
}

16211 16212 16213 16214 16215 16216 16217 16218 16219 16220
/**
 * virDomainSnapshotNumChildren:
 * @snapshot: a domain snapshot object
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
 *
 * Provides the number of child snapshots for this domain snapshot.
 *
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS, then the result
 * includes all descendants, otherwise it is limited to direct children.
 *
16221 16222 16223
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_LEAVES, then the result is
 * filtered to the number of snapshots that have no children.
 *
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
 * 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.
 */
int
virDomainSnapshotNumChildren(virDomainSnapshotPtr snapshot, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotListChildrenNames:
 * @snapshot: a domain snapshot object
 * @names: array to collect the list of names of snapshots
 * @nameslen: size of @names
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
 *
 * Collect the list of domain snapshots that are children of the given
 * snapshot, and store their names in @names.  Caller is responsible for
 * freeing each member of the array.  The value to use for @nameslen can
 * be determined by virDomainSnapshotNumChildren() with the same @flags.
 *
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS, then the result
 * includes all descendants, otherwise it is limited to direct children.
 *
16276 16277 16278
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_LEAVES, then the result is
 * filtered to the number of snapshots that have no children.
 *
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
 * 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.
 */
int
virDomainSnapshotListChildrenNames(virDomainSnapshotPtr snapshot,
                                   char **names, int nameslen,
                                   unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("snapshot=%p, names=%p, nameslen=%d, flags=%x",
              snapshot, names, nameslen, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;

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

    if (conn->driver->domainSnapshotListChildrenNames) {
        int ret = conn->driver->domainSnapshotListChildrenNames(snapshot,
                                                                names,
                                                                nameslen,
                                                                flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

C
Chris Lalancette 已提交
16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345
/**
 * 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;
16346

16347
    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%x", name, flags);
C
Chris Lalancette 已提交
16348 16349 16350 16351

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16352
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16353
        virDispatchError(NULL);
16354
        return NULL;
C
Chris Lalancette 已提交
16355 16356 16357 16358 16359
    }

    conn = domain->conn;

    if (name == NULL) {
16360
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371
        goto error;
    }

    if (conn->driver->domainSnapshotLookupByName) {
        virDomainSnapshotPtr dom;
        dom = conn->driver->domainSnapshotLookupByName(domain, name, flags);
        if (!dom)
            goto error;
        return dom;
    }

16372
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390
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;
16391

16392
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
16393 16394 16395 16396

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16397
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408 16409 16410
        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;
    }

16411
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16412 16413 16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432
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;
16433

16434
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
16435 16436 16437 16438

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16439
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16440
        virDispatchError(NULL);
16441
        return NULL;
C
Chris Lalancette 已提交
16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 16453
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

16454
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16455 16456 16457 16458 16459
error:
    virDispatchError(conn);
    return NULL;
}

16460 16461 16462 16463 16464 16465 16466 16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503
/**
 * virDomainSnapshotGetParent:
 * @snapshot: a snapshot object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Get the parent snapshot for @snapshot, if any.
 *
 * Returns a domain snapshot object or NULL in case of failure.  If the
 * given snapshot is a root (no parent), then the VIR_ERR_NO_DOMAIN_SNAPSHOT
 * error is raised.
 */
virDomainSnapshotPtr
virDomainSnapshotGetParent(virDomainSnapshotPtr snapshot,
                           unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
                                  __FUNCTION__);
        virDispatchError(NULL);
        return NULL;
    }

    conn = snapshot->domain->conn;

    if (conn->driver->domainSnapshotGetParent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotGetParent(snapshot, flags);
        if (!snap)
            goto error;
        return snap;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return NULL;
}

C
Chris Lalancette 已提交
16504
/**
16505
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
16506
 * @snapshot: a domain snapshot object
16507
 * @flags: bitwise-OR of virDomainSnapshotRevertFlags
C
Chris Lalancette 已提交
16508 16509 16510
 *
 * Revert the domain to a given snapshot.
 *
16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522
 * 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.
 *
E
Eric Blake 已提交
16523 16524 16525 16526 16527 16528 16529 16530 16531 16532 16533 16534 16535 16536 16537 16538 16539 16540 16541 16542 16543 16544
 * Reverting to any snapshot discards all configuration changes made since
 * the last snapshot.  Additionally, reverting to a snapshot from a running
 * domain is a form of data loss, since it discards whatever is in the
 * guest's RAM at the time.  Since the very nature of keeping snapshots
 * implies the intent to roll back state, no additional confirmation is
 * normally required for these lossy effects.
 *
 * However, there are two particular situations where reverting will
 * be refused by default, and where @flags must include
 * VIR_DOMAIN_SNAPSHOT_REVERT_FORCE to acknowledge the risks.  1) Any
 * attempt to revert to a snapshot that lacks the metadata to perform
 * ABI compatibility checks (generally the case for snapshots that
 * lack a full <domain> when listed by virDomainSnapshotGetXMLDesc(),
 * such as those created prior to libvirt 0.9.5).  2) Any attempt to
 * revert a running domain to an active state that requires starting a
 * new hypervisor instance rather than reusing the existing hypervisor
 * (since this would terminate all connections to the domain, such as
 * such as VNC or Spice graphics) - this condition arises from active
 * snapshots that are provably ABI incomaptible, as well as from
 * inactive snapshots with a @flags request to start the domain after
 * the revert.
 *
C
Chris Lalancette 已提交
16545 16546 16547 16548 16549 16550 16551 16552
 * Returns 0 if the creation is successful, -1 on error.
 */
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
                          unsigned int flags)
{
    virConnectPtr conn;

16553
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16554 16555 16556 16557

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16558
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16559 16560 16561 16562 16563 16564
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
16565 16566 16567 16568
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
16569

16570 16571 16572 16573 16574 16575 16576
    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 已提交
16577 16578 16579 16580 16581 16582 16583
    if (conn->driver->domainRevertToSnapshot) {
        int ret = conn->driver->domainRevertToSnapshot(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16584
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16585 16586 16587 16588 16589 16590
error:
    virDispatchError(conn);
    return -1;
}

/**
16591
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
16592
 * @snapshot: a domain snapshot object
16593
 * @flags: bitwise-or of supported virDomainSnapshotDeleteFlags
C
Chris Lalancette 已提交
16594 16595 16596
 *
 * Delete the snapshot.
 *
16597 16598 16599 16600 16601 16602 16603 16604 16605 16606 16607 16608 16609
 * If @flags is 0, then just this snapshot is deleted, and changes
 * from this snapshot are automatically merged into children
 * snapshots.  If @flags includes VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN,
 * then this snapshot and any descendant snapshots are deleted.  If
 * @flags includes VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY, then any
 * descendant snapshots are deleted, but this snapshot remains.  These
 * two flags are mutually exclusive.
 *
 * 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 已提交
16610
 *
16611 16612
 * Returns 0 if the selected snapshot(s) were successfully deleted,
 * -1 on error.
C
Chris Lalancette 已提交
16613 16614 16615 16616 16617 16618 16619
 */
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
                        unsigned int flags)
{
    virConnectPtr conn;

16620
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16621 16622 16623 16624

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16625
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16626 16627 16628 16629 16630 16631
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
16632 16633 16634 16635
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
16636

16637 16638 16639 16640 16641 16642 16643 16644
    if ((flags & VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN) &&
        (flags & VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("children and children_only flags are "
                            "mutually exclusive"));
        goto error;
    }

C
Chris Lalancette 已提交
16645 16646 16647 16648 16649 16650 16651
    if (conn->driver->domainSnapshotDelete) {
        int ret = conn->driver->domainSnapshotDelete(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16652
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663 16664 16665 16666 16667 16668 16669
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)
{
16670
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
16671 16672 16673 16674

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16675
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16676 16677 16678 16679 16680 16681 16682 16683 16684 16685
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
16686 16687 16688 16689

/**
 * virDomainOpenConsole:
 * @dom: a domain object
16690
 * @dev_name: the console, serial or parallel port device alias, or NULL
16691 16692 16693 16694 16695
 * @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.
16696
 * If the @dev_name is omitted, then the first console or serial
16697 16698 16699 16700 16701 16702 16703
 * 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,
16704
                         const char *dev_name,
16705 16706 16707 16708
                         virStreamPtr st,
                         unsigned int flags)
{
    virConnectPtr conn;
16709

16710 16711
    VIR_DOMAIN_DEBUG(dom, "dev_name=%s, st=%p, flags=%x",
                     NULLSTR(dev_name), st, flags);
16712 16713 16714 16715

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
16716
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
16717 16718 16719 16720 16721 16722
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
16723
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
16724 16725 16726 16727 16728
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
16729
        ret = conn->driver->domainOpenConsole(dom, dev_name, st, flags);
16730 16731 16732 16733 16734
        if (ret < 0)
            goto error;
        return ret;
    }

16735
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
16736 16737 16738 16739 16740

error:
    virDispatchError(conn);
    return -1;
}
16741 16742 16743 16744 16745 16746 16747 16748 16749 16750 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 16858 16859 16860 16861 16862 16863 16864 16865 16866 16867 16868 16869 16870 16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966

/**
 * 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;
}
16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987 16988 16989 16990 16991 16992 16993 16994 16995 16996 16997 16998 16999 17000 17001 17002 17003 17004 17005 17006 17007 17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051


/**
 * virDomainOpenGraphics:
 * @dom: pointer to domain object
 * @idx: index of graphics config to open
 * @fd: file descriptor to attach graphics to
 * @flags: flags to control open operation
 *
 * This will attempt to connect the file descriptor @fd, to
 * the graphics backend of @dom. If @dom has multiple graphics
 * backends configured, then @idx will determine which one is
 * opened, starting from @idx 0.
 *
 * To disable any authentication, pass the VIR_DOMAIN_OPEN_GRAPHICS_SKIPAUTH
 * constant for @flags.
 *
 * The caller should use an anonymous socketpair to open
 * @fd before invocation.
 *
 * This method can only be used when connected to a local
 * libvirt hypervisor, over a UNIX domain socket. Attempts
 * to use this method over a TCP connection will always fail
 *
 * Returns 0 on success, -1 on failure
 */
int virDomainOpenGraphics(virDomainPtr dom,
                          unsigned int idx,
                          int fd,
                          unsigned int flags)
{
    struct stat sb;
    VIR_DOMAIN_DEBUG(dom, "idx=%u, fd=%d, flags=%x",
                     idx, fd, flags);

    virResetLastError();

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

    if (fd < 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (fstat(fd, &sb) < 0) {
        virReportSystemError(errno,
                             _("Unable to access file descriptor %d"), fd);
        goto error;
    }

    if (!S_ISSOCK(sb.st_mode)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("File descriptor %d must be a socket"), fd);
        goto error;
    }

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

    if (!VIR_DRV_SUPPORTS_FEATURE(dom->conn->driver, dom->conn,
                                  VIR_DRV_FEATURE_FD_PASSING)) {
        virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
        goto error;
    }

    if (dom->conn->driver->domainOpenGraphics) {
        int ret;
        ret = dom->conn->driver->domainOpenGraphics(dom, idx, fd, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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