libvirt.c 498.0 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
#include "virnodesuspend.h"
47

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

81 82
#define VIR_FROM_THIS VIR_FROM_NONE

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

89
#define MAX_DRIVERS 20
90

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

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

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

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

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

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

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

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

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

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

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

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

        default:
            return -1;
195 196
        }

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

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

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;

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

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

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

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

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

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

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

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

399
    initialized = 1;
400

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

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

410
    virLogSetFromEnv();
411

412 413
    virNetTLSInit();

414
    VIR_DEBUG("register drivers");
415

416 417 418 419
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

420
    if (!bindtextdomain(PACKAGE, LOCALEDIR))
421
        return -1;
422

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

493
    return 0;
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 527 528
#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
529

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

C
Chris Lalancette 已提交
564

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

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

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

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

594 595
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
596 597
}

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

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

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

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

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

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

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

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

660 661 662 663
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

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

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

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

693 694 695 696
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

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

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

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

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

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

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

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

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


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

777
    if (virInitialize() < 0)
778
        return -1;
779 780

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

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

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

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

801 802
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
803 804
}

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

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

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

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

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

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

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

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

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

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

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

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

A
Atsushi SAKAI 已提交
915
#endif
916

917 918


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

945
    if (!initialized)
946
        if (virInitialize() < 0)
947
            goto error;
948

949
    if (libVer == NULL)
950
        goto error;
951 952
    *libVer = LIBVIR_VERSION_NUMBER;

953
    if (typeVer != NULL)
954 955
        *typeVer = LIBVIR_VERSION_NUMBER;

956
    return 0;
957 958 959 960

error:
    virDispatchError(NULL);
    return -1;
961 962
}

963 964 965 966 967 968 969 970 971 972 973 974 975 976
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",
977 978
                        userdir) < 0) {
            VIR_FREE(userdir);
979
            goto no_memory;
980 981
        }
        VIR_FREE(userdir);
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
    }

    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;
W
Wen Ruo Lv 已提交
998 999
    size_t alias_len;

1000 1001 1002 1003 1004 1005 1006
    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;
W
Wen Ruo Lv 已提交
1007
    alias_len = strlen(alias);
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
    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;
        }

W
Wen Ruo Lv 已提交
1033 1034
        if (alias_len == (offset - entry->str) &&
            STREQLEN(entry->str, alias, alias_len)) {
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 1081 1082 1083 1084
            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;

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

1085
static virConnectPtr
1086 1087
do_open (const char *name,
         virConnectAuthPtr auth,
1088
         unsigned int flags)
1089
{
1090
    int i, res;
1091 1092
    virConnectPtr ret;

1093 1094
    virResetLastError();

1095 1096 1097
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
1098

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

1114
    if (name) {
1115
        char *alias = NULL;
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
        /* 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:///";

1126 1127 1128 1129 1130
        if (!(flags & VIR_CONNECT_NO_ALIASES) &&
            virConnectOpenResolveURIAlias(name, &alias) < 0)
            goto failed;

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

1139
        VIR_DEBUG("name \"%s\" to URI components:\n"
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
                  "  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);
1154
    } else {
1155
        VIR_DEBUG("no name, allowing driver auto-select");
1156 1157
    }

1158 1159 1160
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

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

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

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

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

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

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

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

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

1311
    return ret;
1312 1313

failed:
1314 1315
    virUnrefConnect(ret);

1316
    return NULL;
1317 1318
}

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

1349
    VIR_DEBUG("name=%s", name);
1350 1351 1352 1353 1354 1355 1356 1357
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1358 1359
}

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

1383
    VIR_DEBUG("name=%s", name);
1384 1385 1386 1387 1388 1389 1390 1391
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1392 1393 1394 1395 1396 1397 1398 1399
}

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

1421
    VIR_DEBUG("name=%s, auth=%p, flags=%x", NULLSTR(name), auth, flags);
1422 1423 1424 1425 1426 1427 1428 1429
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1430 1431 1432
}

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

1464 1465 1466
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1467
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1468
        goto error;
1469
    }
1470

1471 1472 1473 1474 1475 1476 1477 1478
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

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

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

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

1523 1524 1525
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1526
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1527
        virDispatchError(NULL);
1528
        return -1;
1529
    }
1530

1531 1532 1533 1534
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1535 1536

    if (ret < 0)
1537
        virDispatchError(conn);
1538

1539
    return ret;
1540 1541
}

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

1559 1560
    virResetLastError();

D
Daniel Veillard 已提交
1561
    if (!VIR_IS_CONNECT(conn)) {
1562
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1563
        virDispatchError(NULL);
1564
        return NULL;
D
Daniel Veillard 已提交
1565
    }
1566 1567 1568 1569

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1570
    }
1571
    return conn->driver->name;
1572 1573
}

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

1592 1593
    virResetLastError();

D
Daniel Veillard 已提交
1594
    if (!VIR_IS_CONNECT(conn)) {
1595
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1596
        virDispatchError(NULL);
1597
        return -1;
D
Daniel Veillard 已提交
1598
    }
1599

D
Daniel Veillard 已提交
1600
    if (hvVer == NULL) {
1601
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1602
        goto error;
D
Daniel Veillard 已提交
1603
    }
1604

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

1612
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1613 1614

error:
1615
    virDispatchError(conn);
1616
    return -1;
1617 1618
}

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

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1639
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1640
        virDispatchError(NULL);
1641 1642 1643 1644
        return -1;
    }

    if (libVer == NULL) {
1645
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
        goto error;
    }

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

1656 1657 1658
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1659
error:
1660
    virDispatchError(conn);
1661 1662 1663
    return ret;
}

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

1681 1682
    virResetLastError();

1683
    if (!VIR_IS_CONNECT(conn)) {
1684
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1685
        virDispatchError(NULL);
1686 1687 1688
        return NULL;
    }

1689 1690 1691 1692 1693 1694
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1695

1696
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1697 1698

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

1724 1725
    virResetLastError();

1726
    if (!VIR_IS_CONNECT(conn)) {
1727
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1728
        virDispatchError(NULL);
1729 1730 1731
        return NULL;
    }

1732
    name = (char *)xmlSaveUri(conn->uri);
1733
    if (!name) {
1734
        virReportOOMError();
1735
        goto error;
1736 1737
    }
    return name;
1738 1739

error:
1740
    virDispatchError(conn);
1741
    return NULL;
1742 1743
}

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

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

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

1801 1802
    virResetLastError();

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

1809 1810 1811 1812 1813 1814
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1815

1816
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1817
error:
1818
    virDispatchError(conn);
1819
    return -1;
1820 1821
}

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

1837 1838
    virResetLastError();

D
Daniel Veillard 已提交
1839
    if (!VIR_IS_CONNECT(conn)) {
1840
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1841
        virDispatchError(NULL);
1842
        return -1;
D
Daniel Veillard 已提交
1843
    }
1844

1845
    if ((ids == NULL) || (maxids < 0)) {
1846
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1847
        goto error;
D
Daniel Veillard 已提交
1848
    }
1849

1850 1851 1852 1853 1854 1855
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1856

1857
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1858
error:
1859
    virDispatchError(conn);
1860
    return -1;
D
Daniel Veillard 已提交
1861 1862
}

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

1876 1877
    virResetLastError();

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

1884 1885 1886 1887 1888 1889
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1890

1891
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1892
error:
1893
    virDispatchError(conn);
1894
    return -1;
K
 
Karel Zak 已提交
1895 1896
}

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

1916 1917 1918
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1919
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1920
        virDispatchError(NULL);
1921 1922 1923 1924 1925
        return NULL;
    }
    return dom->conn;
}

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

1958 1959
    virResetLastError();

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

1974 1975 1976 1977 1978 1979 1980
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1981

1982
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1983
error:
1984
    virDispatchError(conn);
1985
    return NULL;
D
Daniel Veillard 已提交
1986 1987
}

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

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

2024 2025
    virResetLastError();

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

2036 2037 2038 2039 2040 2041 2042
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
2043

2044
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2045 2046

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

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

2066 2067
    virResetLastError();

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

2078 2079 2080 2081 2082 2083 2084
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
2085

2086
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2087 2088

error:
2089
    virDispatchError(conn);
2090
    return NULL;
2091 2092
}

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

2109 2110
    virResetLastError();

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

    if (virUUIDParse(uuidstr, uuid) < 0) {
2122
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2123
        goto error;
K
Karel Zak 已提交
2124
    }
2125

K
Karel Zak 已提交
2126
    return virDomainLookupByUUID(conn, &uuid[0]);
2127 2128

error:
2129
    virDispatchError(conn);
2130
    return NULL;
K
Karel Zak 已提交
2131 2132
}

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

2148 2149
    virResetLastError();

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

2160 2161 2162 2163 2164 2165 2166
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2167

2168
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2169 2170

error:
2171
    virDispatchError(conn);
2172
    return NULL;
2173 2174
}

D
Daniel Veillard 已提交
2175
/**
2176
 * virDomainDestroy:
D
Daniel Veillard 已提交
2177 2178 2179
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
2180 2181 2182
 * 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 已提交
2183
 *
2184 2185 2186 2187
 * 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 已提交
2188
 * Returns 0 in case of success and -1 in case of failure.
2189
 */
D
Daniel Veillard 已提交
2190
int
2191 2192
virDomainDestroy(virDomainPtr domain)
{
2193
    virConnectPtr conn;
2194

2195
    VIR_DOMAIN_DEBUG(domain);
2196

2197 2198
    virResetLastError();

D
Daniel Veillard 已提交
2199
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2200
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2201
        virDispatchError(NULL);
2202
        return -1;
D
Daniel Veillard 已提交
2203
    }
2204

2205
    conn = domain->conn;
2206
    if (conn->flags & VIR_CONNECT_RO) {
2207
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2208
        goto error;
2209
    }
2210

2211 2212 2213 2214 2215 2216 2217
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2218

2219
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2220 2221

error:
2222
    virDispatchError(conn);
2223
    return -1;
2224 2225
}

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

E
Eric Blake 已提交
2249
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
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 2276 2277 2278 2279

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

2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
/**
 * 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
2290 2291
virDomainFree(virDomainPtr domain)
{
2292
    VIR_DOMAIN_DEBUG(domain);
2293

2294 2295 2296
    virResetLastError();

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

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


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

2358
    VIR_DOMAIN_DEBUG(domain);
2359

2360 2361
    virResetLastError();

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

2372 2373
    conn = domain->conn;

2374 2375 2376 2377 2378 2379 2380
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2381

2382
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2383 2384

error:
2385
    virDispatchError(domain->conn);
2386
    return -1;
D
Daniel Veillard 已提交
2387 2388 2389
}

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

2404
    VIR_DOMAIN_DEBUG(domain);
2405

2406 2407
    virResetLastError();

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

2418 2419
    conn = domain->conn;

2420 2421 2422 2423 2424 2425 2426
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2427

2428
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2429 2430

error:
2431
    virDispatchError(domain->conn);
2432
    return -1;
D
Daniel Veillard 已提交
2433 2434
}

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

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

2458 2459
    virResetLastError();

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

2475 2476 2477
    if (conn->driver->domainSave) {
        int ret;
        char *absolute_to;
2478

2479 2480 2481 2482 2483 2484
        /* 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;
        }
2485

2486 2487 2488
        ret = conn->driver->domainSave(domain, absolute_to);

        VIR_FREE(absolute_to);
2489

2490 2491 2492 2493
        if (ret < 0)
            goto error;
        return ret;
    }
2494

2495
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2496 2497

error:
2498
    virDispatchError(domain->conn);
2499
    return -1;
2500 2501
}

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

2563 2564 2565 2566 2567 2568
    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;
    }

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

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

2612 2613
    virResetLastError();

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

2628 2629 2630
    if (conn->driver->domainRestore) {
        int ret;
        char *absolute_from;
2631

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

2639 2640 2641 2642
        ret = conn->driver->domainRestore(conn, absolute_from);

        VIR_FREE(absolute_from);

2643 2644 2645 2646
        if (ret < 0)
            goto error;
        return ret;
    }
2647

2648
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2649 2650

error:
2651
    virDispatchError(conn);
2652
    return -1;
D
Daniel Veillard 已提交
2653 2654
}

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

2707 2708 2709 2710 2711 2712
    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;
    }

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

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 2813 2814 2815 2816
/**
 * 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
2817
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
 *
 * 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.
 *
2829 2830 2831 2832 2833 2834 2835
 * 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.
 *
2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860
 * 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;
    }

2861 2862 2863 2864 2865 2866
    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;
    }

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

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

2927 2928
    virResetLastError();

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

2944 2945 2946 2947 2948 2949
    if ((flags & VIR_DUMP_CRASH) && (flags & VIR_DUMP_LIVE)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("crash and live flags are mutually exclusive"));
        goto error;
    }

2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961
    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;
    }

2962 2963 2964
    if (conn->driver->domainCoreDump) {
        int ret;
        char *absolute_to;
D
Daniel Veillard 已提交
2965

2966 2967 2968 2969
        /* 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"));
2970 2971
            goto error;
        }
D
Daniel Veillard 已提交
2972

2973 2974 2975
        ret = conn->driver->domainCoreDump(domain, absolute_to, flags);

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

2977 2978 2979 2980
        if (ret < 0)
            goto error;
        return ret;
    }
2981

2982
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2983 2984

error:
2985
    virDispatchError(domain->conn);
2986
    return -1;
2987 2988
}

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

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

3054 3055 3056 3057
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
3058
 * Shutdown a domain, the domain object is still usable thereafter but
3059
 * the domain OS is being stopped. Note that the guest OS may ignore the
3060 3061 3062 3063 3064
 * 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.
3065
 *
3066 3067 3068
 * If the domain is transient and has any snapshot metadata (see
 * virDomainSnapshotNum()), then that metadata will automatically
 * be deleted when the domain quits.
3069 3070 3071 3072
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3073 3074
virDomainShutdown(virDomainPtr domain)
{
3075
    virConnectPtr conn;
3076

3077
    VIR_DOMAIN_DEBUG(domain);
3078

3079 3080
    virResetLastError();

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

3091 3092
    conn = domain->conn;

3093 3094 3095 3096 3097 3098 3099
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3100

3101
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3102 3103

error:
3104
    virDispatchError(domain->conn);
3105
    return -1;
3106 3107
}

3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121
/**
 * 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)
{
3122
    virConnectPtr conn;
3123

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

3126 3127
    virResetLastError();

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

3138 3139
    conn = domain->conn;

3140 3141 3142 3143 3144 3145 3146
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
3147

3148
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
X
Xu He Jie 已提交
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 3195 3196 3197 3198

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__);
3199 3200

error:
3201
    virDispatchError(domain->conn);
3202
    return -1;
3203 3204
}

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

3219 3220
    virResetLastError();

D
Daniel Veillard 已提交
3221
    if (!VIR_IS_DOMAIN(domain)) {
3222
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3223
        virDispatchError(NULL);
3224
        return NULL;
D
Daniel Veillard 已提交
3225
    }
3226
    return domain->name;
3227 3228
}

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

3243 3244
    virResetLastError();

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

3256 3257
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

3258
    return 0;
3259 3260
}

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

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

3278 3279
    virResetLastError();

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

K
Karel Zak 已提交
3290
    if (virDomainGetUUID(domain, &uuid[0]))
3291
        goto error;
K
Karel Zak 已提交
3292

3293
    virUUIDFormat(uuid, buf);
3294
    return 0;
3295 3296

error:
3297
    virDispatchError(domain->conn);
3298
    return -1;
K
Karel Zak 已提交
3299 3300
}

3301
/**
3302
 * virDomainGetID:
3303 3304 3305 3306 3307 3308 3309
 * @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
3310 3311
virDomainGetID(virDomainPtr domain)
{
3312
    VIR_DOMAIN_DEBUG(domain);
3313

3314 3315
    virResetLastError();

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

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

3338
    VIR_DOMAIN_DEBUG(domain);
3339

3340 3341 3342
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3343
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3344
        virDispatchError(NULL);
3345
        return NULL;
D
Daniel Veillard 已提交
3346
    }
3347

3348 3349
    conn = domain->conn;

3350 3351 3352 3353 3354 3355 3356
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
3357

3358
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3359 3360

error:
3361
    virDispatchError(domain->conn);
3362
    return NULL;
3363 3364
}

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

3380
    VIR_DOMAIN_DEBUG(domain);
3381

3382 3383
    virResetLastError();

D
Daniel Veillard 已提交
3384
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3385
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3386
        virDispatchError(NULL);
3387
        return 0;
D
Daniel Veillard 已提交
3388
    }
3389

3390 3391
    conn = domain->conn;

3392 3393 3394 3395 3396 3397 3398
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
3399

3400
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3401 3402

error:
3403
    virDispatchError(domain->conn);
3404
    return 0;
3405 3406
}

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

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

3430 3431
    virResetLastError();

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

3447 3448 3449 3450 3451 3452 3453
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3454

3455
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3456 3457

error:
3458
    virDispatchError(domain->conn);
3459
    return -1;
3460
}
3461

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

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

3484 3485
    virResetLastError();

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

    conn = domain->conn;
3501

3502 3503 3504 3505 3506 3507 3508
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
3509

3510
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3511 3512

error:
3513
    virDispatchError(domain->conn);
3514
    return -1;
D
Daniel Veillard 已提交
3515 3516
}

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

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

3564
    if (!memory) {
3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578
        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;
    }

3579 3580
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

3581 3582 3583 3584 3585
error:
    virDispatchError(domain->conn);
    return -1;
}

E
Eric Blake 已提交
3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629
/* Helper function called to validate incoming client array on any
 * interface that sets typed parameters in the hypervisor.  */
static int
virTypedParameterValidateSet(virDomainPtr domain,
                             virTypedParameterPtr params,
                             int nparams)
{
    bool string_okay;
    int i;

    string_okay = VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver,
                                           domain->conn,
                                           VIR_DRV_FEATURE_TYPED_PARAM_STRING);
    for (i = 0; i < nparams; i++) {
        if (strnlen(params[i].field, VIR_TYPED_PARAM_FIELD_LENGTH) ==
            VIR_TYPED_PARAM_FIELD_LENGTH) {
            virLibDomainError(VIR_ERR_INVALID_ARG,
                              _("string parameter name '%.*s' too long"),
                              VIR_TYPED_PARAM_FIELD_LENGTH,
                              params[i].field);
            virDispatchError(NULL);
            return -1;
        }
        if (params[i].type == VIR_TYPED_PARAM_STRING) {
            if (string_okay) {
                if (!params[i].value.s) {
                    virLibDomainError(VIR_ERR_INVALID_ARG,
                                      _("NULL string parameter '%s'"),
                                      params[i].field);
                    virDispatchError(NULL);
                    return -1;
                }
            } else {
                virLibDomainError(VIR_ERR_INVALID_ARG,
                                  _("string parameter '%s' unsupported"),
                                  params[i].field);
                virDispatchError(NULL);
                return -1;
            }
        }
    }
    return 0;
}

3630 3631 3632 3633
/**
 * virDomainSetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter objects
3634
 * @nparams: number of memory parameter (this value can be the same or
3635
 *          less than the number of parameters supported)
3636
 * @flags: bitwise-OR of virDomainModificationImpact
3637
 *
3638
 * Change all or a subset of the memory tunables.
3639
 * This function may require privileged access to the hypervisor.
3640 3641 3642 3643 3644
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetMemoryParameters(virDomainPtr domain,
3645
                             virTypedParameterPtr params,
3646 3647 3648
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;
3649

3650
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3651
                     params, nparams, flags);
3652 3653 3654 3655

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3656
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3657 3658 3659 3660
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
3661
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3662 3663 3664
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
3665
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3666 3667
        goto error;
    }
E
Eric Blake 已提交
3668 3669 3670
    if (virTypedParameterValidateSet(domain, params, nparams) < 0)
        return -1;

3671 3672 3673 3674 3675 3676 3677 3678 3679 3680
    conn = domain->conn;

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

3681
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692

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

/**
 * virDomainGetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter object
 *          (return value, allocated by the caller)
3693
 * @nparams: pointer to number of memory parameters; input and output
E
Eric Blake 已提交
3694
 * @flags: bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
3695
 *
3696 3697 3698 3699
 * Get all memory parameters.  On input, @nparams gives the size of the
 * @params array; on output, @nparams gives how many slots were filled
 * with parameter information, which might be less but will not exceed
 * the input value.
3700
 *
3701 3702 3703
 * As a special case, calling with @params as NULL and @nparams as 0 on
 * input will cause @nparams on output to contain the number of parameters
 * supported by the hypervisor. The caller should then allocate @params
3704
 * array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
3705 3706
 * again.
 *
3707
 * Here is a sample code snippet:
3708 3709 3710
 *
 * if ((virDomainGetMemoryParameters(dom, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
3711 3712
 *     if ((params = malloc(sizeof(*params) * nparams)) == NULL)
 *         goto error;
3713
 *     memset(params, 0, sizeof(*params) * nparams);
3714
 *     if (virDomainGetMemoryParameters(dom, params, &nparams, 0))
3715 3716
 *         goto error;
 * }
3717
 *
3718
 * This function may require privileged access to the hypervisor. This function
3719
 * expects the caller to allocate the @params.
3720 3721 3722 3723 3724
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
3725
                             virTypedParameterPtr params,
3726 3727 3728
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
3729

3730
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3731
                     params, (nparams) ? *nparams : -1, flags);
3732 3733 3734 3735

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3736
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3737 3738 3739
        virDispatchError(NULL);
        return -1;
    }
3740 3741
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3742
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3743 3744
        goto error;
    }
E
Eric Blake 已提交
3745 3746 3747
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_TYPED_PARAM_STRING))
        flags |= VIR_TYPED_PARAM_STRING_OKAY;
3748 3749 3750 3751 3752 3753 3754

    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) &&
        (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3755 3756 3757 3758 3759 3760 3761 3762 3763
    conn = domain->conn;

    if (conn->driver->domainGetMemoryParameters) {
        int ret;
        ret = conn->driver->domainGetMemoryParameters (domain, params, nparams, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
3764
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3765 3766 3767 3768 3769 3770

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

3771 3772 3773 3774
/**
 * virDomainSetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter objects
3775
 * @nparams: number of blkio parameters (this value can be the same or
3776
 *          less than the number of parameters supported)
E
Eric Blake 已提交
3777
 * @flags: bitwise-OR of virDomainModificationImpact
3778
 *
3779
 * Change all or a subset of the blkio tunables.
3780
 * This function may require privileged access to the hypervisor.
3781 3782 3783 3784 3785
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetBlkioParameters(virDomainPtr domain,
3786
                             virTypedParameterPtr params,
3787 3788 3789 3790
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;

3791
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808
                     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;
    }
E
Eric Blake 已提交
3809 3810 3811
    if (virTypedParameterValidateSet(domain, params, nparams) < 0)
        return -1;

3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
    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)
3834
 * @nparams: pointer to number of blkio parameters; input and output
E
Eric Blake 已提交
3835
 * @flags: bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
3836
 *
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848
 * Get all blkio parameters.  On input, @nparams gives the size of the
 * @params array; on output, @nparams gives how many slots were filled
 * with parameter information, which might be less but will not exceed
 * the input value.
 *
 * As a special case, calling with @params as NULL and @nparams as 0 on
 * input will cause @nparams on output to contain the number of parameters
 * supported by the hypervisor. The caller should then allocate @params
 * array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
 * again.
 *
 * See virDomainGetMemoryParameters() for an equivalent usage example.
3849
 *
3850
 * This function may require privileged access to the hypervisor. This function
3851 3852 3853 3854 3855 3856
 * expects the caller to allocate the @params.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetBlkioParameters(virDomainPtr domain,
3857
                             virTypedParameterPtr params,
3858 3859 3860 3861
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;

3862
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
3863 3864 3865 3866 3867 3868 3869 3870 3871
                     params, (nparams) ? *nparams : -1, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
3872 3873
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3874 3875 3876
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
E
Eric Blake 已提交
3877 3878 3879
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_TYPED_PARAM_STRING))
        flags |= VIR_TYPED_PARAM_STRING_OKAY;
3880 3881 3882 3883 3884 3885 3886

    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) &&
        (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902
    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;
}

3903 3904
/**
 * virDomainGetInfo:
3905
 * @domain: a domain object
3906
 * @info: pointer to a virDomainInfo structure allocated by the user
3907
 *
3908
 * Extract information about a domain. Note that if the connection
3909
 * used to get the domain is limited only a partial set of the information
3910 3911 3912 3913 3914
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3915 3916
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3917
    virConnectPtr conn;
3918 3919

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

3921 3922
    virResetLastError();

D
Daniel Veillard 已提交
3923
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3924
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3925
        virDispatchError(NULL);
3926
        return -1;
D
Daniel Veillard 已提交
3927 3928
    }
    if (info == NULL) {
3929
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3930
        goto error;
D
Daniel Veillard 已提交
3931
    }
3932

3933
    memset(info, 0, sizeof(virDomainInfo));
3934

3935 3936
    conn = domain->conn;

3937 3938 3939 3940 3941 3942 3943
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3944

3945
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3946 3947

error:
3948
    virDispatchError(domain->conn);
3949
    return -1;
3950
}
3951

3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972
/**
 * 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 已提交
3973 3974
    VIR_DOMAIN_DEBUG(domain, "state=%p, reason=%p, flags=%x",
                     state, reason, flags);
3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992

    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)
3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020
            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 已提交
4021
    VIR_DOMAIN_DEBUG(domain, "info=%p, flags=%x", info, flags);
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040

    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)
4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

4052 4053 4054
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
4055
 * @flags: an OR'ed set of virDomainXMLFlags
4056 4057
 *
 * Provide an XML description of the domain. The description may be reused
4058
 * later to relaunch the domain with virDomainCreateXML().
4059
 *
4060 4061 4062 4063 4064 4065 4066 4067 4068 4069
 * 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.
 *
4070 4071 4072 4073
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
4074
virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)
4075
{
4076
    virConnectPtr conn;
4077

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

4080 4081 4082
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4083
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4084
        virDispatchError(NULL);
4085
        return NULL;
D
Daniel Veillard 已提交
4086
    }
4087

4088 4089
    conn = domain->conn;

4090
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
4091
        virLibConnError(VIR_ERR_OPERATION_DENIED,
4092 4093 4094 4095
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

4096
    if (conn->driver->domainGetXMLDesc) {
4097
        char *ret;
4098
        ret = conn->driver->domainGetXMLDesc(domain, flags);
4099 4100 4101 4102
        if (!ret)
            goto error;
        return ret;
    }
4103

4104
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4105 4106

error:
4107
    virDispatchError(domain->conn);
4108
    return NULL;
4109
}
4110

4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129
/**
 * 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 已提交
4130
    VIR_DEBUG("conn=%p, format=%s, config=%s, flags=%x",
4131
              conn, nativeFormat, nativeConfig, flags);
4132 4133 4134 4135

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4136
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4137
        virDispatchError(NULL);
4138
        return NULL;
4139 4140 4141
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
4142
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4143
        goto error;
4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156
    }

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

4157
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4158 4159

error:
4160
    virDispatchError(conn);
4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171
    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 已提交
4172
 * a native configuration file describing the domain.
4173 4174 4175 4176 4177 4178 4179 4180 4181 4182
 * 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 已提交
4183
    VIR_DEBUG("conn=%p, format=%s, xml=%s, flags=%x",
4184
              conn, nativeFormat, domainXml, flags);
4185 4186 4187 4188

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4189
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4190
        virDispatchError(NULL);
4191
        return NULL;
4192
    }
4193 4194 4195 4196
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
4197 4198

    if (nativeFormat == NULL || domainXml == NULL) {
4199
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4200
        goto error;
4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
    }

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

4214
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4215 4216

error:
4217
    virDispatchError(conn);
4218 4219 4220 4221
    return NULL;
}


4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237
/*
 * 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
 *
 */
4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248
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;
4249 4250
    int cookielen = 0, ret;
    virDomainInfo info;
4251
    VIR_DOMAIN_DEBUG(domain,
E
Eric Blake 已提交
4252
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4253
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4254 4255 4256 4257 4258

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276

    /* 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) {
4277
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308
                         _("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;
}

4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327
/*
 * 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
 *
 */
4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340
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;
4341
    virDomainInfo info;
4342
    virErrorPtr orig_err = NULL;
4343
    int cancelled;
4344
    VIR_DOMAIN_DEBUG(domain,
E
Eric Blake 已提交
4345
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4346
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363

    /* 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.
     */
4364
    if (!domain->conn->driver->domainGetXMLDesc) {
4365
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
4366
        virDispatchError(domain->conn);
4367 4368
        return NULL;
    }
4369 4370 4371
    dom_xml = domain->conn->driver->domainGetXMLDesc(domain,
                                                     VIR_DOMAIN_XML_SECURE |
                                                     VIR_DOMAIN_XML_UPDATE_CPU);
4372 4373 4374
    if (!dom_xml)
        return NULL;

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

4380
    VIR_DEBUG("Prepare2 %p flags=%lx", dconn, flags);
4381 4382 4383 4384 4385 4386 4387 4388
    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) {
4389
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
4390
                         _("domainMigratePrepare2 did not set uri"));
4391
        virDispatchError(domain->conn);
4392 4393
        cancelled = 1;
        goto finish;
4394 4395 4396 4397 4398 4399 4400
    }
    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.
     */
4401
    VIR_DEBUG("Perform %p", domain->conn);
4402 4403 4404
    ret = domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth);

4405 4406 4407 4408
    /* Perform failed. Make sure Finish doesn't overwrite the error */
    if (ret < 0)
        orig_err = virSaveLastError();

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

finish:
4415 4416 4417 4418 4419
    /* 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;
4420
    VIR_DEBUG("Finish2 %p ret=%d", dconn, ret);
4421
    ddomain = dconn->driver->domainMigrateFinish2
4422
        (dconn, dname, cookie, cookielen, uri, flags, cancelled);
4423 4424

 done:
4425 4426 4427 4428
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
4429 4430 4431 4432 4433
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

4434

4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461
/*
 * 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,
4462
                         const char *xmlin,
4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477
                         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;
4478 4479
    int cancelled = 1;
    unsigned long protection = 0;
4480
    bool notify_source = true;
4481

4482
    VIR_DOMAIN_DEBUG(domain, "dconn=%p xmlin=%s, flags=%lx, "
4483 4484 4485
                     "dname=%s, uri=%s, bandwidth=%lu",
                     dconn, NULLSTR(xmlin), flags,
                     NULLSTR(dname), NULLSTR(uri), bandwidth);
4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496

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

4497 4498 4499 4500
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATE_CHANGE_PROTECTION))
        protection = VIR_MIGRATE_CHANGE_PROTECTION;

4501 4502
    VIR_DEBUG("Begin3 %p", domain->conn);
    dom_xml = domain->conn->driver->domainMigrateBegin3
4503
        (domain, xmlin, &cookieout, &cookieoutlen,
4504
         flags | protection, dname, bandwidth);
4505 4506 4507 4508 4509 4510 4511 4512
    if (!dom_xml)
        goto done;

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

4513
    VIR_DEBUG("Prepare3 %p flags=%lx", dconn, flags);
4514 4515 4516 4517 4518 4519 4520 4521
    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);
4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532
    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;
        }
    }
4533 4534 4535 4536 4537

    if (uri == NULL && uri_out == NULL) {
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("domainMigratePrepare3 did not set uri"));
        virDispatchError(domain->conn);
4538
        goto finish;
4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553
    }
    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;
4554
    /* dconnuri not relevant in non-P2P modes, so left NULL here */
4555
    ret = domain->conn->driver->domainMigratePerform3
4556
        (domain, NULL, cookiein, cookieinlen,
4557
         &cookieout, &cookieoutlen, NULL,
4558
         uri, flags | protection, dname, bandwidth);
4559 4560

    /* Perform failed. Make sure Finish doesn't overwrite the error */
4561
    if (ret < 0) {
4562
        orig_err = virSaveLastError();
4563 4564 4565 4566 4567
        /* Perform failed so we don't need to call confirm to let source know
         * about the failure.
         */
        notify_source = false;
    }
4568 4569 4570 4571 4572 4573

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

4574
finish:
4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587
    /*
     * 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;
4588
    ddomain = dconn->driver->domainMigrateFinish3
4589
        (dconn, dname, cookiein, cookieinlen, &cookieout, &cookieoutlen,
4590 4591 4592 4593 4594 4595 4596 4597 4598
         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.
4599
     */
4600
    cancelled = ddomain == NULL ? 1 : 0;
4601

4602 4603 4604 4605 4606 4607
    /* 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();

4608
confirm:
4609
    /*
4610 4611 4612
     * 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.
4613
     */
4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632
    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);
        }
    }
4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645

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


4646
 /*
4647
  * In normal migration, the libvirt client co-ordinates communication
4648
  * between the 2 libvirtd instances on source & dest hosts.
4649
  *
4650 4651 4652 4653
  * 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.
4654 4655 4656
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
4657
                           const char *xmlin,
4658 4659
                           unsigned long flags,
                           const char *dname,
4660
                           const char *dconnuri,
4661 4662 4663
                           const char *uri,
                           unsigned long bandwidth)
{
4664
    xmlURIPtr tempuri = NULL;
4665
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s, flags=%lx, dname=%s, "
4666 4667 4668
                     "dconnuri=%s, uri=%s, bandwidth=%lu",
                     NULLSTR(xmlin), flags, NULLSTR(dname),
                     NULLSTR(dconnuri), 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;
    }

4676
    tempuri = xmlParseURI(dconnuri);
4677
    if (!tempuri) {
4678
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4679 4680 4681 4682 4683
        virDispatchError(domain->conn);
        return -1;
    }

    if (!tempuri->server || STRPREFIX(tempuri->server, "localhost")) {
4684
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4685 4686 4687 4688 4689 4690
        virDispatchError(domain->conn);
        xmlFreeURI(tempuri);
        return -1;
    }
    xmlFreeURI(tempuri);

4691 4692 4693
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
4694 4695 4696 4697
    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,
4698
                                                           xmlin,
4699 4700 4701 4702
                                                           NULL, /* cookiein */
                                                           0,    /* cookieinlen */
                                                           NULL, /* cookieoutlen */
                                                           NULL, /* cookieoutlen */
4703
                                                           dconnuri,
4704 4705 4706 4707 4708 4709
                                                           uri,
                                                           flags,
                                                           dname,
                                                           bandwidth);
    } else {
        VIR_DEBUG("Using migration protocol 2");
4710 4711 4712 4713 4714
        if (xmlin) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to change target guest XML during migration"));
            return -1;
        }
4715 4716 4717 4718 4719
        if (uri) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to override peer2peer migration URI"));
            return -1;
        }
4720 4721 4722
        return domain->conn->driver->domainMigratePerform(domain,
                                                          NULL, /* cookie */
                                                          0,    /* cookielen */
4723
                                                          dconnuri,
4724 4725 4726 4727
                                                          flags,
                                                          dname,
                                                          bandwidth);
    }
4728 4729 4730
}


C
Chris Lalancette 已提交
4731
/*
4732
 * In normal migration, the libvirt client co-ordinates communication
4733
 * between the 2 libvirtd instances on source & dest hosts.
C
Chris Lalancette 已提交
4734
 *
4735 4736 4737
 * Some hypervisors support an alternative, direct migration where
 * there is no requirement for a libvirtd instance on the dest host.
 * In this case
4738
 *
4739 4740
 * 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 已提交
4741
 */
4742 4743
static int
virDomainMigrateDirect (virDomainPtr domain,
4744
                        const char *xmlin,
4745 4746 4747 4748 4749
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
4750 4751 4752 4753
    VIR_DOMAIN_DEBUG(domain,
                     "xmlin=%s, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
                     NULLSTR(xmlin), flags, NULLSTR(dname), NULLSTR(uri),
                     bandwidth);
4754

4755
    if (!domain->conn->driver->domainMigratePerform) {
4756
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4757
        virDispatchError(domain->conn);
4758 4759 4760
        return -1;
    }

C
Chris Lalancette 已提交
4761 4762 4763
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
4764 4765 4766
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_MIGRATION_V3)) {
        VIR_DEBUG("Using migration protocol 3");
4767 4768
        /* dconn URI not relevant in direct migration, since no
         * target libvirtd is involved */
4769
        return domain->conn->driver->domainMigratePerform3(domain,
4770
                                                           xmlin,
4771 4772 4773 4774
                                                           NULL, /* cookiein */
                                                           0,    /* cookieinlen */
                                                           NULL, /* cookieoutlen */
                                                           NULL, /* cookieoutlen */
4775
                                                           NULL, /* dconnuri */
4776 4777 4778 4779 4780 4781
                                                           uri,
                                                           flags,
                                                           dname,
                                                           bandwidth);
    } else {
        VIR_DEBUG("Using migration protocol 2");
4782 4783 4784 4785 4786
        if (xmlin) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("Unable to change target guest XML during migration"));
            return -1;
        }
4787 4788 4789 4790 4791 4792 4793 4794
        return domain->conn->driver->domainMigratePerform(domain,
                                                          NULL, /* cookie */
                                                          0,    /* cookielen */
                                                          uri,
                                                          flags,
                                                          dname,
                                                          bandwidth);
    }
C
Chris Lalancette 已提交
4795 4796
}

4797

4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810
/**
 * 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:
4811 4812 4813
 *   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 已提交
4814 4815 4816 4817
 *   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.
4818
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
4819 4820 4821
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
4822 4823 4824 4825 4826
 *
 * 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.
4827 4828 4829 4830 4831 4832
 *
 * 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.
 *
4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843
 * 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.
 *
4844
 * In either case it is typically only necessary to specify a
4845 4846
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874
 *
 * 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;
4875

4876 4877
    VIR_DOMAIN_DEBUG(domain,
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
4878
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4879

4880 4881
    virResetLastError();

4882
    /* First checkout the source */
4883
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4884
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4885
        virDispatchError(NULL);
4886 4887
        return NULL;
    }
4888
    if (domain->conn->flags & VIR_CONNECT_RO) {
4889
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4890
        goto error;
4891 4892
    }

4893 4894
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
4895
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4896 4897 4898 4899
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
4900
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4901 4902 4903
        goto error;
    }

4904 4905 4906 4907 4908 4909
    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);
4910
                if (!dstURI)
4911 4912
                    return NULL;
            }
4913

4914
            VIR_DEBUG("Using peer2peer migration");
4915
            if (virDomainMigratePeer2Peer(domain, NULL, flags, dname,
4916
                                          uri ? uri : dstURI, NULL, bandwidth) < 0) {
4917 4918 4919 4920
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
4921

4922 4923 4924
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
4925
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4926 4927
            goto error;
        }
4928
    } else {
4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941
        /* 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;
4942
        if (flags & VIR_MIGRATE_TUNNELLED) {
4943
            virLibConnError(VIR_ERR_OPERATION_INVALID,
4944 4945 4946 4947
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
4948 4949
        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
4950
                                     VIR_DRV_FEATURE_MIGRATION_V3) &&
C
Chris Lalancette 已提交
4951
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
4952 4953
                                     VIR_DRV_FEATURE_MIGRATION_V3)) {
            VIR_DEBUG("Using migration protocol 3");
4954 4955
            ddomain = virDomainMigrateVersion3(domain, dconn, NULL,
                                               flags, dname, uri, bandwidth);
4956 4957 4958 4959 4960
        } 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");
4961 4962
            ddomain = virDomainMigrateVersion2(domain, dconn, flags,
                                               dname, uri, bandwidth);
4963 4964 4965 4966 4967
        } 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");
4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009
            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.
5010 5011 5012
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
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 5045 5046 5047 5048 5049 5050 5051 5052
 *
 * 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.
 *
5053 5054 5055 5056 5057 5058 5059 5060
 * 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.
5061 5062 5063
 * @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.
5064
 *
5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079
 * 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;

5080 5081
    VIR_DOMAIN_DEBUG(domain,
                     "dconn=%p, flags=%lx, dname=%s, uri=%s, bandwidth=%lu",
5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129
                     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 {
5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142
        /* 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;
5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180
        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);
5181
        } else {
5182
            /* This driver does not support any migration method */
5183
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
5184 5185
            goto error;
        }
5186 5187
    }

5188 5189
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
5190

5191
    return ddomain;
5192 5193

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

5198 5199 5200 5201 5202 5203 5204 5205 5206 5207

/**
 * 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 已提交
5208
 * host given by duri.
5209 5210 5211 5212 5213
 *
 * 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
5214 5215 5216 5217
 *   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.
5218 5219 5220
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
5221
 *
5222 5223 5224 5225 5226 5227 5228 5229 5230 5231
 * 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
5232
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
5233
 * libvirt driver can connect to the destination libvirt.
5234
 *
5235 5236 5237 5238 5239 5240 5241
 * 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.
5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265
 *
 * 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)
{
5266
    VIR_DOMAIN_DEBUG(domain, "duri=%p, flags=%lx, dname=%s, bandwidth=%lu",
5267
                     NULLSTR(duri), flags, NULLSTR(dname), bandwidth);
5268 5269 5270 5271 5272

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
5273
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5274
        virDispatchError(NULL);
5275 5276 5277
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5278
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5279 5280 5281 5282
        goto error;
    }

    if (duri == NULL) {
5283
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5284 5285 5286 5287 5288 5289
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
5290
            VIR_DEBUG("Using peer2peer migration");
5291
            if (virDomainMigratePeer2Peer(domain, NULL, flags,
5292
                                          dname, duri, NULL, bandwidth) < 0)
5293 5294 5295
                goto error;
        } else {
            /* No peer to peer migration supported */
5296
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5297 5298 5299 5300 5301
            goto error;
        }
    } else {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_DIRECT)) {
5302
            VIR_DEBUG("Using direct migration");
5303 5304
            if (virDomainMigrateDirect(domain, NULL, flags,
                                       dname, duri, bandwidth) < 0)
5305 5306 5307
                goto error;
        } else {
            /* Cannot do a migration with only the perform step */
5308
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5309 5310 5311 5312 5313 5314 5315
            goto error;
        }
    }

    return 0;

error:
5316
    virDispatchError(domain->conn);
5317 5318 5319 5320
    return -1;
}


5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341
/**
 * 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.
5342 5343 5344
 *   VIR_MIGRATE_CHANGE_PROTECTION Protect against domain configuration
 *                                 changes during the migration process (set
 *                                 automatically when supported).
5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402
 *
 * 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, "
5403
                     "flags=%lx, dname=%s, bandwidth=%lu",
5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453
                     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 已提交
5454 5455
/*
 * Not for public use.  This function is part of the internal
5456 5457 5458
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5459
virDomainMigratePrepare (virConnectPtr dconn,
5460 5461 5462 5463 5464 5465 5466
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
5467
{
J
John Levon 已提交
5468
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, "
5469
              "flags=%lx, dname=%s, bandwidth=%lu", dconn, cookie, cookielen,
J
John Levon 已提交
5470
              NULLSTR(uri_in), uri_out, flags, NULLSTR(dname), bandwidth);
5471

5472 5473
    virResetLastError();

5474
    if (!VIR_IS_CONNECT (dconn)) {
5475
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5476
        virDispatchError(NULL);
5477 5478 5479
        return -1;
    }

5480
    if (dconn->flags & VIR_CONNECT_RO) {
5481
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5482
        goto error;
5483 5484
    }

5485 5486 5487 5488 5489 5490 5491 5492 5493
    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;
    }
5494

5495
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5496 5497

error:
5498
    virDispatchError(dconn);
5499 5500 5501
    return -1;
}

D
Daniel Veillard 已提交
5502 5503
/*
 * Not for public use.  This function is part of the internal
5504 5505 5506
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5507
virDomainMigratePerform (virDomainPtr domain,
5508 5509 5510 5511 5512 5513 5514 5515
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
5516

5517
    VIR_DOMAIN_DEBUG(domain, "cookie=%p, cookielen=%d, uri=%s, flags=%lx, "
5518 5519
                     "dname=%s, bandwidth=%lu", cookie, cookielen, uri, flags,
                     NULLSTR(dname), bandwidth);
5520

5521 5522 5523
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
5524
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5525
        virDispatchError(NULL);
5526 5527 5528 5529
        return -1;
    }
    conn = domain->conn;

5530
    if (domain->conn->flags & VIR_CONNECT_RO) {
5531
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5532
        goto error;
5533 5534
    }

5535 5536 5537 5538 5539 5540 5541 5542 5543
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
5544

5545
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5546 5547

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

D
Daniel Veillard 已提交
5552 5553
/*
 * Not for public use.  This function is part of the internal
5554 5555 5556
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
5557
virDomainMigrateFinish (virConnectPtr dconn,
5558 5559 5560 5561 5562 5563
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
5564
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
5565
              "flags=%lx", dconn, NULLSTR(dname), cookie, cookielen,
J
John Levon 已提交
5566
              uri, flags);
5567

5568 5569
    virResetLastError();

5570
    if (!VIR_IS_CONNECT (dconn)) {
5571
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5572
        virDispatchError(NULL);
5573 5574 5575
        return NULL;
    }

5576
    if (dconn->flags & VIR_CONNECT_RO) {
5577
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5578
        goto error;
5579 5580
    }

5581 5582 5583 5584 5585 5586 5587 5588 5589
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
5590

5591
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5592 5593

error:
5594
    virDispatchError(dconn);
5595
    return NULL;
D
Daniel Veillard 已提交
5596 5597 5598
}


D
Daniel Veillard 已提交
5599 5600
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
5601 5602 5603
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
5604 5605 5606 5607 5608 5609 5610 5611 5612
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 已提交
5613
{
J
John Levon 已提交
5614
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p,"
5615
              "flags=%lx, dname=%s, bandwidth=%lu, dom_xml=%s", dconn,
J
John Levon 已提交
5616 5617
              cookie, cookielen, uri_in, uri_out, flags, NULLSTR(dname),
              bandwidth, dom_xml);
D
Daniel Veillard 已提交
5618

5619 5620
    virResetLastError();

D
Daniel Veillard 已提交
5621
    if (!VIR_IS_CONNECT (dconn)) {
5622
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5623
        virDispatchError(NULL);
D
Daniel Veillard 已提交
5624 5625 5626
        return -1;
    }

5627
    if (dconn->flags & VIR_CONNECT_RO) {
5628
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5629
        goto error;
5630 5631
    }

5632 5633 5634 5635 5636 5637 5638 5639 5640 5641
    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 已提交
5642

5643
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5644 5645

error:
5646
    virDispatchError(dconn);
D
Daniel Veillard 已提交
5647 5648 5649
    return -1;
}

D
Daniel Veillard 已提交
5650 5651
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
5652 5653 5654
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
5655 5656 5657 5658 5659 5660 5661
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
5662
{
J
John Levon 已提交
5663
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
5664
              "flags=%lx, retcode=%d", dconn, NULLSTR(dname), cookie,
J
John Levon 已提交
5665
              cookielen, uri, flags, retcode);
D
Daniel Veillard 已提交
5666

5667 5668
    virResetLastError();

D
Daniel Veillard 已提交
5669
    if (!VIR_IS_CONNECT (dconn)) {
5670
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5671
        virDispatchError(NULL);
D
Daniel Veillard 已提交
5672 5673 5674
        return NULL;
    }

5675
    if (dconn->flags & VIR_CONNECT_RO) {
5676
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5677
        goto error;
5678 5679
    }

5680 5681 5682 5683 5684 5685 5686 5687 5688 5689
    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 已提交
5690

5691
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5692 5693

error:
5694
    virDispatchError(dconn);
D
Daniel Veillard 已提交
5695
    return NULL;
5696 5697 5698
}


C
Chris Lalancette 已提交
5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710
/*
 * 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)
{
5711
    VIR_DEBUG("conn=%p, stream=%p, flags=%lx, dname=%s, "
5712
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
5713 5714 5715 5716 5717
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
5718
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5719
        virDispatchError(NULL);
C
Chris Lalancette 已提交
5720 5721 5722 5723
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
5724
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
5725 5726 5727 5728
        goto error;
    }

    if (conn != st->conn) {
5729
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
5730 5731 5732 5733
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
5734
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
5735 5736 5737 5738 5739 5740 5741
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

5742
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
5743 5744

error:
5745
    virDispatchError(conn);
C
Chris Lalancette 已提交
5746 5747 5748
    return -1;
}

5749 5750 5751 5752 5753 5754
/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
char *
virDomainMigrateBegin3(virDomainPtr domain,
5755
                       const char *xmlin,
5756 5757 5758 5759 5760 5761 5762 5763
                       char **cookieout,
                       int *cookieoutlen,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    virConnectPtr conn;

5764
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s cookieout=%p, cookieoutlen=%p, "
5765
                     "flags=%lx, dname=%s, bandwidth=%lu",
5766
                     NULLSTR(xmlin), cookieout, cookieoutlen, flags,
5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784
                     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;
5785
        xml = conn->driver->domainMigrateBegin3(domain, xmlin,
5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818
                                                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)
{
5819 5820 5821 5822 5823
    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);
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874

    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)

{
5875 5876 5877
    VIR_DEBUG("conn=%p, stream=%p, cookiein=%p, cookieinlen=%d, cookieout=%p, "
              "cookieoutlen=%p, flags=%lx, dname=%s, bandwidth=%lu, "
              "dom_xml=%s",
5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923
              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,
5924
                         const char *xmlin,
5925 5926 5927 5928
                         const char *cookiein,
                         int cookieinlen,
                         char **cookieout,
                         int *cookieoutlen,
5929
                         const char *dconnuri,
5930 5931 5932 5933 5934 5935 5936
                         const char *uri,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
{
    virConnectPtr conn;

5937
    VIR_DOMAIN_DEBUG(domain, "xmlin=%s cookiein=%p, cookieinlen=%d, "
5938
                     "cookieout=%p, cookieoutlen=%p, dconnuri=%s, "
5939
                     "uri=%s, flags=%lx, dname=%s, bandwidth=%lu",
5940
                     NULLSTR(xmlin), cookiein, cookieinlen,
5941 5942
                     cookieout, cookieoutlen, NULLSTR(dconnuri),
                     NULLSTR(uri), flags, NULLSTR(dname), bandwidth);
5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959

    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;
5960
        ret = conn->driver->domainMigratePerform3(domain, xmlin,
5961 5962
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
5963
                                                  dconnuri, uri,
5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981
                                                  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.
 */
5982
virDomainPtr
5983 5984 5985 5986 5987 5988
virDomainMigrateFinish3(virConnectPtr dconn,
                        const char *dname,
                        const char *cookiein,
                        int cookieinlen,
                        char **cookieout,
                        int *cookieoutlen,
5989
                        const char *dconnuri,
5990 5991
                        const char *uri,
                        unsigned long flags,
5992
                        int cancelled)
5993 5994
{
    VIR_DEBUG("dconn=%p, dname=%s, cookiein=%p, cookieinlen=%d, cookieout=%p,"
5995
              "cookieoutlen=%p, dconnuri=%s, uri=%s, flags=%lx, retcode=%d",
5996
              dconn, NULLSTR(dname), cookiein, cookieinlen, cookieout,
5997
              cookieoutlen, NULLSTR(dconnuri), NULLSTR(uri), flags, cancelled);
5998 5999 6000 6001 6002 6003

    virResetLastError();

    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
6004
        return NULL;
6005 6006 6007 6008 6009 6010 6011 6012
    }

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

    if (dconn->driver->domainMigrateFinish3) {
6013
        virDomainPtr ret;
6014 6015 6016
        ret = dconn->driver->domainMigrateFinish3(dconn, dname,
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
6017
                                                  dconnuri, uri, flags,
6018 6019
                                                  cancelled);
        if (!ret)
6020 6021 6022 6023 6024 6025 6026 6027
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(dconn);
6028
    return NULL;
6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044
}


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

6045 6046
    VIR_DOMAIN_DEBUG(domain,
                     "cookiein=%p, cookieinlen=%d, flags=%lx, cancelled=%d",
6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079
                     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 已提交
6080

6081 6082 6083 6084
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
6085
 *
6086 6087 6088 6089 6090
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
6091 6092
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
6093
    VIR_DEBUG("conn=%p, info=%p", conn, info);
6094

6095 6096
    virResetLastError();

6097
    if (!VIR_IS_CONNECT(conn)) {
6098
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6099
        virDispatchError(NULL);
6100
        return -1;
6101 6102
    }
    if (info == NULL) {
6103
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6104
        goto error;
6105 6106
    }

6107 6108 6109 6110 6111 6112 6113
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6114

6115
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6116 6117

error:
6118
    virDispatchError(conn);
6119
    return -1;
6120
}
6121

6122 6123 6124 6125 6126 6127
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
6128 6129
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
6130 6131 6132 6133 6134
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
6135
    VIR_DEBUG("conn=%p", conn);
6136

6137 6138
    virResetLastError();

6139
    if (!VIR_IS_CONNECT (conn)) {
6140
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6141
        virDispatchError(NULL);
6142 6143 6144
        return NULL;
    }

6145 6146 6147 6148 6149
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
6150
        VIR_DEBUG("conn=%p ret=%s", conn, ret);
6151 6152
        return ret;
    }
6153

6154
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6155 6156

error:
6157
    virDispatchError(conn);
6158 6159 6160
    return NULL;
}

6161 6162 6163
/**
 * virNodeGetCPUStats:
 * @conn: pointer to the hypervisor connection.
6164
 * @cpuNum: number of node cpu. (VIR_NODE_CPU_STATS_ALL_CPUS means total cpu
6165 6166 6167 6168 6169 6170 6171 6172
 *          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
6173
 * VIR_NODE_CPU_STATS_ALL_CPUS to @cpuNum.
6174 6175 6176 6177 6178 6179
 * 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
6180
 * array, i.e. (sizeof(@virNodeCPUStats) * @nparams) bytes and call
6181 6182 6183 6184 6185 6186
 * the API again.
 *
 * Here is a sample code snippet:
 *
 * if ((virNodeGetCPUStats(conn, cpuNum, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
6187
 *     if ((params = malloc(sizeof(virNodeCPUStats) * nparams)) == NULL)
6188
 *         goto error;
6189
 *     memset(params, 0, sizeof(virNodeCPUStats) * nparams);
6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216
 *     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,
6217
                        virNodeCPUStatsPtr params,
6218 6219
                        int *nparams, unsigned int flags)
{
6220
    VIR_DEBUG("conn=%p, cpuNum=%d, params=%p, nparams=%d, flags=%x",
6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231
              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) ||
6232
        ((cpuNum < 0) && (cpuNum != VIR_NODE_CPU_STATS_ALL_CPUS))) {
6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250
        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;
}

6251 6252 6253
/**
 * virNodeGetMemoryStats:
 * @conn: pointer to the hypervisor connection.
6254 6255
 * @cellNum: number of node cell. (VIR_NODE_MEMORY_STATS_ALL_CELLS means total
 *           cell statistics)
6256 6257 6258 6259 6260 6261 6262
 * @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
6263
 * VIR_NODE_MEMORY_STATS_ALL_CELLS to @cellNum.
6264 6265 6266 6267 6268 6269
 * 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
6270
 * array, i.e. (sizeof(@virNodeMemoryStats) * @nparams) bytes and call
6271 6272 6273 6274 6275 6276
 * the API again.
 *
 * Here is the sample code snippet:
 *
 * if ((virNodeGetMemoryStats(conn, cellNum, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
6277
 *     if ((params = malloc(sizeof(virNodeMemoryStats) * nparams)) == NULL)
6278
 *         goto error;
6279
 *     memset(params, cellNum, 0, sizeof(virNodeMemoryStats) * nparams);
6280 6281 6282 6283 6284 6285 6286 6287 6288
 *     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:
 *
6289
 * VIR_NODE_MEMORY_STATS_TOTAL:
6290
 *     The total memory usage.(KB)
6291
 * VIR_NODE_MEMORY_STATS_FREE:
6292 6293
 *     The free memory usage.(KB)
 *     On linux, this usage includes buffers and cached.
6294
 * VIR_NODE_MEMORY_STATS_BUFFERS:
6295
 *     The buffers memory usage.(KB)
6296
 * VIR_NODE_MEMORY_STATS_CACHED:
6297 6298 6299 6300 6301 6302
 *     The cached memory usage.(KB)
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virNodeGetMemoryStats (virConnectPtr conn,
                           int cellNum,
6303
                           virNodeMemoryStatsPtr params,
6304 6305
                           int *nparams, unsigned int flags)
{
6306
    VIR_DEBUG("conn=%p, cellNum=%d, params=%p, nparams=%d, flags=%x",
6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317
              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) ||
6318
        ((cellNum < 0) && (cellNum != VIR_NODE_MEMORY_STATS_ALL_CELLS))) {
6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336
        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;
}

6337 6338 6339
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
6340
 *
D
Daniel Veillard 已提交
6341
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
6342 6343
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
6344
 *
D
Daniel Veillard 已提交
6345
 * Returns the available free memory in bytes or 0 in case of error
6346 6347 6348 6349
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
6350
    VIR_DEBUG("conn=%p", conn);
6351

6352 6353
    virResetLastError();

6354
    if (!VIR_IS_CONNECT (conn)) {
6355
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6356
        virDispatchError(NULL);
6357 6358 6359
        return 0;
    }

6360
    if (conn->driver->nodeGetFreeMemory) {
6361
        unsigned long long ret;
6362
        ret = conn->driver->nodeGetFreeMemory (conn);
6363 6364 6365 6366
        if (ret == 0)
            goto error;
        return ret;
    }
6367

6368
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6369 6370

error:
6371
    virDispatchError(conn);
6372 6373 6374
    return 0;
}

6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435
/**
 * virNodeSuspendForDuration:
 * @conn: pointer to the hypervisor connection
 * @target: the state to which the host must be suspended to,
 *         such as: VIR_NODE_SUSPEND_TARGET_MEM (Suspend-to-RAM)
 *                  VIR_NODE_SUSPEND_TARGET_DISK (Suspend-to-Disk)
 *                  VIR_NODE_SUSPEND_TARGET_HYBRID (Hybrid-Suspend,
 *                  which is a combination of the former modes).
 * @duration: the time duration in seconds for which the host
 *            has to be suspended
 * @flags: any flag values that might need to be passed;
 *         currently unused (0).
 *
 * Attempt to suspend the node (host machine) for the given duration of
 * time in the specified state (Suspend-to-RAM, Suspend-to-Disk or
 * Hybrid-Suspend). Schedule the node's Real-Time-Clock interrupt to
 * resume the node after the duration is complete.
 *
 * Returns 0 on success (i.e., the node will be suspended after a short
 * delay), -1 on failure (the operation is not supported, or an attempted
 * suspend is already underway).
 */
int
virNodeSuspendForDuration(virConnectPtr conn,
                          unsigned int target,
                          unsigned long long duration,
                          unsigned int flags)
{

    VIR_DEBUG("conn=%p, target=%d, duration=%lld", conn, target, duration);

    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->driver->nodeSuspendForDuration) {
        int ret;
        ret = conn->driver->nodeSuspendForDuration(conn, target,
                                                   duration, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


6436 6437 6438
/**
 * virDomainGetSchedulerType:
 * @domain: pointer to domain object
6439 6440
 * @nparams: pointer to number of scheduler parameters, can be NULL
 *           (return value)
6441
 *
6442
 * Get the scheduler type and the number of scheduler parameters.
6443 6444 6445 6446 6447 6448 6449 6450
 *
 * Returns NULL in case of error. The caller must free the returned string.
 */
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
{
    virConnectPtr conn;
    char *schedtype;
6451 6452

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

6454 6455
    virResetLastError();

6456
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6457
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6458
        virDispatchError(NULL);
6459 6460 6461 6462 6463 6464
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
6465 6466
        if (!schedtype)
            goto error;
6467 6468 6469
        return schedtype;
    }

6470
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6471 6472

error:
6473
    virDispatchError(domain->conn);
6474 6475 6476 6477 6478 6479 6480
    return NULL;
}


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
6481
 * @params: pointer to scheduler parameter objects
6482
 *          (return value)
6483
 * @nparams: pointer to number of scheduler parameter objects
6484 6485 6486 6487 6488 6489 6490
 *          (this value should generally be as large as the returned value
 *           nparams of virDomainGetSchedulerType()); input and output
 *
 * Get all scheduler parameters.  On input, @nparams gives the size of the
 * @params array; on output, @nparams gives how many slots were filled
 * with parameter information, which might be less but will not exceed
 * the input value.  @nparams cannot be 0.
6491
 *
6492
 * It is hypervisor specific whether this returns the live or
6493
 * persistent state; for more control, use
6494
 * virDomainGetSchedulerParametersFlags().
6495 6496 6497 6498 6499
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
6500
                                virTypedParameterPtr params, int *nparams)
6501 6502
{
    virConnectPtr conn;
6503 6504

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

6506 6507
    virResetLastError();

6508
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6509
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6510
        virDispatchError(NULL);
6511 6512
        return -1;
    }
6513 6514 6515 6516 6517 6518

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

6519 6520
    conn = domain->conn;

6521 6522 6523 6524 6525 6526 6527
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
6528

6529
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6530 6531

error:
6532
    virDispatchError(domain->conn);
6533 6534 6535
    return -1;
}

6536 6537 6538 6539 6540 6541 6542
/**
 * 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
6543
 *           nparams of virDomainGetSchedulerType()); input and output
E
Eric Blake 已提交
6544
 * @flags: bitwise-OR of virDomainModificationImpact and virTypedParameterFlags
6545
 *
6546 6547 6548 6549
 * Get all scheduler parameters.  On input, @nparams gives the size of the
 * @params array; on output, @nparams gives how many slots were filled
 * with parameter information, which might be less but will not exceed
 * the input value.  @nparams cannot be 0.
6550
 *
6551 6552
 * The value of @flags can be exactly VIR_DOMAIN_AFFECT_CURRENT,
 * VIR_DOMAIN_AFFECT_LIVE, or VIR_DOMAIN_AFFECT_CONFIG.
6553
 *
6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564
 * Here is a sample code snippet:
 *
 * char *ret = virDomainGetSchedulerType(dom, &nparams);
 * if (ret && nparams != 0) {
 *     if ((params = malloc(sizeof(*params) * nparams)) == NULL)
 *         goto error;
 *     memset(params, 0, sizeof(*params) * nparams);
 *     if (virDomainGetSchedulerParametersFlags(dom, params, &nparams, 0))
 *         goto error;
 * }
 *
6565 6566 6567 6568 6569 6570 6571 6572 6573
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParametersFlags(virDomainPtr domain,
                                     virTypedParameterPtr params, int *nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

6574
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%p, flags=%x",
6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589
                     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;
    }

E
Eric Blake 已提交
6590 6591 6592
    if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                 VIR_DRV_FEATURE_TYPED_PARAM_STRING))
        flags |= VIR_TYPED_PARAM_STRING_OKAY;
6593 6594 6595 6596 6597 6598 6599

    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) &&
        (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617
    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;
}

6618 6619 6620 6621
/**
 * virDomainSetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
6622 6623
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
6624 6625
 *           nparams of virDomainGetSchedulerType)
 *
6626 6627 6628 6629
 * 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.
6630 6631 6632 6633
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
6634
virDomainSetSchedulerParameters(virDomainPtr domain,
6635
                                virTypedParameterPtr params, int nparams)
6636 6637
{
    virConnectPtr conn;
6638 6639

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

6641 6642
    virResetLastError();

6643
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6644
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6645
        virDispatchError(NULL);
6646 6647
        return -1;
    }
6648

E
Eric Blake 已提交
6649 6650 6651 6652
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
6653 6654 6655 6656
    if (params == NULL || nparams < 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
E
Eric Blake 已提交
6657 6658
    if (virTypedParameterValidateSet(domain, params, nparams) < 0)
        return -1;
6659

6660 6661
    conn = domain->conn;

6662 6663 6664 6665 6666 6667 6668
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
6669

6670
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681

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


/**
 * virDomainSetSchedulerParametersFlags:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
6682 6683
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
6684
 *           nparams of virDomainGetSchedulerType)
6685
 * @flags: bitwise-OR of virDomainModificationImpact
6686
 *
6687
 * Change a subset or all scheduler parameters.  The value of @flags
6688 6689 6690
 * 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
6691
 * flags are supported.
6692 6693 6694 6695 6696
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetSchedulerParametersFlags(virDomainPtr domain,
6697
                                     virTypedParameterPtr params,
6698 6699 6700 6701 6702
                                     int nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

6703
    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%x",
6704 6705 6706 6707 6708 6709 6710 6711 6712
                     params, nparams, flags);

    virResetLastError();

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

E
Eric Blake 已提交
6714 6715 6716 6717
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
6718 6719 6720 6721
    if (params == NULL || nparams < 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
E
Eric Blake 已提交
6722 6723
    if (virTypedParameterValidateSet(domain, params, nparams) < 0)
        return -1;
6724

6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738
    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__);
6739 6740

error:
6741
    virDispatchError(domain->conn);
6742 6743 6744 6745
    return -1;
}


6746
/**
6747
 * virDomainBlockStats:
6748
 * @dom: pointer to the domain object
6749
 * @disk: path to the block device, or device shorthand
6750 6751 6752 6753 6754 6755
 * @stats: block device stats (returned)
 * @size: size of stats structure
 *
 * This function returns block device (disk) stats for block
 * devices attached to the domain.
 *
6756
 * The @disk parameter is either the device target shorthand (the
6757 6758 6759 6760 6761
 * <target dev='...'/> sub-element, such as "xvda"), or (since 0.9.8)
 * an unambiguous source name of the block device (the <source
 * file='...'/> sub-element, such as "/path/to/image").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772
 *
 * 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
6773 6774
virDomainBlockStats(virDomainPtr dom, const char *disk,
                    virDomainBlockStatsPtr stats, size_t size)
6775 6776 6777
{
    virConnectPtr conn;
    struct _virDomainBlockStats stats2 = { -1, -1, -1, -1, -1 };
6778

6779
    VIR_DOMAIN_DEBUG(dom, "disk=%s, stats=%p, size=%zi", disk, stats, size);
6780

6781 6782
    virResetLastError();

6783
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6784
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6785
        virDispatchError(NULL);
6786 6787
        return -1;
    }
6788
    if (!disk || !stats || size > sizeof stats2) {
6789
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6790 6791
        goto error;
    }
6792 6793 6794
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
6795
        if (conn->driver->domainBlockStats (dom, disk, &stats2) == -1)
6796
            goto error;
6797 6798 6799 6800 6801

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

6802
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6803 6804

error:
6805
    virDispatchError(dom->conn);
6806 6807 6808
    return -1;
}

O
Osier Yang 已提交
6809 6810 6811
/**
 * virDomainBlockStatsFlags:
 * @dom: pointer to domain object
6812
 * @disk: path to the block device, or device shorthand
O
Osier Yang 已提交
6813 6814
 * @params: pointer to block stats parameter object
 *          (return value)
6815
 * @nparams: pointer to number of block stats; input and output
E
Eric Blake 已提交
6816
 * @flags: bitwise-OR of virTypedParameterFlags
O
Osier Yang 已提交
6817 6818 6819 6820
 *
 * This function is to get block stats parameters for block
 * devices attached to the domain.
 *
6821
 * The @disk parameter is either the device target shorthand (the
6822 6823 6824 6825 6826
 * <target dev='...'/> sub-element, such as "xvda"), or (since 0.9.8)
 * an unambiguous source name of the block device (the <source
 * file='...'/> sub-element, such as "/path/to/image").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
O
Osier Yang 已提交
6827 6828 6829 6830
 *
 * Domains may have more than one block device.  To get stats for
 * each you should make multiple calls to this function.
 *
6831 6832 6833 6834
 * On input, @nparams gives the size of the @params array; on output,
 * @nparams gives how many slots were filled with parameter
 * information, which might be less but will not exceed the input
 * value.
O
Osier Yang 已提交
6835
 *
6836 6837 6838 6839 6840
 * As a special case, calling with @params as NULL and @nparams as 0 on
 * input will cause @nparams on output to contain the number of parameters
 * supported by the hypervisor. (Note that block devices of different types
 * might support different parameters, so it might be necessary to compute
 * @nparams for each block device). The caller should then allocate @params
O
Osier Yang 已提交
6841
 * array, i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
6842
 * again. See virDomainGetMemoryParameters() for more details.
O
Osier Yang 已提交
6843 6844 6845
 *
 * Returns -1 in case of error, 0 in case of success.
 */
6846
int virDomainBlockStatsFlags(virDomainPtr dom,
6847
                             const char *disk,
6848 6849 6850
                             virTypedParameterPtr params,
                             int *nparams,
                             unsigned int flags)
O
Osier Yang 已提交
6851 6852 6853
{
    virConnectPtr conn;

6854 6855
    VIR_DOMAIN_DEBUG(dom, "disk=%s, params=%p, nparams=%d, flags=%x",
                     disk, params, nparams ? *nparams : -1, flags);
O
Osier Yang 已提交
6856 6857 6858 6859 6860 6861 6862 6863

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
6864
    if (!disk || (nparams == NULL) || (*nparams < 0) ||
6865
        (params == NULL && *nparams != 0)) {
O
Osier Yang 已提交
6866 6867 6868
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
E
Eric Blake 已提交
6869 6870 6871
    if (VIR_DRV_SUPPORTS_FEATURE(dom->conn->driver, dom->conn,
                                 VIR_DRV_FEATURE_TYPED_PARAM_STRING))
        flags |= VIR_TYPED_PARAM_STRING_OKAY;
O
Osier Yang 已提交
6872 6873 6874 6875
    conn = dom->conn;

    if (conn->driver->domainBlockStatsFlags) {
        int ret;
6876
        ret = conn->driver->domainBlockStatsFlags(dom, disk, params, nparams, flags);
O
Osier Yang 已提交
6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888
        if (ret < 0)
            goto error;
        return ret;
    }
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


6889
/**
6890
 * virDomainInterfaceStats:
6891 6892 6893 6894 6895 6896 6897 6898 6899 6900
 * @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 已提交
6901
 * Domains may have more than one network interface.  To get stats for
6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916
 * 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 };
6917 6918 6919

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

6921 6922
    virResetLastError();

6923
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6924
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6925
        virDispatchError(NULL);
6926 6927
        return -1;
    }
6928
    if (!path || !stats || size > sizeof stats2) {
6929
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6930 6931
        goto error;
    }
6932 6933 6934 6935
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
6936
            goto error;
6937 6938 6939 6940 6941

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

6942
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6943 6944

error:
6945
    virDispatchError(dom->conn);
6946 6947 6948
    return -1;
}

6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975
/**
 * 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).
6976 6977
 * VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON:
 *     Current balloon value (in kb).
6978 6979 6980 6981 6982 6983 6984 6985
 *
 * 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;
6986

E
Eric Blake 已提交
6987 6988
    VIR_DOMAIN_DEBUG(dom, "stats=%p, nr_stats=%u, flags=%x",
                     stats, nr_stats, flags);
6989 6990 6991 6992

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
6993
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6994
        virDispatchError(NULL);
6995 6996
        return -1;
    }
6997

6998 6999 7000 7001 7002 7003 7004 7005
    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) {
7006 7007
        nr_stats_ret = conn->driver->domainMemoryStats (dom, stats, nr_stats,
                                                        flags);
7008 7009 7010 7011 7012
        if (nr_stats_ret == -1)
            goto error;
        return nr_stats_ret;
    }

7013
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7014 7015

error:
7016
    virDispatchError(dom->conn);
7017 7018 7019
    return -1;
}

R
Richard W.M. Jones 已提交
7020 7021 7022
/**
 * virDomainBlockPeek:
 * @dom: pointer to the domain object
7023
 * @disk: path to the block device, or device shorthand
R
Richard W.M. Jones 已提交
7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041
 * @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).
 *
7042
 * The @disk parameter is either an unambiguous source name of the
7043 7044 7045 7046 7047
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
R
Richard W.M. Jones 已提交
7048 7049 7050 7051 7052 7053 7054
 *
 * '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 已提交
7055 7056 7057 7058
 * 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 已提交
7059 7060 7061 7062
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainBlockPeek (virDomainPtr dom,
7063
                    const char *disk,
R
Richard W.M. Jones 已提交
7064 7065 7066 7067 7068 7069
                    unsigned long long offset /* really 64 bits */,
                    size_t size,
                    void *buffer,
                    unsigned int flags)
{
    virConnectPtr conn;
7070

7071 7072
    VIR_DOMAIN_DEBUG(dom, "disk=%s, offset=%lld, size=%zi, buffer=%p, flags=%x",
                     disk, offset, size, buffer, flags);
R
Richard W.M. Jones 已提交
7073

7074 7075
    virResetLastError();

R
Richard W.M. Jones 已提交
7076
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
7077
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7078
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
7079 7080 7081
        return -1;
    }
    conn = dom->conn;
7082

7083
    if (dom->conn->flags & VIR_CONNECT_RO) {
7084
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7085
        goto error;
7086 7087
    }

7088
    if (!disk) {
7089
        virLibDomainError(VIR_ERR_INVALID_ARG,
7090
                          _("disk is NULL"));
7091
        goto error;
R
Richard W.M. Jones 已提交
7092 7093 7094 7095
    }

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

7101 7102
    if (conn->driver->domainBlockPeek) {
        int ret;
7103
        ret = conn->driver->domainBlockPeek(dom, disk, offset, size,
7104 7105 7106 7107 7108
                                            buffer, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
R
Richard W.M. Jones 已提交
7109

7110
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7111 7112

error:
7113
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
7114 7115
    return -1;
}
7116

O
Osier Yang 已提交
7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184
/**
 * virDomainBlockResize:
 * @dom: pointer to the domain object
 * @disk: path to the block image, or shorthand
 * @size: new size of the block image in kilobytes
 * @flags: unused, always pass 0
 *
 * Note that this call may fail if the underlying virtualization hypervisor
 * does not support it. And this call requires privileged access to the
 * hypervisor.
 *
 * The @disk parameter is either an unambiguous source name of the
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
 *
 * Resize a block device of domain while the domain is running.
 *
 * Returns: 0 in case of success or -1 in case of failure.
 */

int
virDomainBlockResize (virDomainPtr dom,
                      const char *disk,
                      unsigned long long size,
                      unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "disk=%s, size=%llu, flags=%x", disk, size, 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 (!disk) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("disk is NULL"));
        goto error;
    }

    if (conn->driver->domainBlockResize) {
        int ret;
        ret =conn->driver->domainBlockResize(dom, disk, size, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

R
Richard W.M. Jones 已提交
7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223
/**
 * 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;
7224

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

7228 7229
    virResetLastError();

R
Richard W.M. Jones 已提交
7230
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
7231
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7232
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
7233 7234 7235 7236
        return -1;
    }
    conn = dom->conn;

7237
    if (dom->conn->flags & VIR_CONNECT_RO) {
7238
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7239
        goto error;
7240 7241
    }

7242
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
7243 7244 7245 7246 7247 7248
     * 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.
     *
7249
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
7250 7251 7252
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
7253 7254 7255
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
7256 7257 7258 7259 7260 7261 7262 7263
     * 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.
     */
7264

7265 7266
    /* Exactly one of these two flags must be set.  */
    if (!(flags & VIR_MEMORY_VIRTUAL) == !(flags & VIR_MEMORY_PHYSICAL)) {
7267
        virLibDomainError(VIR_ERR_INVALID_ARG,
7268
                     _("flags parameter must include VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
7269
        goto error;
R
Richard W.M. Jones 已提交
7270 7271 7272 7273
    }

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

7279 7280 7281 7282 7283 7284 7285 7286
    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 已提交
7287

7288
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7289 7290

error:
7291
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
7292 7293 7294
    return -1;
}

7295

7296 7297 7298
/**
 * virDomainGetBlockInfo:
 * @domain: a domain object
7299
 * @disk: path to the block device, or device shorthand
7300 7301 7302 7303 7304
 * @info: pointer to a virDomainBlockInfo structure allocated by the user
 * @flags: currently unused, pass zero
 *
 * Extract information about a domain's block device.
 *
7305
 * The @disk parameter is either an unambiguous source name of the
7306 7307 7308 7309 7310 7311
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
 *
7312 7313 7314
 * Returns 0 in case of success and -1 in case of failure.
 */
int
7315
virDomainGetBlockInfo(virDomainPtr domain, const char *disk,
7316
                      virDomainBlockInfoPtr info, unsigned int flags)
7317 7318
{
    virConnectPtr conn;
7319

E
Eric Blake 已提交
7320
    VIR_DOMAIN_DEBUG(domain, "info=%p, flags=%x", info, flags);
7321 7322 7323 7324

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7325
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7326
        virDispatchError(NULL);
7327
        return -1;
7328
    }
7329
    if (disk == NULL || info == NULL) {
7330
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7331 7332 7333 7334 7335 7336 7337 7338 7339
        goto error;
    }

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

    conn = domain->conn;

    if (conn->driver->domainGetBlockInfo) {
        int ret;
7340
        ret = conn->driver->domainGetBlockInfo (domain, disk, info, flags);
7341 7342 7343 7344 7345
        if (ret < 0)
            goto error;
        return ret;
    }

7346
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7347 7348 7349 7350 7351 7352 7353

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


7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364
/************************************************************************
 *									*
 *		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
 *
7365 7366
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
7367 7368
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
7369 7370 7371 7372 7373
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
7374
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
7375

7376 7377
    virResetLastError();

7378
    if (!VIR_IS_CONNECT(conn)) {
7379
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7380
        virDispatchError(NULL);
7381
        return NULL;
7382
    }
7383
    if (conn->flags & VIR_CONNECT_RO) {
7384
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7385
        goto error;
7386
    }
7387
    if (xml == NULL) {
7388
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7389
        goto error;
7390 7391
    }

7392 7393 7394 7395 7396 7397 7398
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
7399

7400
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7401 7402

error:
7403
    virDispatchError(conn);
7404
    return NULL;
7405 7406 7407 7408 7409 7410
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
O
Osier Yang 已提交
7411 7412 7413 7414 7415
 * 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
7416 7417 7418
 * virDomainHasManagedSaveImage()), or if it is inactive and has any
 * snapshot metadata (see virDomainSnapshotNum()), then the undefine will
 * fail. See virDomainUndefineFlags() for more control.
7419 7420 7421 7422 7423
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
7424
    virConnectPtr conn;
7425

7426
    VIR_DOMAIN_DEBUG(domain);
7427

7428 7429
    virResetLastError();

7430
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7431
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7432
        virDispatchError(NULL);
7433
        return -1;
7434
    }
7435 7436
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7437
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7438
        goto error;
7439 7440
    }

7441 7442 7443 7444 7445 7446 7447
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
7448

7449
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7450 7451

error:
7452
    virDispatchError(domain->conn);
7453
    return -1;
7454 7455
}

O
Osier Yang 已提交
7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468
/**
 * 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.
 *
7469 7470 7471 7472 7473 7474 7475 7476 7477
 * 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 已提交
7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516
 * 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;
}


7517 7518 7519 7520
/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
7521
 * Provides the number of defined but inactive domains.
7522 7523 7524 7525 7526 7527
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
7528
    VIR_DEBUG("conn=%p", conn);
7529

7530 7531
    virResetLastError();

7532
    if (!VIR_IS_CONNECT(conn)) {
7533
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7534
        virDispatchError(NULL);
7535
        return -1;
7536 7537
    }

7538 7539 7540 7541 7542 7543 7544
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7545

7546
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7547 7548

error:
7549
    virDispatchError(conn);
7550
    return -1;
7551 7552 7553 7554 7555 7556 7557 7558
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
7559 7560
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
7561
 *
7562 7563 7564
 * Returns the number of names provided in the array or -1 in case of error
 */
int
7565
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
7566
                             int maxnames) {
7567
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7568

7569 7570
    virResetLastError();

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

7577
    if ((names == NULL) || (maxnames < 0)) {
7578
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7579
        goto error;
7580 7581
    }

7582 7583 7584 7585 7586 7587 7588
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7589

7590
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7591 7592

error:
7593
    virDispatchError(conn);
7594
    return -1;
7595 7596 7597 7598 7599 7600
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
7601
 * Launch a defined domain. If the call succeeds the domain moves from the
7602 7603 7604
 * 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().
7605 7606 7607 7608 7609
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
7610
    virConnectPtr conn;
7611

7612
    VIR_DOMAIN_DEBUG(domain);
7613

7614 7615
    virResetLastError();

7616
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7617
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7618
        virDispatchError(NULL);
7619
        return -1;
7620
    }
7621 7622
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7623
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7624
        goto error;
7625
    }
7626

7627 7628 7629 7630 7631 7632 7633
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
7634

7635
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7636 7637

error:
7638
    virDispatchError(domain->conn);
7639
    return -1;
7640 7641
}

7642 7643 7644 7645 7646 7647 7648 7649
/**
 * 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.
 *
7650 7651 7652 7653 7654 7655
 * 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.
7656 7657 7658 7659
 *
 * 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 已提交
7660
 * client application crashes / loses its connection to the
7661
 * libvirtd daemon. Any domains marked for auto destroy will
7662
 * block attempts at migration, save-to-file, or snapshots.
7663
 *
7664 7665 7666 7667 7668 7669
 * 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.
 *
7670 7671 7672
 * 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.
 *
7673 7674 7675 7676 7677
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) {
    virConnectPtr conn;
7678

7679
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
7680 7681 7682 7683

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7684
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7685
        virDispatchError(NULL);
7686
        return -1;
7687 7688 7689
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7690
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701
        goto error;
    }

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

7702
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7703 7704 7705 7706 7707 7708

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

7709 7710 7711
/**
 * virDomainGetAutostart:
 * @domain: a domain object
7712
 * @autostart: the value returned
7713
 *
7714
 * Provides a boolean value indicating whether the domain
7715 7716 7717 7718 7719 7720 7721
 * 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,
7722 7723 7724
                      int *autostart)
{
    virConnectPtr conn;
7725 7726

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

7728 7729 7730
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7731
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7732
        virDispatchError(NULL);
7733
        return -1;
7734 7735
    }
    if (!autostart) {
7736
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7737
        goto error;
7738 7739
    }

7740 7741
    conn = domain->conn;

7742 7743 7744 7745 7746 7747 7748
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7749

7750
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7751 7752

error:
7753
    virDispatchError(domain->conn);
7754
    return -1;
7755 7756 7757 7758 7759
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
7760
 * @autostart: whether the domain should be automatically started 0 or 1
7761 7762 7763 7764 7765 7766 7767 7768
 *
 * 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,
7769 7770 7771
                      int autostart)
{
    virConnectPtr conn;
7772 7773

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

7775 7776 7777
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7778
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7779
        virDispatchError(NULL);
7780
        return -1;
7781 7782
    }

7783 7784
    conn = domain->conn;

7785
    if (domain->conn->flags & VIR_CONNECT_RO) {
7786
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7787
        goto error;
7788 7789
    }

7790 7791 7792 7793 7794 7795 7796
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7797

7798
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7799 7800

error:
7801
    virDispatchError(domain->conn);
7802
    return -1;
7803 7804
}

7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817
/**
 * 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;
7818
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848

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

7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866
/**
 * 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,
7867
                     int nkeycodes,
7868 7869 7870
                     unsigned int flags)
{
    virConnectPtr conn;
7871
    VIR_DOMAIN_DEBUG(domain, "codeset=%u, holdtime=%u, nkeycodes=%u, flags=%x",
7872 7873 7874 7875 7876
                     codeset, holdtime, nkeycodes, flags);

    virResetLastError();

    if (keycodes == NULL ||
7877
        nkeycodes <= 0 || nkeycodes > VIR_DOMAIN_SEND_KEY_MAX_KEYS) {
7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910
        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;
}

7911 7912 7913 7914 7915 7916 7917 7918
/**
 * 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.
7919
 * This function may require privileged access to the hypervisor.
7920
 *
7921
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
7922 7923 7924
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
7925
 *
7926 7927 7928 7929 7930 7931
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
7932
    virConnectPtr conn;
7933 7934

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

7936 7937
    virResetLastError();

7938
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
7939
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
7940
        virDispatchError(NULL);
7941
        return -1;
7942
    }
7943
    if (domain->conn->flags & VIR_CONNECT_RO) {
7944
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7945
        goto error;
7946
    }
7947

7948
    if (nvcpus < 1) {
7949
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7950
        goto error;
7951
    }
7952
    conn = domain->conn;
7953

7954 7955 7956 7957 7958 7959 7960
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
7961

7962
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7963 7964

error:
7965
    virDispatchError(domain->conn);
7966
    return -1;
7967 7968
}

E
Eric Blake 已提交
7969 7970 7971 7972 7973 7974 7975 7976 7977
/**
 * 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.
7978
 * This function may require privileged access to the hypervisor.
E
Eric Blake 已提交
7979
 *
7980
 * @flags may include VIR_DOMAIN_AFFECT_LIVE to affect a running
E
Eric Blake 已提交
7981
 * domain (which may fail if domain is not active), or
7982
 * VIR_DOMAIN_AFFECT_CONFIG to affect the next boot via the XML
E
Eric Blake 已提交
7983
 * description of the domain.  Both flags may be set.
7984 7985 7986 7987
 * 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 已提交
7988 7989
 *
 * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then
7990
 * VIR_DOMAIN_AFFECT_LIVE must be clear, and only the maximum virtual
E
Eric Blake 已提交
7991 7992 7993 7994
 * 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.
7995
 * Not all hypervisors can support all flag combinations.
E
Eric Blake 已提交
7996 7997 7998 7999 8000 8001 8002 8003 8004
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

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

8006
    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u, flags=%x", nvcpus, flags);
E
Eric Blake 已提交
8007 8008 8009 8010

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8011
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
8012
        virDispatchError(NULL);
8013
        return -1;
E
Eric Blake 已提交
8014 8015
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
8016
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
8017 8018 8019 8020
        goto error;
    }

    /* Perform some argument validation common to all implementations.  */
8021
    if (nvcpus < 1 || (unsigned short) nvcpus != nvcpus) {
8022
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034
        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;
    }

8035
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048

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
8049
 * not support it.  This function may require privileged access to the
E
Eric Blake 已提交
8050 8051
 * hypervisor.
 *
8052 8053 8054 8055 8056 8057 8058
 * 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 已提交
8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070
 *
 * 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;
8071

8072
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
E
Eric Blake 已提交
8073 8074 8075 8076

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8077
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
8078
        virDispatchError(NULL);
8079
        return -1;
E
Eric Blake 已提交
8080 8081
    }

8082
    /* At most one of these two flags should be set.  */
8083 8084
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) &&
        (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
8085
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097
        goto error;
    }
    conn = domain->conn;

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

8098
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
8099 8100 8101 8102 8103 8104

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

8105 8106 8107 8108 8109
/**
 * 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 已提交
8110 8111 8112
 *      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.
8113 8114 8115 8116
 * @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.
8117
 *
8118
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
8119
 * This function may require privileged access to the hypervisor.
8120
 *
8121 8122 8123
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
8124 8125 8126 8127 8128 8129
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
8130
    virConnectPtr conn;
8131 8132 8133

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

8135 8136
    virResetLastError();

8137
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8138
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8139
        virDispatchError(NULL);
8140
        return -1;
8141
    }
8142
    if (domain->conn->flags & VIR_CONNECT_RO) {
8143
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8144
        goto error;
8145
    }
8146

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

8152 8153
    conn = domain->conn;

8154 8155 8156 8157 8158 8159 8160
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
8161

8162
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8163 8164

error:
8165
    virDispatchError(domain->conn);
8166
    return -1;
8167 8168
}

8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180
/**
 * 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.
8181
 * @flags: bitwise-OR of virDomainModificationImpact
8182 8183
 *
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
8184
 * This function may require privileged access to the hypervisor.
8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196
 *
 * @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 已提交
8197
 * See also virDomainGetVcpuPinInfo for querying this information.
8198
 *
8199 8200 8201 8202 8203 8204 8205 8206 8207
 * 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;

8208
    VIR_DOMAIN_DEBUG(domain, "vcpu=%u, cpumap=%p, maplen=%d, flags=%x",
8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246
                     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;

}

8247
/**
E
Eric Blake 已提交
8248
 * virDomainGetVcpuPinInfo:
8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271
 * @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
8272 8273
virDomainGetVcpuPinInfo(virDomainPtr domain, int ncpumaps,
                        unsigned char *cpumaps, int maplen, unsigned int flags)
8274 8275 8276
{
    virConnectPtr conn;

8277
    VIR_DOMAIN_DEBUG(domain, "ncpumaps=%d, cpumaps=%p, maplen=%d, flags=%x",
8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293
                     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;
    }

8294 8295 8296 8297 8298 8299
    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) &&
        (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
8300 8301
    conn = domain->conn;

E
Eric Blake 已提交
8302
    if (conn->driver->domainGetVcpuPinInfo) {
8303
        int ret;
E
Eric Blake 已提交
8304
        ret = conn->driver->domainGetVcpuPinInfo (domain, ncpumaps,
8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317
                                                  cpumaps, maplen, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

8318 8319 8320 8321 8322
/**
 * 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 已提交
8323
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
8324
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
8325
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
8326 8327 8328 8329 8330 8331 8332
 *	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...).
8333
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
8334
 *
8335
 * Extract information about virtual CPUs of domain, store it in info array
8336 8337 8338
 * and also in cpumaps if this pointer isn't NULL.  This call may fail
 * on an inactive domain.
 *
E
Eric Blake 已提交
8339
 * See also virDomainGetVcpuPinInfo for querying just cpumaps, including on
8340
 * an inactive domain.
8341 8342 8343 8344 8345
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
8346
                  unsigned char *cpumaps, int maplen)
8347
{
8348
    virConnectPtr conn;
8349 8350 8351

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

8353 8354
    virResetLastError();

8355
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8356
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8357
        virDispatchError(NULL);
8358
        return -1;
8359 8360
    }
    if ((info == NULL) || (maxinfo < 1)) {
8361
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8362
        goto error;
8363
    }
8364 8365 8366

    /* Ensure that domainGetVcpus (aka remoteDomainGetVcpus) does not
       try to memcpy anything into a NULL pointer.  */
8367 8368
    if (!cpumaps ? maplen != 0
        : (maplen <= 0 || INT_MULTIPLY_OVERFLOW(maxinfo, maplen))) {
8369
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8370
        goto error;
8371
    }
8372

8373 8374
    conn = domain->conn;

8375 8376 8377 8378 8379 8380 8381 8382
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
8383

8384
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8385 8386

error:
8387
    virDispatchError(domain->conn);
8388
    return -1;
8389
}
8390

8391 8392 8393
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
8394
 *
8395 8396
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
8397
 * the same as virConnectGetMaxVcpus(). If the guest is running
8398
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
8399
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
8400 8401 8402 8403
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
8404 8405
virDomainGetMaxVcpus(virDomainPtr domain)
{
8406
    virConnectPtr conn;
8407

8408
    VIR_DOMAIN_DEBUG(domain);
8409

8410 8411
    virResetLastError();

8412
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8413
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8414
        virDispatchError(NULL);
8415
        return -1;
8416 8417 8418 8419
    }

    conn = domain->conn;

8420 8421 8422 8423 8424 8425 8426
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
8427

8428
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8429 8430

error:
8431
    virDispatchError(domain->conn);
8432
    return -1;
8433 8434
}

8435 8436 8437 8438 8439
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
8440 8441 8442
 * 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.
8443
 *
8444
 * Returns 0 in case of success, -1 in case of failure
8445 8446 8447 8448 8449 8450
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

8451 8452
    VIR_DOMAIN_DEBUG(domain, "seclabel=%p", seclabel);

8453
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8454
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8455
        virDispatchError(NULL);
8456 8457 8458 8459
        return -1;
    }

    if (seclabel == NULL) {
8460
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8461
        goto error;
8462 8463 8464 8465
    }

    conn = domain->conn;

8466 8467 8468 8469 8470 8471 8472 8473
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

8474
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8475

8476
error:
8477
    virDispatchError(domain->conn);
8478
    return -1;
8479 8480 8481 8482 8483 8484 8485
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
8486 8487 8488
 * 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.
8489
 *
8490
 * Returns 0 in case of success, -1 in case of failure
8491 8492 8493 8494
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
8495
    VIR_DEBUG("conn=%p secmodel=%p", conn, secmodel);
8496

8497
    if (!VIR_IS_CONNECT(conn)) {
8498
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8499
        virDispatchError(NULL);
8500 8501 8502 8503
        return -1;
    }

    if (secmodel == NULL) {
8504
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8505 8506 8507 8508 8509 8510 8511 8512 8513
        goto error;
    }

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

8516
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8517

8518
error:
8519
    virDispatchError(conn);
8520
    return -1;
8521
}
8522

8523 8524 8525 8526
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
8527
 *
8528 8529
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
8530
 *
8531 8532 8533 8534
 * 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.
 *
8535 8536 8537
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8538
virDomainAttachDevice(virDomainPtr domain, const char *xml)
8539 8540
{
    virConnectPtr conn;
8541 8542

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

8544 8545
    virResetLastError();

8546
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8547
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8548
        virDispatchError(NULL);
8549
        return -1;
8550
    }
8551 8552 8553 8554 8555 8556

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

8557
    if (domain->conn->flags & VIR_CONNECT_RO) {
8558
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8559
        goto error;
8560 8561 8562
    }
    conn = domain->conn;

8563
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
8564 8565 8566 8567 8568 8569 8570
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

8571
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584

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
8585
 * to control how the device is attached.  VIR_DOMAIN_AFFECT_CURRENT
J
Jim Fehlig 已提交
8586
 * specifies that the device allocation is made based on current domain
8587
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
J
Jim Fehlig 已提交
8588
 * allocated to the active domain instance only and is not added to the
8589
 * persisted domain configuration.  VIR_DOMAIN_AFFECT_CONFIG
J
Jim Fehlig 已提交
8590 8591 8592 8593 8594 8595
 * 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.
 *
8596 8597 8598 8599
 * 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 已提交
8600 8601 8602 8603 8604 8605 8606
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
8607

8608
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
J
Jim Fehlig 已提交
8609 8610 8611 8612

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8613
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8614
        virDispatchError(NULL);
8615
        return -1;
J
Jim Fehlig 已提交
8616
    }
8617 8618 8619 8620 8621 8622

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

J
Jim Fehlig 已提交
8623
    if (domain->conn->flags & VIR_CONNECT_RO) {
8624
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
8625 8626 8627 8628 8629
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
8630
        int ret;
J
Jim Fehlig 已提交
8631
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
8632 8633 8634 8635
        if (ret < 0)
            goto error;
        return ret;
    }
8636

8637
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8638 8639

error:
8640
    virDispatchError(domain->conn);
8641
    return -1;
8642 8643 8644 8645 8646 8647
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
8648
 *
8649 8650
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
8651 8652 8653 8654
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8655
virDomainDetachDevice(virDomainPtr domain, const char *xml)
8656 8657
{
    virConnectPtr conn;
8658 8659

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

8661 8662
    virResetLastError();

8663
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8664
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
8665
        virDispatchError(NULL);
8666
        return -1;
8667
    }
8668 8669 8670 8671 8672 8673

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

8674
    if (domain->conn->flags & VIR_CONNECT_RO) {
8675
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8676
        goto error;
8677 8678 8679
    }
    conn = domain->conn;

8680 8681 8682
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
8683 8684 8685 8686 8687
         if (ret < 0)
             goto error;
         return ret;
     }

8688
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701

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
8702
 * to control how the device is detached.  VIR_DOMAIN_AFFECT_CURRENT
J
Jim Fehlig 已提交
8703
 * specifies that the device allocation is removed based on current domain
8704
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
J
Jim Fehlig 已提交
8705
 * deallocated from the active domain instance only and is not from the
8706
 * persisted domain configuration.  VIR_DOMAIN_AFFECT_CONFIG
J
Jim Fehlig 已提交
8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719
 * 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;
8720

8721
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
J
Jim Fehlig 已提交
8722 8723 8724 8725

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8726
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8727
        virDispatchError(NULL);
8728
        return -1;
J
Jim Fehlig 已提交
8729
    }
8730 8731 8732 8733 8734 8735

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

J
Jim Fehlig 已提交
8736
    if (domain->conn->flags & VIR_CONNECT_RO) {
8737
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
8738 8739 8740 8741 8742 8743 8744
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
8745 8746 8747 8748 8749
        if (ret < 0)
            goto error;
        return ret;
    }

8750
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763

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
8764
 * to control how the device is changed.  VIR_DOMAIN_AFFECT_CURRENT
8765
 * specifies that the device change is made based on current domain
8766
 * state.  VIR_DOMAIN_AFFECT_LIVE specifies that the device shall be
8767
 * changed on the active domain instance only and is not added to the
8768
 * persisted domain configuration. VIR_DOMAIN_AFFECT_CONFIG
8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785
 * 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;
8786

8787
    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%x", xml, flags);
8788 8789 8790 8791

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
8792
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
8793
        virDispatchError(NULL);
8794
        return -1;
8795
    }
8796 8797 8798 8799 8800 8801

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

8802
    if (domain->conn->flags & VIR_CONNECT_RO) {
8803
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8804 8805 8806 8807 8808 8809 8810
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
8811 8812 8813 8814
        if (ret < 0)
            goto error;
        return ret;
    }
8815

8816
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8817 8818

error:
8819
    virDispatchError(domain->conn);
8820
    return -1;
8821
}
8822

8823 8824 8825 8826 8827 8828 8829 8830 8831 8832
/**
 * 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
8833
 * with the amount of free memory in bytes for each cell requested,
8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844
 * 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)
{
8845
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
8846 8847
          conn, freeMems, startCell, maxCells);

8848 8849
    virResetLastError();

8850
    if (!VIR_IS_CONNECT(conn)) {
8851
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8852
        virDispatchError(NULL);
8853
        return -1;
8854 8855
    }

D
Daniel Veillard 已提交
8856
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
8857
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8858
        goto error;
8859 8860
    }

8861 8862 8863 8864 8865 8866 8867
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
8868

8869
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8870 8871

error:
8872
    virDispatchError(conn);
8873 8874 8875
    return -1;
}

8876 8877 8878 8879
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
8880
 * Provides the connection pointer associated with a network.  The
8881 8882 8883
 * reference counter on the connection is not increased by this
 * call.
 *
8884 8885 8886 8887
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
8888 8889 8890 8891 8892
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
8893
    VIR_DEBUG("net=%p", net);
8894

8895 8896 8897
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
8898
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8899
        virDispatchError(NULL);
8900 8901 8902 8903 8904
        return NULL;
    }
    return net->conn;
}

8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915
/**
 * 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)
{
8916
    VIR_DEBUG("conn=%p", conn);
8917

8918 8919
    virResetLastError();

8920
    if (!VIR_IS_CONNECT(conn)) {
8921
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8922
        virDispatchError(NULL);
8923
        return -1;
8924 8925
    }

8926 8927 8928 8929 8930 8931 8932
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8933

8934
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8935 8936

error:
8937
    virDispatchError(conn);
8938
    return -1;
8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951
}

/**
 * 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
8952
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
8953
{
8954
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8955

8956 8957
    virResetLastError();

8958
    if (!VIR_IS_CONNECT(conn)) {
8959
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8960
        virDispatchError(NULL);
8961
        return -1;
8962 8963
    }

8964
    if ((names == NULL) || (maxnames < 0)) {
8965
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8966
        goto error;
8967 8968
    }

8969 8970 8971 8972 8973 8974 8975
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8976

8977
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8978 8979

error:
8980
    virDispatchError(conn);
8981
    return -1;
8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994
}

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

8997 8998
    virResetLastError();

8999
    if (!VIR_IS_CONNECT(conn)) {
9000
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9001
        virDispatchError(NULL);
9002
        return -1;
9003 9004
    }

9005 9006 9007 9008 9009 9010 9011
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
9012

9013
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9014 9015

error:
9016
    virDispatchError(conn);
9017
    return -1;
9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030
}

/**
 * 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
9031
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
9032 9033
                              int maxnames)
{
9034
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
9035

9036 9037
    virResetLastError();

9038
    if (!VIR_IS_CONNECT(conn)) {
9039
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9040
        virDispatchError(NULL);
9041
        return -1;
9042 9043
    }

9044
    if ((names == NULL) || (maxnames < 0)) {
9045
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9046
        goto error;
9047 9048
    }

9049 9050 9051 9052 9053 9054 9055 9056
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
9057

9058
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9059 9060

error:
9061
    virDispatchError(conn);
9062
    return -1;
9063 9064 9065 9066 9067 9068 9069 9070 9071
}

/**
 * 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.
 *
9072 9073
 * 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.
9074 9075 9076 9077
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
9078
    VIR_DEBUG("conn=%p, name=%s", conn, name);
9079

9080 9081
    virResetLastError();

9082
    if (!VIR_IS_CONNECT(conn)) {
9083
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9084
        virDispatchError(NULL);
9085
        return NULL;
9086 9087
    }
    if (name == NULL) {
9088
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9089
        goto  error;
9090 9091
    }

9092 9093 9094 9095 9096 9097 9098
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
9099

9100
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9101 9102

error:
9103
    virDispatchError(conn);
9104
    return NULL;
9105 9106 9107 9108 9109 9110 9111 9112 9113
}

/**
 * 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.
 *
9114 9115
 * 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.
9116 9117 9118 9119
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
9120
    VIR_UUID_DEBUG(conn, uuid);
9121

9122 9123
    virResetLastError();

9124
    if (!VIR_IS_CONNECT(conn)) {
9125
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9126
        virDispatchError(NULL);
9127
        return NULL;
9128 9129
    }
    if (uuid == NULL) {
9130
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9131
        goto error;
9132 9133
    }

9134 9135 9136 9137 9138 9139 9140
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
9141

9142
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9143 9144

error:
9145
    virDispatchError(conn);
9146
    return NULL;
9147 9148 9149 9150 9151 9152 9153 9154 9155
}

/**
 * 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.
 *
9156 9157
 * 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.
9158 9159 9160 9161 9162
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
9163
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
9164

9165 9166
    virResetLastError();

9167
    if (!VIR_IS_CONNECT(conn)) {
9168
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9169
        virDispatchError(NULL);
9170
        return NULL;
9171 9172
    }
    if (uuidstr == NULL) {
9173
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9174
        goto error;
9175 9176
    }

9177
    if (virUUIDParse(uuidstr, uuid) < 0) {
9178
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9179
        goto error;
9180 9181 9182
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
9183 9184

error:
9185
    virDispatchError(conn);
9186
    return NULL;
9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201
}

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

9204 9205
    virResetLastError();

9206
    if (!VIR_IS_CONNECT(conn)) {
9207
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9208
        virDispatchError(NULL);
9209
        return NULL;
9210 9211
    }
    if (xmlDesc == NULL) {
9212
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9213
        goto error;
9214 9215
    }
    if (conn->flags & VIR_CONNECT_RO) {
9216
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9217
        goto error;
9218 9219
    }

9220 9221 9222 9223 9224 9225 9226
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
9227

9228
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9229 9230

error:
9231
    virDispatchError(conn);
9232
    return NULL;
9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244
}

/**
 * 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
9245 9246
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
9247
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
9248

9249 9250
    virResetLastError();

9251
    if (!VIR_IS_CONNECT(conn)) {
9252
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9253
        virDispatchError(NULL);
9254
        return NULL;
9255 9256
    }
    if (conn->flags & VIR_CONNECT_RO) {
9257
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9258
        goto error;
9259 9260
    }
    if (xml == NULL) {
9261
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9262
        goto error;
9263 9264
    }

9265 9266 9267 9268 9269 9270 9271
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
9272

9273
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9274 9275

error:
9276
    virDispatchError(conn);
9277
    return NULL;
9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290
}

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

9293 9294
    virResetLastError();

9295
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9296
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9297
        virDispatchError(NULL);
9298
        return -1;
9299 9300 9301
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9302
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9303
        goto error;
9304 9305
    }

9306 9307 9308 9309 9310 9311 9312
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
9313

9314
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9315 9316

error:
9317
    virDispatchError(network->conn);
9318
    return -1;
9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330
}

/**
 * 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
9331 9332
virNetworkCreate(virNetworkPtr network)
{
9333
    virConnectPtr conn;
9334
    VIR_DEBUG("network=%p", network);
9335

9336 9337
    virResetLastError();

9338
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9339
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9340
        virDispatchError(NULL);
9341
        return -1;
9342 9343 9344
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9345
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9346
        goto error;
9347 9348
    }

9349 9350 9351 9352 9353 9354 9355
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
9356

9357
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9358 9359

error:
9360
    virDispatchError(network->conn);
9361
    return -1;
9362 9363 9364 9365 9366 9367 9368
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
9369 9370 9371
 * 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
9372 9373 9374 9375 9376 9377 9378
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
9379
    VIR_DEBUG("network=%p", network);
9380

9381 9382
    virResetLastError();

9383
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9384
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9385
        virDispatchError(NULL);
9386
        return -1;
9387 9388 9389 9390
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9391
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9392
        goto error;
9393 9394
    }

9395 9396 9397 9398 9399 9400 9401
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
9402

9403
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9404 9405

error:
9406
    virDispatchError(network->conn);
9407
    return -1;
9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421
}

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

9424 9425 9426
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9427
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9428
        virDispatchError(NULL);
9429
        return -1;
9430
    }
9431 9432
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
9433
        return -1;
9434
    }
9435
    return 0;
9436 9437
}

9438 9439
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
9440
 * @network: the network to hold a reference on
9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451
 *
 * 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 已提交
9452 9453
 *
 * Returns 0 in case of success, -1 in case of failure.
9454 9455 9456 9457 9458
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
9459
        virLibConnError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9460
        virDispatchError(NULL);
9461
        return -1;
9462 9463
    }
    virMutexLock(&network->conn->lock);
9464
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
9465 9466 9467 9468 9469
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481
/**
 * 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)
{
9482
    VIR_DEBUG("network=%p", network);
9483

9484 9485
    virResetLastError();

9486
    if (!VIR_IS_NETWORK(network)) {
9487
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9488
        virDispatchError(NULL);
9489
        return NULL;
9490
    }
9491
    return network->name;
9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505
}

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

9508 9509
    virResetLastError();

9510
    if (!VIR_IS_NETWORK(network)) {
9511
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9512
        virDispatchError(NULL);
9513
        return -1;
9514 9515
    }
    if (uuid == NULL) {
9516
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9517
        goto error;
9518 9519 9520 9521
    }

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

9522
    return 0;
9523 9524

error:
9525
    virDispatchError(network->conn);
9526
    return -1;
9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542
}

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

9545 9546
    virResetLastError();

9547
    if (!VIR_IS_NETWORK(network)) {
9548
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9549
        virDispatchError(NULL);
9550
        return -1;
9551 9552
    }
    if (buf == NULL) {
9553
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9554
        goto error;
9555 9556 9557
    }

    if (virNetworkGetUUID(network, &uuid[0]))
9558
        goto error;
9559

9560
    virUUIDFormat(uuid, buf);
9561
    return 0;
9562 9563

error:
9564
    virDispatchError(network->conn);
9565
    return -1;
9566 9567 9568 9569 9570
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
9571
 * @flags: an OR'ed set of extraction flags, not used yet
9572 9573 9574 9575 9576 9577 9578 9579
 *
 * 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 *
9580
virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
9581
{
9582
    virConnectPtr conn;
9583
    VIR_DEBUG("network=%p, flags=%x", network, flags);
9584

9585 9586 9587
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9588
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9589
        virDispatchError(NULL);
9590
        return NULL;
9591 9592
    }

9593 9594
    conn = network->conn;

9595
    if (conn->networkDriver && conn->networkDriver->networkGetXMLDesc) {
9596
        char *ret;
9597
        ret = conn->networkDriver->networkGetXMLDesc(network, flags);
9598 9599 9600 9601
        if (!ret)
            goto error;
        return ret;
    }
9602

9603
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9604 9605

error:
9606
    virDispatchError(network->conn);
9607
    return NULL;
9608
}
9609 9610 9611 9612 9613

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
9614
 * Provides a bridge interface name to which a domain may connect
9615 9616 9617 9618 9619 9620 9621 9622
 * 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)
{
9623
    virConnectPtr conn;
9624
    VIR_DEBUG("network=%p", network);
9625

9626 9627 9628
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9629
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9630
        virDispatchError(NULL);
9631
        return NULL;
9632 9633
    }

9634 9635
    conn = network->conn;

9636 9637 9638 9639 9640 9641 9642
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
9643

9644
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9645 9646

error:
9647
    virDispatchError(network->conn);
9648
    return NULL;
9649
}
9650 9651 9652 9653

/**
 * virNetworkGetAutostart:
 * @network: a network object
9654
 * @autostart: the value returned
9655
 *
9656
 * Provides a boolean value indicating whether the network
9657 9658 9659 9660 9661 9662 9663
 * 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,
9664 9665 9666
                       int *autostart)
{
    virConnectPtr conn;
9667
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
9668

9669 9670 9671
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9672
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9673
        virDispatchError(NULL);
9674
        return -1;
9675 9676
    }
    if (!autostart) {
9677
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9678
        goto error;
9679 9680
    }

9681 9682
    conn = network->conn;

9683 9684 9685 9686 9687 9688 9689
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9690

9691
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9692 9693

error:
9694
    virDispatchError(network->conn);
9695
    return -1;
9696 9697 9698 9699 9700
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
9701
 * @autostart: whether the network should be automatically started 0 or 1
9702 9703 9704 9705 9706 9707 9708 9709
 *
 * 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,
9710 9711 9712
                       int autostart)
{
    virConnectPtr conn;
9713
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
9714

9715 9716 9717
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
9718
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
9719
        virDispatchError(NULL);
9720
        return -1;
9721 9722
    }

9723
    if (network->conn->flags & VIR_CONNECT_RO) {
9724
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9725
        goto error;
9726 9727
    }

9728 9729
    conn = network->conn;

9730 9731 9732 9733 9734 9735 9736
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9737

9738
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9739 9740

error:
9741
    virDispatchError(network->conn);
9742
    return -1;
9743
}
9744

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

    virResetLastError();

9766
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
9767
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
9768
        virDispatchError(NULL);
D
Daniel Veillard 已提交
9769 9770
        return NULL;
    }
9771
    return iface->conn;
D
Daniel Veillard 已提交
9772 9773 9774 9775 9776 9777
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
9778
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
9779
 *
9780
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
9781 9782 9783 9784
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
9785
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
9786 9787 9788 9789

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9790
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9791
        virDispatchError(NULL);
9792
        return -1;
D
Daniel Veillard 已提交
9793 9794 9795 9796 9797 9798 9799 9800 9801 9802
    }

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

9803
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9804 9805

error:
9806
    virDispatchError(conn);
D
Daniel Veillard 已提交
9807 9808 9809 9810 9811 9812 9813 9814 9815
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
9816 9817
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
9818 9819 9820 9821 9822 9823
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
9824
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
9825 9826 9827 9828

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9829
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9830
        virDispatchError(NULL);
9831
        return -1;
D
Daniel Veillard 已提交
9832 9833 9834
    }

    if ((names == NULL) || (maxnames < 0)) {
9835
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846
        goto error;
    }

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

9847
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9848 9849

error:
9850
    virDispatchError(conn);
D
Daniel Veillard 已提交
9851 9852 9853
    return -1;
}

9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864
/**
 * 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)
{
9865
    VIR_DEBUG("conn=%p", conn);
9866 9867 9868 9869

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9870
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9871
        virDispatchError(NULL);
9872
        return -1;
9873 9874 9875 9876 9877 9878 9879 9880 9881 9882
    }

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

9883
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9884 9885

error:
9886
    virDispatchError(conn);
9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905
    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)
{
9906
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
9907 9908 9909 9910

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9911
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9912
        virDispatchError(NULL);
9913
        return -1;
9914 9915 9916
    }

    if ((names == NULL) || (maxnames < 0)) {
9917
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928
        goto error;
    }

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

9929
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9930 9931

error:
9932
    virDispatchError(conn);
9933 9934 9935
    return -1;
}

D
Daniel Veillard 已提交
9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948
/**
 * 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)
{
9949
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
9950 9951 9952 9953

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9954
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9955
        virDispatchError(NULL);
9956
        return NULL;
D
Daniel Veillard 已提交
9957 9958
    }
    if (name == NULL) {
9959
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970
        goto  error;
    }

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

9971
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
9972 9973

error:
9974
    virDispatchError(conn);
D
Daniel Veillard 已提交
9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990
    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)
{
9991
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
9992 9993 9994 9995

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
9996
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9997
        virDispatchError(NULL);
9998
        return NULL;
D
Daniel Veillard 已提交
9999 10000
    }
    if (macstr == NULL) {
10001
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012
        goto  error;
    }

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

10013
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10014 10015

error:
10016
    virDispatchError(conn);
D
Daniel Veillard 已提交
10017 10018 10019 10020 10021
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
10022
 * @iface: an interface object
D
Daniel Veillard 已提交
10023 10024 10025 10026 10027 10028 10029
 *
 * 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 *
10030
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
10031
{
10032
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
10033 10034 10035

    virResetLastError();

10036
    if (!VIR_IS_INTERFACE(iface)) {
10037
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10038
        virDispatchError(NULL);
10039
        return NULL;
D
Daniel Veillard 已提交
10040
    }
10041
    return iface->name;
D
Daniel Veillard 已提交
10042 10043 10044 10045
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
10046
 * @iface: an interface object
D
Daniel Veillard 已提交
10047
 *
L
Laine Stump 已提交
10048
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
10049 10050 10051 10052 10053 10054 10055
 * 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 *
10056
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
10057
{
10058
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
10059 10060 10061

    virResetLastError();

10062
    if (!VIR_IS_INTERFACE(iface)) {
10063
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10064
        virDispatchError(NULL);
10065
        return NULL;
D
Daniel Veillard 已提交
10066
    }
10067
    return iface->mac;
D
Daniel Veillard 已提交
10068 10069 10070 10071
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
10072
 * @iface: an interface object
10073 10074 10075 10076 10077
 * @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 已提交
10078
 *
10079 10080 10081 10082 10083
 * 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 已提交
10084 10085 10086 10087 10088
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
10089
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
10090 10091
{
    virConnectPtr conn;
10092
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
10093 10094 10095

    virResetLastError();

10096
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10097
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10098
        virDispatchError(NULL);
10099
        return NULL;
D
Daniel Veillard 已提交
10100 10101
    }

10102
    conn = iface->conn;
D
Daniel Veillard 已提交
10103 10104 10105

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
10106
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
10107 10108 10109 10110 10111
        if (!ret)
            goto error;
        return ret;
    }

10112
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10113 10114

error:
10115
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
10116 10117 10118 10119 10120 10121 10122 10123 10124
    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
 *
10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136

 * 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 已提交
10137 10138 10139 10140 10141 10142
 *
 * Returns NULL in case of error, a pointer to the interface otherwise
 */
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
10143
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
D
Daniel Veillard 已提交
10144 10145 10146 10147

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10148
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10149
        virDispatchError(NULL);
10150
        return NULL;
D
Daniel Veillard 已提交
10151 10152
    }
    if (conn->flags & VIR_CONNECT_RO) {
10153
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
10154 10155 10156
        goto error;
    }
    if (xml == NULL) {
10157
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168
        goto error;
    }

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

10169
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10170 10171

error:
10172
    virDispatchError(conn);
D
Daniel Veillard 已提交
10173 10174 10175 10176 10177
    return NULL;
}

/**
 * virInterfaceUndefine:
10178
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
10179 10180 10181 10182
 *
 * Undefine an interface, ie remove it from the config.
 * This does not free the associated virInterfacePtr object.
 *
10183 10184 10185 10186 10187 10188 10189 10190 10191 10192
 * 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 已提交
10193 10194 10195
 * Returns 0 in case of success, -1 in case of error
 */
int
10196
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
10197
    virConnectPtr conn;
10198
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
10199 10200 10201

    virResetLastError();

10202
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10203
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10204
        virDispatchError(NULL);
10205
        return -1;
D
Daniel Veillard 已提交
10206
    }
10207
    conn = iface->conn;
D
Daniel Veillard 已提交
10208
    if (conn->flags & VIR_CONNECT_RO) {
10209
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
10210 10211 10212 10213 10214
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
10215
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
10216 10217 10218 10219 10220
        if (ret < 0)
            goto error;
        return ret;
    }

10221
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10222 10223

error:
10224
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
10225 10226 10227 10228 10229
    return -1;
}

/**
 * virInterfaceCreate:
10230
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
10231 10232
 * @flags: and OR'ed set of extraction flags, not used yet
 *
10233
 * Activate an interface (i.e. call "ifup").
D
Daniel Veillard 已提交
10234
 *
10235 10236 10237 10238 10239
 * 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 已提交
10240 10241 10242
 * Returns 0 in case of success, -1 in case of error
 */
int
10243
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
10244 10245
{
    virConnectPtr conn;
10246
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
10247 10248 10249

    virResetLastError();

10250
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10251
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10252
        virDispatchError(NULL);
10253
        return -1;
D
Daniel Veillard 已提交
10254
    }
10255
    conn = iface->conn;
D
Daniel Veillard 已提交
10256
    if (conn->flags & VIR_CONNECT_RO) {
10257
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
10258 10259 10260 10261 10262
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
10263
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
10264 10265 10266 10267 10268
        if (ret < 0)
            goto error;
        return ret;
    }

10269
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10270 10271

error:
10272
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
10273 10274 10275 10276 10277
    return -1;
}

/**
 * virInterfaceDestroy:
10278
 * @iface: an interface object
D
Daniel Veillard 已提交
10279 10280 10281 10282 10283 10284
 * @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.
 *
10285 10286 10287 10288 10289 10290 10291

 * 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 已提交
10292 10293 10294
 * Returns 0 in case of success and -1 in case of failure.
 */
int
10295
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
10296 10297
{
    virConnectPtr conn;
10298
    VIR_DEBUG("iface=%p, flags=%x", iface, flags);
D
Daniel Veillard 已提交
10299 10300 10301

    virResetLastError();

10302
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10303
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10304
        virDispatchError(NULL);
10305
        return -1;
D
Daniel Veillard 已提交
10306 10307
    }

10308
    conn = iface->conn;
D
Daniel Veillard 已提交
10309
    if (conn->flags & VIR_CONNECT_RO) {
10310
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
10311 10312 10313 10314 10315
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
10316
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
10317 10318 10319 10320 10321
        if (ret < 0)
            goto error;
        return ret;
    }

10322
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
10323 10324

error:
10325
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
10326 10327 10328 10329 10330
    return -1;
}

/**
 * virInterfaceRef:
10331
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
10332 10333 10334 10335 10336 10337 10338 10339 10340
 *
 * 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 已提交
10341
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
10342 10343 10344 10345 10346
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
10347
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
10348
{
10349
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
10350
        virLibConnError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10351
        virDispatchError(NULL);
10352
        return -1;
D
Daniel Veillard 已提交
10353
    }
10354
    virMutexLock(&iface->conn->lock);
10355
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
10356 10357
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
10358 10359 10360 10361 10362
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
10363
 * @iface: an interface object
D
Daniel Veillard 已提交
10364 10365 10366 10367 10368 10369 10370
 *
 * 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
10371
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
10372
{
10373
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
10374 10375 10376

    virResetLastError();

10377
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
10378
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
10379
        virDispatchError(NULL);
10380
        return -1;
D
Daniel Veillard 已提交
10381
    }
10382 10383
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
10384
        return -1;
10385
    }
10386
    return 0;
D
Daniel Veillard 已提交
10387 10388
}

10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408
/**
 * 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)
{
10409
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455

    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)
{
10456
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
10457 10458 10459 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 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502

    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)
{
10503
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533

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

10534 10535 10536

/**
 * virStoragePoolGetConnect:
10537
 * @pool: pointer to a pool
10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551
 *
 * 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)
{
10552
    VIR_DEBUG("pool=%p", pool);
10553

10554 10555 10556
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
10557
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
10558
        virDispatchError(NULL);
10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574
        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)
{
10575
    VIR_DEBUG("conn=%p", conn);
10576

10577 10578
    virResetLastError();

10579
    if (!VIR_IS_CONNECT(conn)) {
10580
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10581
        virDispatchError(NULL);
10582
        return -1;
10583 10584
    }

10585 10586 10587 10588 10589 10590 10591
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
10592

10593
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10594 10595

error:
10596
    virDispatchError(conn);
10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616
    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)
{
10617
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
10618

10619 10620
    virResetLastError();

10621
    if (!VIR_IS_CONNECT(conn)) {
10622
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10623
        virDispatchError(NULL);
10624
        return -1;
10625 10626 10627
    }

    if ((names == NULL) || (maxnames < 0)) {
10628
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10629
        goto error;
10630 10631
    }

10632 10633 10634 10635 10636 10637 10638
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
10639

10640
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10641

10642
error:
10643
    virDispatchError(conn);
10644
    return -1;
10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658
}


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

10661 10662
    virResetLastError();

10663
    if (!VIR_IS_CONNECT(conn)) {
10664
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10665
        virDispatchError(NULL);
10666
        return -1;
10667 10668
    }

10669 10670 10671 10672 10673 10674 10675
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
10676

10677
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10678 10679

error:
10680
    virDispatchError(conn);
10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701
    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)
{
10702
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
10703

10704 10705
    virResetLastError();

10706
    if (!VIR_IS_CONNECT(conn)) {
10707
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10708
        virDispatchError(NULL);
10709
        return -1;
10710 10711 10712
    }

    if ((names == NULL) || (maxnames < 0)) {
10713
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10714
        goto error;
10715 10716
    }

10717 10718 10719 10720 10721 10722 10723
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
10724

10725
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10726 10727

error:
10728
    virDispatchError(conn);
10729 10730 10731 10732
    return -1;
}


10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759
/**
 * 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)
{
10760
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%x",
O
Osier Yang 已提交
10761
              conn, NULLSTR(type), NULLSTR(srcSpec), flags);
10762 10763 10764

    virResetLastError();

10765
    if (!VIR_IS_CONNECT(conn)) {
10766
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10767
        virDispatchError(NULL);
10768
        return NULL;
10769 10770
    }
    if (type == NULL) {
10771
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10772
        goto error;
10773 10774
    }

10775
    if (conn->flags & VIR_CONNECT_RO) {
10776
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10777
        goto error;
10778 10779
    }

10780 10781 10782 10783 10784 10785 10786
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
10787

10788
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10789 10790

error:
10791
    virDispatchError(conn);
10792 10793 10794 10795
    return NULL;
}


10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808
/**
 * 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)
{
10809
    VIR_DEBUG("conn=%p, name=%s", conn, name);
10810

10811 10812
    virResetLastError();

10813
    if (!VIR_IS_CONNECT(conn)) {
10814
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10815
        virDispatchError(NULL);
10816
        return NULL;
10817 10818
    }
    if (name == NULL) {
10819
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10820
        goto error;
10821 10822
    }

10823 10824 10825 10826 10827 10828 10829
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
10830

10831
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10832 10833

error:
10834
    virDispatchError(conn);
10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851
    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)
{
10852
    VIR_UUID_DEBUG(conn, uuid);
10853

10854 10855
    virResetLastError();

10856
    if (!VIR_IS_CONNECT(conn)) {
10857
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10858
        virDispatchError(NULL);
10859
        return NULL;
10860 10861
    }
    if (uuid == NULL) {
10862
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10863
        goto error;
10864 10865
    }

10866 10867 10868 10869 10870 10871 10872
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
10873

10874
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10875

10876
error:
10877
    virDispatchError(conn);
10878
    return NULL;
10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892
}


/**
 * 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,
10893
                                 const char *uuidstr)
10894 10895
{
    unsigned char uuid[VIR_UUID_BUFLEN];
10896
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
10897

10898 10899
    virResetLastError();

10900
    if (!VIR_IS_CONNECT(conn)) {
10901
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10902
        virDispatchError(NULL);
10903
        return NULL;
10904 10905
    }
    if (uuidstr == NULL) {
10906
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10907
        goto error;
10908 10909 10910
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
10911
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10912
        goto error;
10913 10914 10915
    }

    return virStoragePoolLookupByUUID(conn, uuid);
10916 10917

error:
10918
    virDispatchError(conn);
10919
    return NULL;
10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933
}


/**
 * 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)
{
10934
    VIR_DEBUG("vol=%p", vol);
10935

10936 10937 10938
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10939
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10940
        virDispatchError(NULL);
10941
        return NULL;
10942 10943
    }

10944 10945 10946 10947 10948 10949 10950
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
10951

10952
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10953

10954
error:
10955
    virDispatchError(vol->conn);
10956
    return NULL;
10957 10958 10959 10960 10961 10962
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
10963
 * @flags: future flags, use 0 for now
10964 10965
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
10966
 * pool is not persistent, so its definition will disappear
10967 10968 10969 10970 10971 10972 10973 10974 10975
 * 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 已提交
10976
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
10977

10978 10979
    virResetLastError();

10980
    if (!VIR_IS_CONNECT(conn)) {
10981
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10982
        virDispatchError(NULL);
10983
        return NULL;
10984 10985
    }
    if (xmlDesc == NULL) {
10986
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10987
        goto error;
10988 10989
    }
    if (conn->flags & VIR_CONNECT_RO) {
10990
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10991
        goto error;
10992 10993
    }

10994 10995 10996 10997 10998 10999 11000
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
11001

11002
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11003 11004

error:
11005
    virDispatchError(conn);
11006 11007 11008 11009 11010 11011 11012
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
11013
 * @flags: future flags, use 0 for now
11014 11015
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
11016
 * pool is persistent, until explicitly undefined.
11017 11018 11019 11020 11021 11022 11023 11024
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
E
Eric Blake 已提交
11025
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
11026

11027 11028
    virResetLastError();

11029
    if (!VIR_IS_CONNECT(conn)) {
11030
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11031
        virDispatchError(NULL);
11032
        return NULL;
11033 11034
    }
    if (conn->flags & VIR_CONNECT_RO) {
11035
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11036
        goto error;
11037 11038
    }
    if (xml == NULL) {
11039
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11040
        goto error;
11041 11042
    }

11043 11044 11045 11046 11047 11048 11049
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
11050

11051
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11052

11053
error:
11054
    virDispatchError(conn);
11055
    return NULL;
11056 11057 11058 11059 11060
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
11061
 * @flags: future flags, use 0 for now
O
Osier Yang 已提交
11062 11063 11064 11065
 * @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.
11066 11067 11068 11069 11070 11071 11072 11073 11074 11075
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
11076
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11077

11078 11079
    virResetLastError();

11080
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11081
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
11082
        virDispatchError(NULL);
11083
        return -1;
11084 11085 11086
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11087
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11088
        goto error;
11089 11090
    }

11091 11092 11093 11094 11095 11096 11097
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11098

11099
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11100

11101
error:
11102
    virDispatchError(pool->conn);
11103
    return -1;
11104 11105 11106 11107 11108 11109 11110 11111 11112
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
11113
 * Returns 0 on success, -1 on failure
11114 11115 11116 11117 11118
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
11119
    VIR_DEBUG("pool=%p", pool);
11120

11121 11122
    virResetLastError();

11123
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11124
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
11125
        virDispatchError(NULL);
11126
        return -1;
11127 11128 11129
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11130
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11131
        goto error;
11132 11133
    }

11134 11135 11136 11137 11138 11139 11140
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
11141

11142
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11143

11144
error:
11145
    virDispatchError(pool->conn);
11146
    return -1;
11147 11148 11149 11150 11151 11152
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
11153
 * @flags: future flags, use 0 for now
11154 11155 11156 11157 11158 11159 11160 11161 11162 11163
 *
 * 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 已提交
11164
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11165

11166 11167
    virResetLastError();

11168
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11169
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11170
        virDispatchError(NULL);
11171
        return -1;
11172 11173 11174
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11175
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11176
        goto error;
11177 11178
    }

11179 11180 11181 11182 11183 11184 11185
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11186

11187
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11188

11189
error:
11190
    virDispatchError(pool->conn);
11191
    return -1;
11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210
}


/**
 * 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;
11211
    VIR_DEBUG("pool=%p", pool);
11212

11213 11214
    virResetLastError();

11215
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11216
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11217
        virDispatchError(NULL);
11218
        return -1;
11219 11220 11221 11222
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11223
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11224
        goto error;
11225 11226
    }

11227 11228 11229 11230 11231 11232 11233
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
11234

11235
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11236 11237

error:
11238
    virDispatchError(pool->conn);
11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257
    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;
11258
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11259

11260 11261
    virResetLastError();

11262
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11263
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11264
        virDispatchError(NULL);
11265
        return -1;
11266 11267 11268 11269
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11270
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11271
        goto error;
11272 11273
    }

11274 11275 11276 11277 11278 11279 11280
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11281

11282
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11283 11284

error:
11285
    virDispatchError(pool->conn);
11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301
    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)
{
11302
    VIR_DEBUG("pool=%p", pool);
11303

11304 11305 11306
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11307
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11308
        virDispatchError(NULL);
11309
        return -1;
11310
    }
11311 11312
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
11313
        return -1;
11314
    }
11315
    return 0;
11316 11317 11318 11319

}


11320 11321
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
11322
 * @pool: the pool to hold a reference on
11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333
 *
 * 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 已提交
11334 11335
 *
 * Returns 0 in case of success, -1 in case of failure.
11336 11337 11338 11339 11340
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
11341
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11342
        virDispatchError(NULL);
11343
        return -1;
11344 11345
    }
    virMutexLock(&pool->conn->lock);
11346
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
11347 11348 11349 11350 11351
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

11352 11353 11354 11355 11356 11357 11358 11359 11360
/**
 * 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
 *
11361
 * Returns 0 if the volume list was refreshed, -1 on failure
11362 11363 11364 11365 11366 11367
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
E
Eric Blake 已提交
11368
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11369

11370 11371
    virResetLastError();

11372
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11373
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11374
        virDispatchError(NULL);
11375
        return -1;
11376 11377 11378 11379
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11380
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11381
        goto error;
11382 11383
    }

11384 11385 11386 11387 11388 11389 11390
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
11391

11392
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11393 11394

error:
11395
    virDispatchError(pool->conn);
11396 11397 11398 11399 11400 11401 11402 11403 11404 11405
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
11406
 * Returns the name of the pool, or NULL on error
11407 11408 11409 11410
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
11411
    VIR_DEBUG("pool=%p", pool);
11412

11413 11414
    virResetLastError();

11415
    if (!VIR_IS_STORAGE_POOL(pool)) {
11416
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11417
        virDispatchError(NULL);
11418
        return NULL;
11419
    }
11420
    return pool->name;
11421 11422 11423 11424 11425 11426 11427 11428 11429 11430
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
11431
 * Returns 0 on success, or -1 on error;
11432 11433 11434 11435 11436
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
11437
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
11438

11439 11440
    virResetLastError();

11441
    if (!VIR_IS_STORAGE_POOL(pool)) {
11442
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11443
        virDispatchError(NULL);
11444
        return -1;
11445 11446
    }
    if (uuid == NULL) {
11447
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11448
        goto error;
11449 11450 11451 11452
    }

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

11453
    return 0;
11454

11455
error:
11456
    virDispatchError(pool->conn);
11457
    return -1;
11458 11459 11460 11461 11462 11463 11464 11465 11466
}

/**
 * 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
 *
11467
 * Returns 0 on success, or -1 on error;
11468 11469 11470 11471 11472 11473
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
11474
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
11475

11476 11477
    virResetLastError();

11478
    if (!VIR_IS_STORAGE_POOL(pool)) {
11479
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11480
        virDispatchError(NULL);
11481
        return -1;
11482 11483
    }
    if (buf == NULL) {
11484
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11485
        goto error;
11486 11487 11488
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
11489
        goto error;
11490 11491

    virUUIDFormat(uuid, buf);
11492
    return 0;
11493

11494
error:
11495
    virDispatchError(pool->conn);
11496
    return -1;
11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507
}


/**
 * 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
 *
11508
 * Returns 0 on success, or -1 on failure.
11509 11510 11511 11512 11513 11514
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
11515
    VIR_DEBUG("pool=%p, info=%p", pool, info);
11516

11517 11518
    virResetLastError();

11519
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11520
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11521
        virDispatchError(NULL);
11522
        return -1;
11523 11524
    }
    if (info == NULL) {
11525
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11526
        goto error;
11527 11528 11529 11530 11531 11532
    }

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

    conn = pool->conn;

11533 11534 11535 11536 11537 11538 11539
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
11540

11541
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11542

11543
error:
11544
    virDispatchError(pool->conn);
11545
    return -1;
11546 11547 11548 11549 11550 11551
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
11552
 * @flags: flags for XML format options (set of virDomainXMLFlags)
11553 11554 11555 11556 11557
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
11558
 * Returns a XML document, or NULL on error
11559 11560 11561 11562 11563 11564
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
11565
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
11566

11567 11568 11569
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11570
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11571
        virDispatchError(NULL);
11572
        return NULL;
11573 11574 11575 11576
    }

    conn = pool->conn;

11577 11578 11579 11580 11581 11582 11583
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
11584

11585
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11586

11587
error:
11588
    virDispatchError(pool->conn);
11589
    return NULL;
11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600
}


/**
 * 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
 *
11601
 * Returns 0 on success, -1 on failure
11602 11603 11604 11605 11606 11607
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
11608
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
11609

11610 11611 11612
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11613
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11614
        virDispatchError(NULL);
11615
        return -1;
11616 11617
    }
    if (!autostart) {
11618
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11619
        goto error;
11620 11621 11622 11623
    }

    conn = pool->conn;

11624 11625 11626 11627 11628 11629 11630
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
11631

11632
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11633 11634

error:
11635
    virDispatchError(pool->conn);
11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
11647
 * Returns 0 on success, -1 on failure
11648 11649 11650 11651 11652 11653
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
11654
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
11655

11656 11657 11658
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11659
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11660
        virDispatchError(NULL);
11661
        return -1;
11662 11663
    }

11664
    if (pool->conn->flags & VIR_CONNECT_RO) {
11665
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11666
        goto error;
11667 11668
    }

11669 11670
    conn = pool->conn;

11671 11672 11673 11674 11675 11676 11677
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
11678

11679
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11680 11681

error:
11682
    virDispatchError(pool->conn);
11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697
    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)
{
11698
    VIR_DEBUG("pool=%p", pool);
11699

11700 11701
    virResetLastError();

11702
    if (!VIR_IS_STORAGE_POOL(pool)) {
11703
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11704
        virDispatchError(NULL);
11705
        return -1;
11706 11707
    }

11708 11709 11710 11711 11712 11713 11714
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
11715

11716
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11717 11718

error:
11719
    virDispatchError(pool->conn);
11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739
    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)
{
11740
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
11741

11742 11743
    virResetLastError();

11744
    if (!VIR_IS_STORAGE_POOL(pool)) {
11745
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
11746
        virDispatchError(NULL);
11747
        return -1;
11748 11749 11750
    }

    if ((names == NULL) || (maxnames < 0)) {
11751
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11752
        goto error;
11753 11754
    }

11755 11756 11757 11758 11759 11760 11761
    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;
    }
11762

11763
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11764 11765

error:
11766
    virDispatchError(pool->conn);
11767 11768 11769 11770 11771 11772
    return -1;
}


/**
 * virStorageVolGetConnect:
11773
 * @vol: pointer to a pool
11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787
 *
 * 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)
{
11788
    VIR_DEBUG("vol=%p", vol);
11789

11790 11791
    virResetLastError();

11792
    if (!VIR_IS_STORAGE_VOL (vol)) {
11793
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11794
        virDispatchError(NULL);
11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808
        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
 *
11809
 * Returns a storage volume, or NULL if not found / error
11810 11811 11812 11813 11814
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
11815
    VIR_DEBUG("pool=%p, name=%s", pool, name);
11816

11817 11818
    virResetLastError();

11819
    if (!VIR_IS_STORAGE_POOL(pool)) {
11820
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11821
        virDispatchError(NULL);
11822
        return NULL;
11823 11824
    }
    if (name == NULL) {
11825
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11826
        goto error;
11827 11828
    }

11829 11830 11831 11832 11833 11834 11835
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
11836

11837
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11838 11839

error:
11840
    virDispatchError(pool->conn);
11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853
    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
 *
11854
 * Returns a storage volume, or NULL if not found / error
11855 11856 11857 11858 11859
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
11860
    VIR_DEBUG("conn=%p, key=%s", conn, key);
11861

11862 11863
    virResetLastError();

11864
    if (!VIR_IS_CONNECT(conn)) {
11865
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11866
        virDispatchError(NULL);
11867
        return NULL;
11868 11869
    }
    if (key == NULL) {
11870
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11871
        goto error;
11872 11873
    }

11874 11875 11876 11877 11878 11879 11880
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
11881

11882
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11883 11884

error:
11885
    virDispatchError(conn);
11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896
    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
 *
11897
 * Returns a storage volume, or NULL if not found / error
11898 11899 11900 11901 11902
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
11903
    VIR_DEBUG("conn=%p, path=%s", conn, path);
11904

11905 11906
    virResetLastError();

11907
    if (!VIR_IS_CONNECT(conn)) {
11908
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11909
        virDispatchError(NULL);
11910
        return NULL;
11911 11912
    }
    if (path == NULL) {
11913
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11914
        goto error;
11915 11916
    }

11917 11918 11919 11920 11921 11922 11923
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
11924

11925
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11926 11927

error:
11928
    virDispatchError(conn);
11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
11940
 * Returns the volume name, or NULL on error
11941 11942 11943 11944
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
11945
    VIR_DEBUG("vol=%p", vol);
11946

11947 11948
    virResetLastError();

11949
    if (!VIR_IS_STORAGE_VOL(vol)) {
11950
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11951
        virDispatchError(NULL);
11952
        return NULL;
11953
    }
11954
    return vol->name;
11955 11956 11957 11958 11959 11960 11961 11962
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
11963
 * unique, so the same volume will have the same
11964 11965
 * key no matter what host it is accessed from
 *
11966
 * Returns the volume key, or NULL on error
11967 11968 11969 11970
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
11971
    VIR_DEBUG("vol=%p", vol);
11972

11973 11974
    virResetLastError();

11975
    if (!VIR_IS_STORAGE_VOL(vol)) {
11976
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
11977
        virDispatchError(NULL);
11978
        return NULL;
11979
    }
11980
    return vol->key;
11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993
}


/**
 * 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
 *
11994
 * Returns the storage volume, or NULL on error
11995 11996 11997 11998 11999 12000
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
12001
    VIR_DEBUG("pool=%p, flags=%x", pool, flags);
12002

12003 12004
    virResetLastError();

12005
    if (!VIR_IS_STORAGE_POOL(pool)) {
12006
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
12007
        virDispatchError(NULL);
12008
        return NULL;
12009 12010
    }

12011 12012 12013 12014 12015
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

12016
    if (pool->conn->flags & VIR_CONNECT_RO) {
12017
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12018
        goto error;
12019 12020
    }

12021 12022 12023 12024 12025 12026 12027
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
12028

12029
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12030 12031

error:
12032
    virDispatchError(pool->conn);
12033 12034 12035 12036
    return NULL;
}


12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048
/**
 * 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.
 *
12049
 * Returns the storage volume, or NULL on error
12050 12051 12052 12053 12054 12055 12056
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
12057
    VIR_DEBUG("pool=%p, flags=%x, clonevol=%p", pool, flags, clonevol);
12058 12059 12060 12061

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
12062
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
12063
        virDispatchError(NULL);
12064
        return NULL;
12065 12066 12067
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
12068
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12069
        goto error;
12070 12071
    }

12072 12073 12074 12075 12076
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

12077 12078
    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
12079
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092
        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;
    }

12093
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12094 12095

error:
12096
    virDispatchError(pool->conn);
12097 12098 12099 12100
    return NULL;
}


12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127
/**
 * 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 已提交
12128
    VIR_DEBUG("vol=%p, stream=%p, offset=%llu, length=%llu, flags=%x",
12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198
              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 已提交
12199
    VIR_DEBUG("vol=%p, stream=%p, offset=%llu, length=%llu, flags=%x",
12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240
              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;
}


12241 12242 12243
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
12244
 * @flags: future flags, use 0 for now
12245 12246 12247
 *
 * Delete the storage volume from the pool
 *
12248
 * Returns 0 on success, or -1 on error
12249 12250 12251 12252 12253 12254
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
12255
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
12256

12257 12258
    virResetLastError();

12259
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
12260
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12261
        virDispatchError(NULL);
12262
        return -1;
12263 12264 12265 12266
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12267
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12268
        goto error;
12269 12270
    }

12271 12272 12273 12274 12275 12276 12277
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12278

12279
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12280 12281

error:
12282
    virDispatchError(vol->conn);
12283 12284 12285 12286
    return -1;
}


12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300
/**
 * 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;
12301
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
12302 12303 12304 12305

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
12306
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12307
        virDispatchError(NULL);
12308
        return -1;
12309 12310 12311 12312
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12313
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

12326
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12327 12328 12329 12330 12331 12332 12333

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


12334 12335 12336 12337 12338
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
12339
 * storage volume continues to exist.
12340
 *
12341
 * Returns 0 on success, or -1 on error
12342 12343 12344 12345
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
12346
    VIR_DEBUG("vol=%p", vol);
12347

12348 12349
    virResetLastError();

12350
    if (!VIR_IS_STORAGE_VOL(vol)) {
12351
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12352
        virDispatchError(NULL);
12353
        return -1;
12354
    }
12355 12356
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
12357
        return -1;
12358
    }
12359
    return 0;
12360 12361 12362
}


12363 12364
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
12365
 * @vol: the vol to hold a reference on
12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376
 *
 * 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 已提交
12377 12378
 *
 * Returns 0 in case of success, -1 in case of failure.
12379 12380 12381 12382 12383
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
12384
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12385
        virDispatchError(NULL);
12386
        return -1;
12387 12388
    }
    virMutexLock(&vol->conn->lock);
12389
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
12390 12391 12392 12393 12394
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

12395 12396 12397 12398 12399 12400 12401 12402
/**
 * 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
 *
12403
 * Returns 0 on success, or -1 on failure
12404 12405 12406 12407 12408 12409
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
12410
    VIR_DEBUG("vol=%p, info=%p", vol, info);
12411

12412 12413
    virResetLastError();

12414
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
12415
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12416
        virDispatchError(NULL);
12417
        return -1;
12418 12419
    }
    if (info == NULL) {
12420
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12421
        goto error;
12422 12423 12424 12425 12426 12427
    }

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

    conn = vol->conn;

12428 12429 12430 12431 12432 12433 12434
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
12435

12436
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12437 12438

error:
12439
    virDispatchError(vol->conn);
12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451
    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
 *
12452
 * Returns the XML document, or NULL on error
12453 12454 12455 12456 12457 12458
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
12459
    VIR_DEBUG("vol=%p, flags=%x", vol, flags);
12460

12461 12462
    virResetLastError();

12463
    if (!VIR_IS_STORAGE_VOL(vol)) {
12464
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12465
        virDispatchError(NULL);
12466
        return NULL;
12467 12468 12469 12470
    }

    conn = vol->conn;

12471 12472 12473 12474 12475 12476 12477
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
12478

12479
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12480

12481
error:
12482
    virDispatchError(vol->conn);
12483
    return NULL;
12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496
}


/**
 * 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
 *
12497 12498
 * Returns the storage volume path, or NULL on error. The
 * caller must free() the returned path after use.
12499 12500 12501 12502 12503
 */
char *
virStorageVolGetPath(virStorageVolPtr vol)
{
    virConnectPtr conn;
12504
    VIR_DEBUG("vol=%p", vol);
12505

12506 12507
    virResetLastError();

12508
    if (!VIR_IS_STORAGE_VOL(vol)) {
12509
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
12510
        virDispatchError(NULL);
12511
        return NULL;
12512 12513 12514 12515
    }

    conn = vol->conn;

12516 12517 12518 12519 12520 12521 12522
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
12523

12524
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12525 12526

error:
12527
    virDispatchError(vol->conn);
12528 12529
    return NULL;
}
12530 12531


12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547
/**
 * 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)
{
12548
    VIR_DEBUG("conn=%p, cap=%s, flags=%x", conn, NULLSTR(cap), flags);
12549

12550 12551
    virResetLastError();

12552
    if (!VIR_IS_CONNECT(conn)) {
12553
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12554
        virDispatchError(NULL);
12555
        return -1;
12556 12557
    }

12558 12559 12560 12561 12562 12563 12564
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12565

12566
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12567 12568

error:
12569
    virDispatchError(conn);
12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594
    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)
{
12595
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%x",
12596 12597
          conn, cap, names, maxnames, flags);

12598 12599
    virResetLastError();

12600
    if (!VIR_IS_CONNECT(conn)) {
12601
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12602
        virDispatchError(NULL);
12603
        return -1;
12604
    }
12605
    if ((names == NULL) || (maxnames < 0)) {
12606
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12607
        goto error;
12608 12609
    }

12610 12611 12612 12613 12614 12615 12616
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
12617

12618
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12619 12620

error:
12621
    virDispatchError(conn);
12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636
    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)
{
12637
    VIR_DEBUG("conn=%p, name=%p", conn, name);
12638

12639 12640
    virResetLastError();

12641
    if (!VIR_IS_CONNECT(conn)) {
12642
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12643
        virDispatchError(NULL);
12644 12645 12646 12647
        return NULL;
    }

    if (name == NULL) {
12648
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12649
        goto error;
12650 12651
    }

12652 12653 12654 12655 12656 12657 12658
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
12659

12660
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12661 12662

error:
12663
    virDispatchError(conn);
12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675
    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.
 *
12676
 * Returns the XML document, or NULL on error
12677 12678 12679
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
E
Eric Blake 已提交
12680
    VIR_DEBUG("dev=%p, conn=%p, flags=%x", dev, dev ? dev->conn : NULL, flags);
12681

12682 12683
    virResetLastError();

12684
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12685
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12686
        virDispatchError(NULL);
12687 12688 12689
        return NULL;
    }

12690
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetXMLDesc) {
12691
        char *ret;
12692
        ret = dev->conn->deviceMonitor->deviceGetXMLDesc(dev, flags);
12693 12694 12695 12696
        if (!ret)
            goto error;
        return ret;
    }
12697

12698
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12699 12700

error:
12701
    virDispatchError(dev->conn);
12702 12703 12704 12705 12706 12707 12708 12709
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12710 12711 12712
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
12713 12714 12715
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
12716
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12717 12718

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12719
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12720
        virDispatchError(NULL);
12721 12722 12723 12724 12725 12726 12727 12728 12729 12730
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12731 12732
 * Accessor for the parent of the device
 *
12733 12734 12735 12736 12737
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
12738
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12739

12740 12741
    virResetLastError();

12742
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12743
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12744
        virDispatchError(NULL);
12745 12746 12747
        return NULL;
    }

12748 12749 12750 12751
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
12752
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12753
            virDispatchError(dev->conn);
12754 12755 12756 12757
            return NULL;
        }
    }
    return dev->parent;
12758 12759 12760 12761 12762 12763
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
12764 12765
 * Accessor for the number of capabilities supported by the device.
 *
12766 12767 12768 12769
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
12770
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12771

12772 12773
    virResetLastError();

12774
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12775
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12776
        virDispatchError(NULL);
12777 12778 12779
        return -1;
    }

12780 12781 12782 12783 12784 12785 12786
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
12787

12788
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12789 12790

error:
12791
    virDispatchError(dev->conn);
12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808
    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)
{
12809
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
12810 12811
          dev, dev ? dev->conn : NULL, names, maxnames);

12812 12813
    virResetLastError();

12814
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12815
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12816
        virDispatchError(NULL);
12817 12818 12819
        return -1;
    }

12820 12821 12822 12823 12824
    if (names == NULL || maxnames < 0) {
        virLibNodeDeviceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

12825 12826 12827 12828 12829 12830 12831
    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;
    }
12832

12833
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12834 12835

error:
12836
    virDispatchError(dev->conn);
12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851
    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)
{
12852
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12853

12854 12855
    virResetLastError();

12856
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12857
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12858
        virDispatchError(NULL);
12859
        return -1;
12860
    }
12861 12862
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
12863
        return -1;
12864
    }
12865
    return 0;
12866 12867 12868
}


12869 12870
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
12871
 * @dev: the dev to hold a reference on
12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882
 *
 * 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 已提交
12883 12884
 *
 * Returns 0 in case of success, -1 in case of failure.
12885 12886 12887 12888 12889
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
12890
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12891
        virDispatchError(NULL);
12892
        return -1;
12893 12894
    }
    virMutexLock(&dev->conn->lock);
12895
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
12896 12897 12898 12899 12900
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

12901
/**
D
Daniel Veillard 已提交
12902
 * virNodeDeviceDettach:
12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916
 * @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 已提交
12917 12918
 *
 * Returns 0 in case of success, -1 in case of failure.
12919 12920 12921 12922
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
12923
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12924 12925 12926 12927

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12928
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12929
        virDispatchError(NULL);
12930
        return -1;
12931 12932
    }

12933 12934 12935 12936 12937
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12938 12939 12940 12941 12942 12943 12944 12945
    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12946
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12947 12948

error:
12949
    virDispatchError(dev->conn);
12950
    return -1;
12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964
}

/**
 * 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 已提交
12965 12966
 *
 * Returns 0 in case of success, -1 in case of failure.
12967 12968 12969 12970
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
12971
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
12972 12973 12974 12975

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
12976
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
12977
        virDispatchError(NULL);
12978
        return -1;
12979 12980
    }

12981 12982 12983 12984 12985
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

12986 12987 12988 12989 12990 12991 12992 12993
    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

12994
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12995 12996

error:
12997
    virDispatchError(dev->conn);
12998
    return -1;
12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014
}

/**
 * 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 已提交
13015 13016
 *
 * Returns 0 in case of success, -1 in case of failure.
13017 13018 13019 13020
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
13021
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
13022 13023 13024 13025

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
13026
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
13027
        virDispatchError(NULL);
13028
        return -1;
13029 13030
    }

13031 13032 13033 13034 13035
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

13036 13037 13038 13039 13040 13041 13042 13043
    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

13044
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13045 13046

error:
13047
    virDispatchError(dev->conn);
13048
    return -1;
13049 13050
}

13051

13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067
/**
 * 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)
{
13068
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
13069 13070 13071 13072

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13073
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13074
        virDispatchError(NULL);
13075 13076 13077 13078
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
13079
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13080 13081 13082 13083
        goto error;
    }

    if (xmlDesc == NULL) {
13084
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

13096
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13097 13098

error:
13099
    virDispatchError(conn);
13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115
    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)
{
13116
    VIR_DEBUG("dev=%p", dev);
13117 13118 13119 13120

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
13121
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
13122
        virDispatchError(NULL);
13123
        return -1;
13124 13125 13126
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
13127
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

13141
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13142 13143

error:
13144
    virDispatchError(dev->conn);
13145 13146 13147 13148
    return -1;
}


13149 13150 13151 13152 13153 13154 13155 13156 13157
/*
 * 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 已提交
13158
 * @freecb: optional function to deallocate opaque when not used anymore
13159
 *
13160 13161 13162 13163 13164 13165
 * 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
13166
 *
13167 13168
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
13169 13170
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
13171 13172 13173
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
13174 13175 13176 13177 13178
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
13179 13180
                              void *opaque,
                              virFreeCallback freecb)
13181
{
13182
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
13183
    virResetLastError();
13184 13185

    if (!VIR_IS_CONNECT(conn)) {
13186
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13187
        virDispatchError(NULL);
13188
        return -1;
13189 13190
    }
    if (cb == NULL) {
13191
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13192
        goto error;
13193 13194
    }

13195 13196 13197 13198 13199 13200 13201 13202
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

13203
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13204
error:
13205
    virDispatchError(conn);
13206 13207 13208 13209 13210 13211 13212 13213
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
13214 13215 13216 13217 13218 13219
 * 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
13220 13221 13222 13223 13224 13225 13226
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
13227
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
13228 13229

    virResetLastError();
13230 13231

    if (!VIR_IS_CONNECT(conn)) {
13232
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13233
        virDispatchError(NULL);
13234
        return -1;
13235 13236
    }
    if (cb == NULL) {
13237
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13238 13239 13240 13241 13242 13243 13244 13245
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
13246 13247
    }

13248
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13249
error:
13250
    virDispatchError(conn);
13251 13252
    return -1;
}
13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268

/**
 * 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)
{
13269
    VIR_DEBUG("secret=%p", secret);
13270 13271 13272 13273

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
13274
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13275
        virDispatchError(NULL);
13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296
        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)) {
13297
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13298
        virDispatchError(NULL);
13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

13312
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13313 13314

error:
13315
    virDispatchError(conn);
13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336
    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)) {
13337
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13338
        virDispatchError(NULL);
13339 13340 13341
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
13342
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354
        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;
    }

13355
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13356 13357

error:
13358
    virDispatchError(conn);
13359 13360 13361 13362
    return -1;
}

/**
13363 13364 13365
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
13366
 *
13367 13368
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
13369
 *
13370 13371
 * 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.
13372 13373
 */
virSecretPtr
13374
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
13375
{
13376
    VIR_UUID_DEBUG(conn, uuid);
13377 13378 13379 13380

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13381
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13382
        virDispatchError(NULL);
13383
        return NULL;
13384 13385
    }
    if (uuid == NULL) {
13386
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13387 13388 13389
        goto error;
    }

13390 13391
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
13392
        virSecretPtr ret;
13393 13394
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
13395 13396 13397 13398
            goto error;
        return ret;
    }

13399
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13400 13401

error:
13402
    virDispatchError(conn);
13403 13404 13405
    return NULL;
}

13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420
/**
 * 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];
13421
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
13422 13423 13424 13425

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13426
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13427
        virDispatchError(NULL);
13428
        return NULL;
13429 13430
    }
    if (uuidstr == NULL) {
13431
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13432 13433
        goto error;
    }
13434 13435

    if (virUUIDParse(uuidstr, uuid) < 0) {
13436
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13437 13438 13439 13440 13441 13442
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
13443
    virDispatchError(conn);
13444 13445 13446 13447
    return NULL;
}


13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465
/**
 * 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)
{
13466
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
13467 13468 13469 13470

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13471
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13472
        virDispatchError(NULL);
13473
        return NULL;
13474 13475
    }
    if (usageID == NULL) {
13476
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

13489
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13490 13491

error:
13492
    virDispatchError(conn);
13493 13494 13495 13496
    return NULL;
}


13497 13498 13499 13500 13501 13502
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
13503
 * If XML specifies a UUID, locates the specified secret and replaces all
13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514
 * 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)
{
13515
    VIR_DEBUG("conn=%p, xml=%s, flags=%x", conn, xml, flags);
13516 13517 13518 13519

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13520
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13521
        virDispatchError(NULL);
13522 13523 13524
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
13525
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13526 13527 13528
        goto error;
    }
    if (xml == NULL) {
13529
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541
        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;
    }

13542
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13543 13544

error:
13545
    virDispatchError(conn);
13546 13547 13548 13549
    return NULL;
}

/**
13550
 * virSecretGetUUID:
13551
 * @secret: A virSecret secret
13552
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
13553 13554 13555
 *
 * Fetches the UUID of the secret.
 *
13556 13557
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
13558
 */
13559 13560
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
13561 13562 13563 13564 13565 13566
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13567
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13568
        virDispatchError(NULL);
13569 13570 13571
        return -1;
    }
    if (uuid == NULL) {
13572
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13573
        virDispatchError(secret->conn);
13574
        return -1;
13575 13576
    }

13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595
    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];
13596
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
13597 13598

    virResetLastError();
13599

13600
    if (!VIR_IS_SECRET(secret)) {
13601
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13602
        virDispatchError(NULL);
13603
        return -1;
13604 13605
    }
    if (buf == NULL) {
13606
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13607 13608 13609 13610 13611 13612 13613
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
13614
    return 0;
13615 13616

error:
13617
    virDispatchError(secret->conn);
13618
    return -1;
13619 13620
}

13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636
/**
 * 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)
{
13637
    VIR_DEBUG("secret=%p", secret);
13638 13639 13640 13641

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
13642
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13643
        virDispatchError(NULL);
13644
        return -1;
13645
    }
13646
    return secret->usageType;
13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667
}

/**
 * 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)
{
13668
    VIR_DEBUG("secret=%p", secret);
13669 13670 13671 13672

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
13673
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13674
        virDispatchError(NULL);
13675
        return NULL;
13676
    }
13677
    return secret->usageID;
13678 13679
}

13680

13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695
/**
 * 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;

13696
    VIR_DEBUG("secret=%p, flags=%x", secret, flags);
13697 13698 13699 13700

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13701
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13702
        virDispatchError(NULL);
13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715
        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;
    }

13716
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13717 13718

error:
13719
    virDispatchError(conn);
13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739
    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;

13740
    VIR_DEBUG("secret=%p, value=%p, value_size=%zu, flags=%x", secret, value,
13741 13742 13743 13744 13745
              value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13746
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13747
        virDispatchError(NULL);
13748 13749 13750 13751
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13752
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13753 13754 13755
        goto error;
    }
    if (value == NULL) {
13756
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768
        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;
    }

13769
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13770 13771

error:
13772
    virDispatchError(conn);
13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791
    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;

13792
    VIR_DEBUG("secret=%p, value_size=%p, flags=%x", secret, value_size, flags);
13793 13794 13795 13796

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13797
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13798
        virDispatchError(NULL);
13799 13800 13801 13802
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13803
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13804 13805 13806
        goto error;
    }
    if (value_size == NULL) {
13807
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13808 13809 13810 13811 13812 13813
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->getValue != NULL) {
        unsigned char *ret;

13814
        ret = conn->secretDriver->getValue(secret, value_size, flags, 0);
13815 13816 13817 13818 13819
        if (ret == NULL)
            goto error;
        return ret;
    }

13820
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13821 13822

error:
13823
    virDispatchError(conn);
13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845
    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)) {
13846
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13847
        virDispatchError(NULL);
13848 13849 13850 13851
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13852
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

13865
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13866 13867

error:
13868
    virDispatchError(conn);
13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891
    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)) {
13892
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13893
        virDispatchError(NULL);
13894 13895 13896
        return -1;
    }
    virMutexLock(&secret->conn->lock);
13897
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
13909
 * Returns 0 on success, or -1 on error
13910 13911 13912 13913
 */
int
virSecretFree(virSecretPtr secret)
{
13914
    VIR_DEBUG("secret=%p", secret);
13915 13916 13917 13918

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
13919
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
13920
        virDispatchError(NULL);
13921 13922
        return -1;
    }
13923 13924
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
13925
        return -1;
13926
    }
13927 13928
    return 0;
}
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955


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

13956
    VIR_DEBUG("conn=%p, flags=%x", conn, flags);
13957 13958 13959 13960

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13961
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13962
        virDispatchError(NULL);
13963
        return NULL;
13964 13965 13966 13967 13968
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;
13969 13970
    else
        virDispatchError(conn);
13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990

    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))) {
13991
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13992
        virDispatchError(NULL);
13993
        return -1;
13994 13995
    }
    virMutexLock(&stream->conn->lock);
13996
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011
    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
14012
 * it should call virStreamFinish to wait for successful
14013
 * confirmation from the driver, or detect any error.
14014 14015
 *
 * This method may not be used if a stream source has been
14016
 * registered.
14017 14018 14019 14020 14021
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
14022
 * An example using this with a hypothetical file upload
14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070
 * 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)
{
14071
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
14072 14073 14074 14075

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14076
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14077
        virDispatchError(NULL);
14078
        return -1;
14079 14080
    }

14081 14082 14083 14084 14085
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096
    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;
    }

14097
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14098 14099

error:
14100
    virDispatchError(stream->conn);
14101 14102 14103 14104 14105 14106 14107
    return -1;
}


/**
 * virStreamRecv:
 * @stream: pointer to the stream object
14108
 * @data: buffer to read into from stream
14109 14110
 * @nbytes: size of @data buffer
 *
14111
 * Reads a series of bytes from the stream. This method may
14112 14113 14114 14115 14116 14117 14118
 * 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 已提交
14119
 * An example using this with a hypothetical file download
14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170
 * 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)
{
14171
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
14172 14173 14174 14175

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14176
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14177
        virDispatchError(NULL);
14178
        return -1;
14179 14180
    }

14181 14182 14183 14184 14185
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196
    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;
    }

14197
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14198 14199

error:
14200
    virDispatchError(stream->conn);
14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214
    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 已提交
14215
 * An example using this with a hypothetical file upload
14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236
 * 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);
 *
14237
 * Returns 0 if all the data was successfully sent. The caller
14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251
 * 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;
14252
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
14253 14254 14255 14256

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14257
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14258
        virDispatchError(NULL);
14259
        return -1;
14260 14261
    }

14262 14263 14264 14265 14266
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

14267
    if (stream->flags & VIR_STREAM_NONBLOCK) {
14268
        virLibConnError(VIR_ERR_OPERATION_INVALID,
14269 14270 14271 14272 14273
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
14274
        virReportOOMError();
14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300
        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)
14301
        virDispatchError(stream->conn);
14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316

    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 已提交
14317
 * An example using this with a hypothetical file download
14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338
 * 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);
 *
14339
 * Returns 0 if all the data was successfully received. The caller
14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353
 * 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;
14354
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
14355 14356 14357 14358

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14359
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14360
        virDispatchError(NULL);
14361
        return -1;
14362 14363
    }

14364 14365 14366 14367 14368
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

14369
    if (stream->flags & VIR_STREAM_NONBLOCK) {
14370
        virLibConnError(VIR_ERR_OPERATION_INVALID,
14371 14372 14373 14374 14375 14376
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
14377
        virReportOOMError();
14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403
        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)
14404
        virDispatchError(stream->conn);
14405 14406 14407 14408 14409 14410

    return ret;
}


/**
M
Matthias Bolte 已提交
14411
 * virStreamEventAddCallback:
14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430
 * @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)
{
14431
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
14432 14433 14434 14435

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14436
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14437
        virDispatchError(NULL);
14438
        return -1;
14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

14450
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14451 14452

error:
14453
    virDispatchError(stream->conn);
14454 14455 14456 14457 14458
    return -1;
}


/**
M
Matthias Bolte 已提交
14459
 * virStreamEventUpdateCallback:
14460 14461 14462 14463 14464 14465
 * @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 已提交
14466
 * is guaranteed to succeed if a callback is already registered
14467 14468 14469 14470 14471 14472
 *
 * Returns 0 on success, -1 if no callback is registered
 */
int virStreamEventUpdateCallback(virStreamPtr stream,
                                 int events)
{
14473
    VIR_DEBUG("stream=%p, events=%d", stream, events);
14474 14475 14476 14477

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14478
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14479
        virDispatchError(NULL);
14480
        return -1;
14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

14492
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14493 14494

error:
14495
    virDispatchError(stream->conn);
14496 14497 14498 14499
    return -1;
}

/**
M
Matthias Bolte 已提交
14500
 * virStreamEventRemoveCallback:
14501 14502
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
14503
 * Remove an event callback from the stream
14504 14505 14506 14507 14508
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
14509
    VIR_DEBUG("stream=%p", stream);
14510 14511 14512 14513

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14514
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14515
        virDispatchError(NULL);
14516
        return -1;
14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14528
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14529 14530

error:
14531
    virDispatchError(stream->conn);
14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551
    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)
{
14552
    VIR_DEBUG("stream=%p", stream);
14553 14554 14555 14556

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14557
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14558
        virDispatchError(NULL);
14559
        return -1;
14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14571
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14572 14573

error:
14574
    virDispatchError(stream->conn);
14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592
    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)
{
14593
    VIR_DEBUG("stream=%p", stream);
14594 14595 14596 14597

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14598
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14599
        virDispatchError(NULL);
14600
        return -1;
14601 14602
    }

14603 14604 14605 14606 14607 14608
    if (!stream->driver) {
        VIR_DEBUG("aborting unused stream");
        return 0;
    }

    if (stream->driver->streamAbort) {
14609 14610 14611 14612 14613 14614 14615
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

14616
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14617 14618

error:
14619
    virDispatchError(stream->conn);
14620 14621 14622 14623 14624 14625 14626 14627 14628 14629
    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 已提交
14630
 * There must not be an active data transfer in progress
14631 14632 14633 14634 14635 14636 14637 14638
 * 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)
{
14639
    VIR_DEBUG("stream=%p", stream);
14640 14641 14642 14643

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
14644
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14645
        virDispatchError(NULL);
14646
        return -1;
14647 14648 14649 14650
    }

    /* XXX Enforce shutdown before free'ing resources ? */

14651 14652
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
14653
        return -1;
14654
    }
14655
    return 0;
14656
}
14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668


/**
 * 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)
{
14669
    VIR_DEBUG("dom=%p", dom);
14670 14671 14672 14673

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14674
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14675
        virDispatchError(NULL);
14676
        return -1;
14677 14678 14679 14680 14681 14682 14683 14684 14685
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14686
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14687
error:
14688
    virDispatchError(dom->conn);
14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702
    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)
{
14703
    VIR_DOMAIN_DEBUG(dom);
14704 14705 14706 14707

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14708
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14709
        virDispatchError(NULL);
14710
        return -1;
14711 14712 14713 14714 14715 14716 14717 14718 14719
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14720
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14721
error:
14722
    virDispatchError(dom->conn);
14723 14724 14725
    return -1;
}

14726 14727 14728 14729 14730 14731 14732 14733 14734 14735
/**
 * 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)
{
14736
    VIR_DOMAIN_DEBUG(dom);
14737 14738 14739 14740

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
14741
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14742
        virDispatchError(NULL);
14743
        return -1;
14744 14745 14746 14747 14748 14749 14750 14751 14752
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

14753
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14754 14755 14756 14757 14758
error:
    virDispatchError(dom->conn);
    return -1;
}

14759 14760 14761 14762 14763 14764 14765 14766 14767 14768
/**
 * 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)
{
14769
    VIR_DEBUG("net=%p", net);
14770 14771 14772 14773

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
14774
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14775
        virDispatchError(NULL);
14776
        return -1;
14777 14778 14779 14780 14781 14782 14783 14784 14785
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

14786
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14787
error:
14788
    virDispatchError(net->conn);
14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803
    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)
{
14804
    VIR_DEBUG("net=%p", net);
14805 14806 14807 14808

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
14809
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14810
        virDispatchError(NULL);
14811
        return -1;
14812 14813 14814 14815 14816 14817 14818 14819 14820
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

14821
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14822
error:
14823
    virDispatchError(net->conn);
14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837
    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)
{
14838
    VIR_DEBUG("pool=%p", pool);
14839 14840 14841 14842

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
14843
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14844
        virDispatchError(NULL);
14845
        return -1;
14846 14847 14848 14849 14850 14851 14852 14853 14854
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

14855
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14856
error:
14857
    virDispatchError(pool->conn);
14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872
    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)
{
14873
    VIR_DEBUG("pool=%p", pool);
14874 14875 14876 14877

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
14878
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
14879
        virDispatchError(NULL);
14880
        return -1;
14881 14882 14883 14884 14885 14886 14887 14888 14889
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

14890
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14891
error:
14892
    virDispatchError(pool->conn);
14893 14894 14895 14896
    return -1;
}


S
Stefan Berger 已提交
14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908

/**
 * 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)
{
14909
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
14910 14911 14912 14913

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14914
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926
        virDispatchError(NULL);
        return -1;
    }

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

14927
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947

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)
{
14948
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
14949 14950 14951 14952

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14953
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14954 14955 14956 14957 14958
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
14959
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970
        goto error;
    }

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

14971
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991

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)
{
14992
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
14993 14994 14995 14996

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
14997
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
14998
        virDispatchError(NULL);
14999
        return NULL;
S
Stefan Berger 已提交
15000 15001
    }
    if (name == NULL) {
15002
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

15014
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033

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)
{
15034
    VIR_UUID_DEBUG(conn, uuid);
S
Stefan Berger 已提交
15035 15036 15037 15038

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15039
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
15040
        virDispatchError(NULL);
15041
        return NULL;
S
Stefan Berger 已提交
15042 15043
    }
    if (uuid == NULL) {
15044
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

15056
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15057 15058 15059 15060 15061 15062 15063

error:
    virDispatchError(conn);
    return NULL;
}

/**
15064
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076
 * @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];
15077
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, NULLSTR(uuidstr));
S
Stefan Berger 已提交
15078 15079 15080 15081

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15082
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
15083
        virDispatchError(NULL);
15084
        return NULL;
S
Stefan Berger 已提交
15085 15086
    }
    if (uuidstr == NULL) {
15087
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15088 15089 15090 15091
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
15092
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114
        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)
{
15115
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
15116 15117 15118 15119

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
15120
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142
        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)
{
15143
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
15144 15145 15146 15147

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
15148
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15149
        virDispatchError(NULL);
15150
        return NULL;
S
Stefan Berger 已提交
15151
    }
15152
    return nwfilter->name;
S
Stefan Berger 已提交
15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166
}

/**
 * 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)
{
15167
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
15168 15169 15170 15171

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
15172
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15173 15174 15175 15176
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
15177
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203
        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];
15204
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
15205 15206 15207 15208

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
15209
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15210 15211 15212 15213
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
15214
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242
        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)
{
15243
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
15244 15245 15246 15247

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15248
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
15249
        virDispatchError(NULL);
15250
        return NULL;
S
Stefan Berger 已提交
15251 15252
    }
    if (xmlDesc == NULL) {
15253
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15254 15255 15256
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
15257
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
15258 15259 15260 15261 15262
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
E
Eric Blake 已提交
15263
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc);
S
Stefan Berger 已提交
15264 15265 15266 15267 15268
        if (!ret)
            goto error;
        return ret;
    }

15269
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290

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;
15291
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
15292 15293 15294 15295

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
15296
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15297 15298 15299 15300 15301 15302
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15303
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

15315
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334

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 *
15335
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
S
Stefan Berger 已提交
15336 15337
{
    virConnectPtr conn;
15338
    VIR_DEBUG("nwfilter=%p, flags=%x", nwfilter, flags);
S
Stefan Berger 已提交
15339 15340 15341 15342

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
15343
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
15344
        virDispatchError(NULL);
15345
        return NULL;
S
Stefan Berger 已提交
15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357
    }

    conn = nwfilter->conn;

    if (conn->nwfilterDriver && conn->nwfilterDriver->getXMLDesc) {
        char *ret;
        ret = conn->nwfilterDriver->getXMLDesc (nwfilter, flags);
        if (!ret)
            goto error;
        return ret;
    }

15358
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386

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))) {
15387
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
15388 15389 15390 15391
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
15392
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
15393 15394 15395 15396 15397 15398
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


15399 15400 15401 15402 15403 15404 15405 15406 15407 15408
/**
 * 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)
{
15409
    VIR_DEBUG("iface=%p", iface);
15410 15411 15412 15413

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
15414
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15415
        virDispatchError(NULL);
15416
        return -1;
15417 15418 15419 15420 15421 15422 15423 15424 15425
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

15426
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15427
error:
15428
    virDispatchError(iface->conn);
15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442
    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)
{
15443
    VIR_DEBUG("conn=%p", conn);
15444 15445 15446 15447

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15448
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15449
        virDispatchError(NULL);
15450
        return -1;
15451 15452 15453 15454 15455 15456 15457 15458 15459
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

15460
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15461
error:
15462
    virDispatchError(conn);
15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479
    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)
{
15480
    VIR_DEBUG("conn=%p", conn);
15481 15482 15483 15484

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15485
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15486
        virDispatchError(NULL);
15487
        return -1;
15488 15489 15490 15491 15492 15493 15494 15495 15496
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

15497
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15498
error:
15499
    virDispatchError(conn);
15500 15501
    return -1;
}
J
Jiri Denemark 已提交
15502 15503 15504 15505 15506


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
15507 15508 15509 15510
 * @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 已提交
15511 15512 15513 15514 15515 15516 15517 15518
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
15519
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%x", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
15520 15521 15522 15523

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15524
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15525
        virDispatchError(NULL);
J
Jiri Denemark 已提交
15526 15527 15528
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
15529
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541
        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;
    }

15542
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
15543 15544

error:
15545
    virDispatchError(conn);
J
Jiri Denemark 已提交
15546 15547
    return VIR_CPU_COMPARE_ERROR;
}
15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570


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

15571
    VIR_DEBUG("conn=%p, xmlCPUs=%p, ncpus=%u, flags=%x",
15572 15573 15574 15575 15576 15577 15578 15579 15580
              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)) {
15581
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15582 15583 15584 15585
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
15586
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598
        goto error;
    }

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

15599
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15600 15601 15602 15603 15604

error:
    virDispatchError(conn);
    return NULL;
}
15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620


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

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
15623 15624 15625 15626

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15627
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15628
        virDispatchError(NULL);
15629
        return -1;
15630 15631
    }
    if (info == NULL) {
15632
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647
        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;
    }

15648
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15649 15650 15651 15652 15653

error:
    virDispatchError(domain->conn);
    return -1;
}
15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670


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

15671
    VIR_DOMAIN_DEBUG(domain);
15672 15673 15674 15675

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15676
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15677
        virDispatchError(NULL);
15678
        return -1;
15679 15680 15681 15682
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15683
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694
        goto error;
    }

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

15695
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15696 15697 15698 15699 15700

error:
    virDispatchError(conn);
    return -1;
}
15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721


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

15722
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%x", downtime, flags);
15723 15724 15725 15726

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
15727
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
15728 15729 15730 15731 15732 15733
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
15734
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
15735 15736 15737 15738 15739 15740 15741 15742 15743
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

15744
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15745 15746 15747 15748 15749
error:
    virDispatchError(conn);
    return -1;
}

15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768
/**
 * 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;

15769
    VIR_DOMAIN_DEBUG(domain, "bandwidth=%lu, flags=%x", bandwidth, flags);
15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790

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

15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824
    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;
    }

15825 15826
    conn = domain->conn;

15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842
    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;
    }

15843 15844 15845 15846 15847 15848
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870
/**
 * 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.
15871 15872
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889
 * 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)
{
15890 15891 15892
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

15893 15894 15895
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15896
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15897
        virDispatchError(NULL);
15898
        return -1;
15899 15900 15901
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
15902
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15903
        virDispatchError(conn);
15904
        return -1;
15905 15906
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
15907
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918
        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;
    }

15919
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15920 15921 15922 15923
error:
    virDispatchError(conn);
    return -1;
}
15924

15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938
/**
 * 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)
{
15939
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
15940 15941 15942 15943

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
15944
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
15945
        virDispatchError(NULL);
15946
        return -1;
15947 15948
    }
    if (callbackID < 0) {
15949
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
15950 15951 15952 15953 15954 15955 15956 15957 15958 15959
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

15960
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
15961 15962 15963 15964
error:
    virDispatchError(conn);
    return -1;
}
15965 15966 15967 15968

/**
 * virDomainManagedSave:
 * @dom: pointer to the domain
15969
 * @flags: bitwise-OR of virDomainSaveRestoreFlags
15970 15971 15972 15973 15974 15975 15976 15977
 *
 * 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.
15978 15979 15980
 * 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.
15981
 *
15982 15983 15984 15985 15986
 * 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.
 *
15987 15988 15989 15990 15991 15992
 * 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.
 *
15993 15994 15995 15996 15997 15998
 * Returns 0 in case of success or -1 in case of failure
 */
int virDomainManagedSave(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

15999
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
16000 16001 16002 16003

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
16004
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
16005 16006 16007 16008 16009 16010
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
16011
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
16012 16013 16014
        goto error;
    }

16015 16016 16017 16018 16019 16020
    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;
    }

16021 16022 16023 16024 16025 16026 16027 16028 16029
    if (conn->driver->domainManagedSave) {
        int ret;

        ret = conn->driver->domainManagedSave(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16030
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052

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;

16053
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
16054 16055 16056 16057

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
16058
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073
        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;
    }

16074
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
16086
 * Remove any managed save image for this domain.
16087 16088 16089 16090 16091 16092 16093
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

16094
    VIR_DOMAIN_DEBUG(dom, "flags=%x", flags);
16095 16096 16097 16098

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
16099
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
16100 16101 16102 16103 16104 16105
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
16106
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118
        goto error;
    }

    if (conn->driver->domainManagedSaveRemove) {
        int ret;

        ret = conn->driver->domainManagedSaveRemove(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16119
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
16120 16121 16122 16123 16124

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
16125

16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198
/**
 * 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 已提交
16199 16200 16201 16202
/**
 * virDomainSnapshotCreateXML:
 * @domain: a domain object
 * @xmlDesc: string containing an XML description of the domain
16203
 * @flags: bitwise-OR of virDomainSnapshotCreateFlags
C
Chris Lalancette 已提交
16204 16205 16206 16207
 *
 * Creates a new snapshot of a domain based on the snapshot xml
 * contained in xmlDesc.
 *
16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242
 * 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.
 *
16243 16244 16245 16246 16247 16248
 * 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.
 *
16249 16250 16251 16252 16253 16254
 * 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 已提交
16255 16256 16257 16258 16259 16260 16261 16262 16263
 * Returns an (opaque) virDomainSnapshotPtr on success, NULL on failure.
 */
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
                           const char *xmlDesc,
                           unsigned int flags)
{
    virConnectPtr conn;

16264
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%x", xmlDesc, flags);
C
Chris Lalancette 已提交
16265 16266 16267 16268

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16269
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16270 16271 16272 16273 16274
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
16275 16276 16277 16278 16279 16280

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

C
Chris Lalancette 已提交
16281
    if (conn->flags & VIR_CONNECT_RO) {
16282
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
16283 16284 16285
        goto error;
    }

16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297
    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;
    }
16298 16299 16300 16301 16302 16303
    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;
    }
16304

C
Chris Lalancette 已提交
16305 16306 16307 16308 16309 16310 16311 16312
    if (conn->driver->domainSnapshotCreateXML) {
        virDomainSnapshotPtr ret;
        ret = conn->driver->domainSnapshotCreateXML(domain, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }

16313
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16314 16315 16316 16317 16318 16319 16320 16321
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotGetXMLDesc:
 * @snapshot: a domain snapshot object
16322
 * @flags: bitwise-OR of subset of virDomainXMLFlags
C
Chris Lalancette 已提交
16323 16324 16325
 *
 * Provide an XML description of the domain snapshot.
 *
16326 16327 16328 16329 16330
 * 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 已提交
16331 16332 16333 16334 16335 16336 16337 16338
 * 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;
16339
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16340 16341 16342 16343

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16344
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16345 16346
                                  __FUNCTION__);
        virDispatchError(NULL);
16347
        return NULL;
C
Chris Lalancette 已提交
16348 16349 16350 16351 16352
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
16353
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
16354 16355 16356 16357
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

16358
    if (conn->driver->domainSnapshotGetXMLDesc) {
C
Chris Lalancette 已提交
16359
        char *ret;
16360
        ret = conn->driver->domainSnapshotGetXMLDesc(snapshot, flags);
C
Chris Lalancette 已提交
16361 16362 16363 16364 16365
        if (!ret)
            goto error;
        return ret;
    }

16366
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16367 16368 16369 16370 16371 16372 16373 16374
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotNum:
 * @domain: a domain object
16375 16376 16377
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
 *
 * Provides the number of domain snapshots for this domain.
C
Chris Lalancette 已提交
16378
 *
16379
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_ROOTS, then the result is
16380 16381 16382 16383
 * 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 已提交
16384
 *
16385 16386 16387 16388 16389 16390
 * 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 已提交
16391 16392 16393 16394 16395
 */
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
16396

E
Eric Blake 已提交
16397
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
16398 16399 16400 16401

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16402
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16403 16404 16405 16406 16407 16408 16409 16410 16411 16412 16413 16414
        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;
    }

16415
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16416 16417 16418 16419 16420 16421 16422 16423 16424 16425
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotListNames:
 * @domain: a domain object
 * @names: array to collect the list of names of snapshots
 * @nameslen: size of @names
16426
 * @flags: bitwise-or of supported virDomainSnapshotListFlags
C
Chris Lalancette 已提交
16427 16428 16429
 *
 * Collect the list of domain snapshots for the given domain, and store
 * their names in @names.  Caller is responsible for freeing each member
16430 16431 16432 16433
 * 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
16434 16435 16436 16437
 * 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.
16438 16439 16440 16441 16442
 *
 * 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 已提交
16443 16444 16445 16446 16447 16448 16449 16450 16451
 *
 * 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;

16452
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%x",
16453
                     names, nameslen, flags);
C
Chris Lalancette 已提交
16454 16455 16456 16457

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16458
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16459 16460 16461 16462 16463 16464 16465
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
16466
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477
        goto error;
    }

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

16478
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16479 16480 16481 16482 16483
error:
    virDispatchError(conn);
    return -1;
}

16484 16485 16486 16487 16488 16489 16490 16491 16492 16493
/**
 * 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.
 *
16494 16495 16496
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_LEAVES, then the result is
 * filtered to the number of snapshots that have no children.
 *
16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 16526 16527 16528 16529 16530 16531 16532 16533 16534 16535 16536 16537 16538 16539 16540 16541 16542 16543 16544 16545 16546 16547 16548
 * 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.
 *
16549 16550 16551
 * If @flags includes VIR_DOMAIN_SNAPSHOT_LIST_LEAVES, then the result is
 * filtered to the number of snapshots that have no children.
 *
16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 16577 16578 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600
 * 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 已提交
16601 16602 16603 16604 16605 16606 16607 16608 16609 16610 16611 16612 16613 16614 16615 16616 16617 16618
/**
 * 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;
16619

16620
    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%x", name, flags);
C
Chris Lalancette 已提交
16621 16622 16623 16624

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16625
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16626
        virDispatchError(NULL);
16627
        return NULL;
C
Chris Lalancette 已提交
16628 16629 16630 16631 16632
    }

    conn = domain->conn;

    if (name == NULL) {
16633
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644
        goto error;
    }

    if (conn->driver->domainSnapshotLookupByName) {
        virDomainSnapshotPtr dom;
        dom = conn->driver->domainSnapshotLookupByName(domain, name, flags);
        if (!dom)
            goto error;
        return dom;
    }

16645
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16646 16647 16648 16649 16650 16651 16652 16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663
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;
16664

16665
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
16666 16667 16668 16669

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16670
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16671 16672 16673 16674 16675 16676 16677 16678 16679 16680 16681 16682 16683
        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;
    }

16684
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16685 16686 16687 16688 16689 16690 16691 16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705
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;
16706

16707
    VIR_DOMAIN_DEBUG(domain, "flags=%x", flags);
C
Chris Lalancette 已提交
16708 16709 16710 16711

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
16712
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
16713
        virDispatchError(NULL);
16714
        return NULL;
C
Chris Lalancette 已提交
16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

16727
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16728 16729 16730 16731 16732
error:
    virDispatchError(conn);
    return NULL;
}

16733 16734 16735 16736 16737 16738 16739 16740 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
/**
 * 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 已提交
16777
/**
16778
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
16779
 * @snapshot: a domain snapshot object
16780
 * @flags: bitwise-OR of virDomainSnapshotRevertFlags
C
Chris Lalancette 已提交
16781 16782 16783
 *
 * Revert the domain to a given snapshot.
 *
16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795
 * 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 已提交
16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817
 * 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 已提交
16818 16819 16820 16821 16822 16823 16824 16825
 * Returns 0 if the creation is successful, -1 on error.
 */
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
                          unsigned int flags)
{
    virConnectPtr conn;

16826
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16827 16828 16829 16830

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16831
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16832 16833 16834 16835 16836 16837
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
16838 16839 16840 16841
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
16842

16843 16844 16845 16846 16847 16848 16849
    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 已提交
16850 16851 16852 16853 16854 16855 16856
    if (conn->driver->domainRevertToSnapshot) {
        int ret = conn->driver->domainRevertToSnapshot(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16857
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16858 16859 16860 16861 16862 16863
error:
    virDispatchError(conn);
    return -1;
}

/**
16864
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
16865
 * @snapshot: a domain snapshot object
16866
 * @flags: bitwise-or of supported virDomainSnapshotDeleteFlags
C
Chris Lalancette 已提交
16867 16868 16869
 *
 * Delete the snapshot.
 *
16870 16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882
 * 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 已提交
16883
 *
16884 16885
 * Returns 0 if the selected snapshot(s) were successfully deleted,
 * -1 on error.
C
Chris Lalancette 已提交
16886 16887 16888 16889 16890 16891 16892
 */
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
                        unsigned int flags)
{
    virConnectPtr conn;

16893
    VIR_DEBUG("snapshot=%p, flags=%x", snapshot, flags);
C
Chris Lalancette 已提交
16894 16895 16896 16897

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16898
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16899 16900 16901 16902 16903 16904
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
16905 16906 16907 16908
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
16909

16910 16911 16912 16913 16914 16915 16916 16917
    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 已提交
16918 16919 16920 16921 16922 16923 16924
    if (conn->driver->domainSnapshotDelete) {
        int ret = conn->driver->domainSnapshotDelete(snapshot, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

16925
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942
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)
{
16943
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
16944 16945 16946 16947

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
16948
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
16949 16950 16951 16952 16953 16954 16955 16956 16957 16958
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
16959 16960 16961 16962

/**
 * virDomainOpenConsole:
 * @dom: a domain object
16963
 * @dev_name: the console, serial or parallel port device alias, or NULL
16964 16965 16966 16967 16968
 * @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.
16969
 * If the @dev_name is omitted, then the first console or serial
16970 16971 16972 16973 16974 16975 16976
 * 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,
16977
                         const char *dev_name,
16978 16979 16980 16981
                         virStreamPtr st,
                         unsigned int flags)
{
    virConnectPtr conn;
16982

16983 16984
    VIR_DOMAIN_DEBUG(dom, "dev_name=%s, st=%p, flags=%x",
                     NULLSTR(dev_name), st, flags);
16985 16986 16987 16988

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
16989
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
16990 16991 16992 16993 16994 16995
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
16996
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
16997 16998 16999 17000 17001
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
17002
        ret = conn->driver->domainOpenConsole(dom, dev_name, st, flags);
17003 17004 17005 17006 17007
        if (ret < 0)
            goto error;
        return ret;
    }

17008
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
17009 17010 17011 17012 17013

error:
    virDispatchError(conn);
    return -1;
}
17014 17015 17016 17017

/**
 * virDomainBlockJobAbort:
 * @dom: pointer to domain object
17018
 * @disk: path to the block device, or device shorthand
17019 17020 17021 17022
 * @flags: currently unused, for future extension
 *
 * Cancel the active block job on the given disk.
 *
17023
 * The @disk parameter is either an unambiguous source name of the
17024 17025 17026 17027 17028 17029
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
 *
17030 17031
 * Returns -1 in case of failure, 0 when successful.
 */
17032
int virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
17033 17034 17035 17036
                           unsigned int flags)
{
    virConnectPtr conn;

17037
    VIR_DOMAIN_DEBUG(dom, "disk=%p, flags=%x", disk, flags);
17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052

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

17053
    if (!disk) {
17054
        virLibDomainError(VIR_ERR_INVALID_ARG,
17055
                          _("disk is NULL"));
17056 17057 17058 17059 17060
        goto error;
    }

    if (conn->driver->domainBlockJobAbort) {
        int ret;
17061
        ret = conn->driver->domainBlockJobAbort(dom, disk, flags);
17062 17063 17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076
        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
17077
 * @disk: path to the block device, or device shorthand
17078 17079 17080 17081 17082 17083
 * @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.
 *
17084
 * The @disk parameter is either an unambiguous source name of the
17085 17086 17087 17088 17089 17090
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
 *
17091 17092
 * Returns -1 in case of failure, 0 when nothing found, 1 when info was found.
 */
17093
int virDomainGetBlockJobInfo(virDomainPtr dom, const char *disk,
17094 17095 17096 17097
                             virDomainBlockJobInfoPtr info, unsigned int flags)
{
    virConnectPtr conn;

17098
    VIR_DOMAIN_DEBUG(dom, "disk=%p, info=%p, flags=%x", disk, info, flags);
17099 17100 17101 17102 17103 17104 17105 17106 17107 17108

    virResetLastError();

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

17109
    if (!disk) {
17110
        virLibDomainError(VIR_ERR_INVALID_ARG,
17111
                          _("disk is NULL"));
17112 17113 17114 17115 17116 17117 17118 17119 17120 17121 17122
        goto error;
    }

    if (!info) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("info is NULL"));
        goto error;
    }

    if (conn->driver->domainGetBlockJobInfo) {
        int ret;
17123
        ret = conn->driver->domainGetBlockJobInfo(dom, disk, info, flags);
17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138
        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
17139
 * @disk: path to the block device, or device shorthand
17140 17141 17142 17143 17144 17145
 * @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.
 *
17146
 * The @disk parameter is either an unambiguous source name of the
17147 17148 17149 17150 17151 17152
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
 *
17153 17154
 * Returns -1 in case of failure, 0 when successful.
 */
17155
int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk,
17156 17157 17158 17159
                              unsigned long bandwidth, unsigned int flags)
{
    virConnectPtr conn;

17160 17161
    VIR_DOMAIN_DEBUG(dom, "disk=%p, bandwidth=%lu, flags=%x",
                     disk, bandwidth, flags);
17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176

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

17177
    if (!disk) {
17178
        virLibDomainError(VIR_ERR_INVALID_ARG,
17179
                          _("disk is NULL"));
17180 17181 17182 17183 17184
        goto error;
    }

    if (conn->driver->domainBlockJobSetSpeed) {
        int ret;
17185
        ret = conn->driver->domainBlockJobSetSpeed(dom, disk, bandwidth, flags);
17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200
        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
17201
 * @disk: path to the block device, or device shorthand
17202 17203 17204 17205 17206 17207 17208 17209 17210 17211
 * @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.
 *
17212
 * The @disk parameter is either an unambiguous source name of the
17213 17214 17215 17216 17217 17218
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or (since 0.9.5) the device target shorthand
 * (the <target dev='...'/> sub-element, such as "xvda").  Valid names
 * can be found by calling virDomainGetXMLDesc() and inspecting
 * elements within //domain/devices/disk.
 *
17219 17220 17221 17222 17223 17224 17225
 * 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.
 */
17226
int virDomainBlockPull(virDomainPtr dom, const char *disk,
17227 17228 17229 17230
                       unsigned long bandwidth, unsigned int flags)
{
    virConnectPtr conn;

17231 17232
    VIR_DOMAIN_DEBUG(dom, "disk=%p, bandwidth=%lu, flags=%x",
                     disk, bandwidth, flags);
17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247

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

17248
    if (!disk) {
17249
        virLibDomainError(VIR_ERR_INVALID_ARG,
17250
                          _("disk is NULL"));
17251 17252 17253 17254 17255
        goto error;
    }

    if (conn->driver->domainBlockPull) {
        int ret;
17256
        ret = conn->driver->domainBlockPull(dom, disk, bandwidth, flags);
17257 17258 17259 17260 17261 17262 17263 17264 17265 17266 17267
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(dom->conn);
    return -1;
}
17268 17269 17270 17271 17272 17273 17274 17275 17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327 17328 17329 17330 17331 17332 17333 17334 17335 17336 17337 17338 17339 17340 17341 17342 17343 17344 17345 17346 17347 17348 17349 17350 17351 17352


/**
 * 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;
}
J
Jiri Denemark 已提交
17353 17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365 17366 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396 17397 17398 17399 17400 17401 17402 17403 17404 17405 17406 17407 17408 17409 17410


/**
 * virConnectSetKeepAlive:
 * @conn: pointer to a hypervisor connection
 * @interval: number of seconds of inactivity before a keepalive message is sent
 * @count: number of messages that can be sent in a row
 *
 * Start sending keepalive messages after interval second of inactivity and
 * consider the connection to be broken when no response is received after
 * count keepalive messages sent in a row.  In other words, sending count + 1
 * keepalive message results in closing the connection.  When interval is <= 0,
 * no keepalive messages will be sent.  When count is 0, the connection will be
 * automatically closed after interval seconds of inactivity without sending
 * any keepalive messages.
 *
 * Note: client has to implement and run event loop to be able to use keepalive
 * messages.  Failure to do so may result in connections being closed
 * unexpectedly.
 *
 * Returns -1 on error, 0 on success, 1 when remote party doesn't support
 * keepalive messages.
 */
int virConnectSetKeepAlive(virConnectPtr conn,
                           int interval,
                           unsigned int count)
{
    int ret = -1;

    VIR_DEBUG("conn=%p, interval=%d, count=%u", conn, interval, count);

    virResetLastError();

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

    if (interval <= 0) {
        virLibConnError(VIR_ERR_INVALID_ARG,
                        _("negative or zero interval make no sense"));
        goto error;
    }

    if (conn->driver->setKeepAlive) {
        ret = conn->driver->setKeepAlive(conn, interval, count);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    virDispatchError(conn);
    return -1;
}
J
Jiri Denemark 已提交
17411 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422 17423 17424 17425 17426 17427 17428 17429 17430 17431 17432 17433 17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446

/**
 * virConnectIsAlive:
 * @conn: pointer to the connection object
 *
 * Determine if the connection to the hypervisor is still alive
 *
 * A connection will be classed as alive if it is either local, or running
 * over a channel (TCP or UNIX socket) which is not closed.
 *
 * Returns 1 if alive, 0 if dead, -1 on error
 */
int virConnectIsAlive(virConnectPtr conn)
{
    VIR_DEBUG("conn=%p", conn);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (conn->driver->isAlive) {
        int ret;
        ret = conn->driver->isAlive(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}
17447 17448 17449 17450 17451 17452 17453 17454 17455 17456 17457 17458 17459 17460 17461 17462 17463 17464 17465 17466 17467 17468 17469 17470 17471 17472 17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532 17533 17534 17535 17536 17537 17538 17539 17540 17541 17542 17543 17544 17545 17546 17547 17548 17549 17550 17551 17552 17553 17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601


/**
 * virDomainSetBlockIoTune:
 * @dom: pointer to domain object
 * @disk: path to the block device, or device shorthand
 * @params: Pointer to blkio parameter objects
 * @nparams: Number of blkio parameters (this value can be the same or
 *           less than the number of parameters supported)
 * @flags: An OR'ed set of virDomainModificationImpact
 *
 * Change all or a subset of the per-device block IO tunables.
 *
 * The @disk parameter is either an unambiguous source name of the
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or the device target shorthand (the <target
 * dev='...'/> sub-element, such as "xvda").  Valid names can be found
 * by calling virDomainGetXMLDesc() and inspecting elements
 * within //domain/devices/disk.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virDomainSetBlockIoTune(virDomainPtr dom,
                            const char *disk,
                            virTypedParameterPtr params,
                            int nparams,
                            unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(dom, "disk=%p, params=%p, nparams=%d, flags=%x",
                     disk, params, nparams, flags);

    virResetLastError();

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

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

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

    if (virTypedParameterValidateSet(dom, params, nparams) < 0)
        return -1;

    conn = dom->conn;

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

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainGetBlockIoTune:
 * @dom: pointer to domain object
 * @disk: path to the block device, or device shorthand
 * @params: Pointer to blkio parameter object
 *          (return value, allocated by the caller)
 * @nparams: Pointer to number of blkio parameters
 * @flags: An OR'ed set of virDomainModificationImpact
 *
 * Get all block IO tunable parameters for a given device.  On input,
 * @nparams gives the size of the @params array; on output, @nparams
 * gives how many slots were filled with parameter information, which
 * might be less but will not exceed the input value.
 *
 * As a special case, calling with @params as NULL and @nparams as 0
 * on input will cause @nparams on output to contain the number of
 * parameters supported by the hypervisor, either for the given @disk
 * (note that block devices of different types might support different
 * parameters), or if @disk is NULL, for all possible disks. The
 * caller should then allocate @params array,
 * i.e. (sizeof(@virTypedParameter) * @nparams) bytes and call the API
 * again.  See virDomainGetMemoryParameters() for more details.
 *
 * The @disk parameter is either an unambiguous source name of the
 * block device (the <source file='...'/> sub-element, such as
 * "/path/to/image"), or the device target shorthand (the <target
 * dev='...'/> sub-element, such as "xvda").  Valid names can be found
 * by calling virDomainGetXMLDesc() and inspecting elements
 * within //domain/devices/disk.  This parameter cannot be NULL
 * unless @nparams is 0 on input.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int virDomainGetBlockIoTune(virDomainPtr dom,
                            const char *disk,
                            virTypedParameterPtr params,
                            int *nparams,
                            unsigned int flags)
{
    virConnectPtr conn;

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

    virResetLastError();

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

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

    if (VIR_DRV_SUPPORTS_FEATURE(dom->conn->driver, dom->conn,
                                 VIR_DRV_FEATURE_TYPED_PARAM_STRING))
        flags |= VIR_TYPED_PARAM_STRING_OKAY;

    /* At most one of these two flags should be set.  */
    if ((flags & VIR_DOMAIN_AFFECT_LIVE) &&
        (flags & VIR_DOMAIN_AFFECT_CONFIG)) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = dom->conn;

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

    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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