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

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

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

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

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

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

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

43
#ifndef WITH_DRIVER_MODULES
44 45 46 47 48 49 50 51 52 53 54 55
# 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
56 57 58
# ifdef WITH_VMWARE
#  include "vmware/vmware_driver.h"
# endif
59 60 61 62 63 64 65 66 67
# 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
68 69 70
# ifdef WITH_XENAPI
#  include "xenapi/xenapi_driver.h"
# endif
71
#endif
72

73 74
#define VIR_FROM_THIS VIR_FROM_NONE

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

81
#define MAX_DRIVERS 20
82

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

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

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

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

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

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

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

    return 0;
}
#endif

136 137 138 139 140 141 142 143
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;
144
        size_t len;
145 146

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

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

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

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

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

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

        default:
            return -1;
199 200
        }

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

    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,
225
    VIR_CRED_EXTERNAL,
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
};

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;

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

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

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

/* 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)                 \
    VIR_DOMAIN_DEBUG_1(dom, "%s", "")

/* Internal use only, when VIR_DOMAIN_DEBUG has three or more arguments.  */
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
#define VIR_DOMAIN_DEBUG_1(dom, fmt, ...)                               \
    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;                                     \
        }                                                               \
                                                                        \
        VIR_DEBUG("dom=%p, (VM: name=%s, uuid=%s), " fmt,               \
                  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
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
372 373 374
 * Calling virInitialize is mandatory, unless your first API call is one of
 * virConnectOpen*.
 *
375 376 377 378 379 380
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
    if (initialized)
381
        return 0;
382

383
    initialized = 1;
384

385
    if (virThreadInitialize() < 0 ||
386 387
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
388 389
        return -1;

D
Daniel P. Berrange 已提交
390 391 392
    gcry_control(GCRYCTL_SET_THREAD_CBS, &virTLSThreadImpl);
    gcry_check_version(NULL);

393
    virLogSetFromEnv();
394

395
    VIR_DEBUG("register drivers");
396

397 398 399 400
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

401
    if (!bindtextdomain(PACKAGE, LOCALEDIR))
402
        return -1;
403

404
    /*
405 406
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
407
     */
408 409 410
#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 已提交
411
     * If they try to open a connection for a module that
412 413
     * is not loaded they'll get a suitable error at that point
     */
414
# ifdef WITH_TEST
415
    virDriverLoadModule("test");
416 417
# endif
# ifdef WITH_XEN
418
    virDriverLoadModule("xen");
419 420
# endif
# ifdef WITH_OPENVZ
421
    virDriverLoadModule("openvz");
422
# endif
423 424 425
# ifdef WITH_VMWARE
    virDriverLoadModule("vmware");
# endif
426
# ifdef WITH_VBOX
427
    virDriverLoadModule("vbox");
428 429
# endif
# ifdef WITH_ESX
430
    virDriverLoadModule("esx");
431 432
# endif
# ifdef WITH_XENAPI
433
    virDriverLoadModule("xenapi");
434 435
# endif
# ifdef WITH_REMOTE
436
    virDriverLoadModule("remote");
437
# endif
438
#else
439
# ifdef WITH_TEST
440
    if (testRegister() == -1) return -1;
441 442
# endif
# ifdef WITH_XEN
443
    if (xenRegister () == -1) return -1;
444 445
# endif
# ifdef WITH_OPENVZ
446
    if (openvzRegister() == -1) return -1;
447
# endif
448 449 450
# ifdef WITH_VMWARE
    if (vmwareRegister() == -1) return -1;
# endif
451
# ifdef WITH_PHYP
452
    if (phypRegister() == -1) return -1;
453 454
# endif
# ifdef WITH_VBOX
455
    if (vboxRegister() == -1) return -1;
456 457
# endif
# ifdef WITH_ESX
458
    if (esxRegister() == -1) return -1;
459
# endif
460 461 462
# ifdef WITH_XENAPI
    if (xenapiRegister() == -1) return -1;
# endif
463
# ifdef WITH_REMOTE
464
    if (remoteRegister () == -1) return -1;
465
# endif
466
#endif
D
Daniel P. Berrange 已提交
467

468
    return 0;
469 470
}

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
#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
504

505
#define virLibConnError(code, ...)                                \
506
    virReportErrorHelper(VIR_FROM_NONE, code, __FILE__,           \
507 508
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibDomainError(code, ...)                              \
509
    virReportErrorHelper(VIR_FROM_DOM, code, __FILE__,            \
510 511
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNetworkError(code, ...)                             \
512
    virReportErrorHelper(VIR_FROM_NETWORK, code, __FILE__,        \
513 514
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStoragePoolError(code, ...)                         \
515
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
516 517
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStorageVolError(code, ...)                          \
518
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
519 520
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibInterfaceError(code, ...)                           \
521
    virReportErrorHelper(VIR_FROM_INTERFACE, code, __FILE__,      \
522 523
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNodeDeviceError(code, ...)                          \
524
    virReportErrorHelper(VIR_FROM_NODEDEV, code, __FILE__,        \
525 526
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibSecretError(code, ...)                              \
527
    virReportErrorHelper(VIR_FROM_SECRET, code, __FILE__,         \
528 529
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStreamError(code, ...)                              \
530
    virReportErrorHelper(VIR_FROM_STREAMS, code, __FILE__,        \
531 532
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNWFilterError(code, ...)                            \
533
    virReportErrorHelper(VIR_FROM_NWFILTER, code, __FILE__,       \
534
                         __FUNCTION__, __LINE__, __VA_ARGS__)
535 536
#define virLibDomainSnapshotError(code, ...)                       \
    virReportErrorHelper(VIR_FROM_DOMAIN_SNAPSHOT, code, __FILE__, \
537
                         __FUNCTION__, __LINE__, __VA_ARGS__)
538

C
Chris Lalancette 已提交
539

540 541 542 543 544 545 546 547 548 549 550
/**
 * 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)
{
551 552 553 554
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
555
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
556
        return -1;
557 558 559
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
560 561 562
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
563
        return -1;
564 565
    }

566
    VIR_DEBUG ("registering %s as network driver %d",
567 568
           driver->name, virNetworkDriverTabCount);

569 570
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
571 572
}

D
Daniel Veillard 已提交
573 574
/**
 * virRegisterInterfaceDriver:
L
Laine Stump 已提交
575
 * @driver: pointer to an interface driver block
D
Daniel Veillard 已提交
576
 *
L
Laine Stump 已提交
577
 * Register an interface virtualization driver
D
Daniel Veillard 已提交
578 579 580 581 582 583 584 585 586 587
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterInterfaceDriver(virInterfaceDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
588
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
589
        return -1;
D
Daniel Veillard 已提交
590 591 592
    }

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

599
    VIR_DEBUG ("registering %s as interface driver %d",
D
Daniel Veillard 已提交
600 601 602 603 604 605
           driver->name, virInterfaceDriverTabCount);

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

606 607 608 609 610 611 612 613 614 615 616 617 618 619 620
/**
 * 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) {
621
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
622
        return -1;
623 624 625
    }

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

632
    VIR_DEBUG ("registering %s as storage driver %d",
633 634
           driver->name, virStorageDriverTabCount);

635 636 637 638
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

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

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

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

668 669 670 671
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

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

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

698
    VIR_DEBUG ("registering %s as secret driver %d",
699 700 701 702 703 704
           driver->name, virSecretDriverTabCount);

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

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

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

731
    VIR_DEBUG ("registering %s as network filter driver %d",
S
Stefan Berger 已提交
732 733 734 735 736 737 738
           driver->name, virNWFilterDriverTabCount);

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


739 740 741 742 743 744 745 746 747 748 749
/**
 * 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)
{
750
    VIR_DEBUG("driver=%p name=%s", driver, driver ? NULLSTR(driver->name) : "(null)");
751

752
    if (virInitialize() < 0)
753
        return -1;
754 755

    if (driver == NULL) {
756
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
757
        return -1;
758 759 760
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
761 762 763
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
764
        return -1;
765 766
    }

767
    if (driver->no < 0) {
768 769
        virLibConnError(VIR_ERR_INVALID_ARG,
                        _("Tried to register an internal Xen driver"));
770 771 772
        return -1;
    }

773
    VIR_DEBUG ("registering %s as driver %d",
774 775
           driver->name, virDriverTabCount);

776 777
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
778 779
}

A
Atsushi SAKAI 已提交
780
#ifdef WITH_LIBVIRTD
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
/**
 * 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) {
796
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
797
        return -1;
798 799 800
    }

    if (virStateDriverTabCount >= MAX_DRIVERS) {
801 802 803
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
804
        return -1;
805 806 807 808 809 810
    }

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

811 812
/**
 * virStateInitialize:
E
Eric Blake 已提交
813
 * @privileged: set to 1 if running with root privilege, 0 otherwise
814 815 816
 *
 * Initialize all virtualization drivers.
 *
817
 * Returns 0 if all succeed, -1 upon any failure.
818
 */
819
int virStateInitialize(int privileged) {
820 821 822 823 824 825
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
826
        if (virStateDriverTab[i]->initialize &&
827
            virStateDriverTab[i]->initialize(privileged) < 0) {
828
            VIR_ERROR(_("Initialization of %s state driver failed"),
829
                      virStateDriverTab[i]->name);
830
            ret = -1;
831
        }
832 833 834 835
    }
    return ret;
}

836 837 838 839 840
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
841
 * Returns 0 if all succeed, -1 upon any failure.
842
 */
D
Daniel P. Berrange 已提交
843
int virStateCleanup(void) {
844 845 846
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
847 848
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
849 850 851 852 853
            ret = -1;
    }
    return ret;
}

854 855 856 857 858
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
859
 * Returns 0 if all succeed, -1 upon any failure.
860
 */
D
Daniel P. Berrange 已提交
861
int virStateReload(void) {
862 863 864
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
865 866
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
867 868 869 870 871
            ret = -1;
    }
    return ret;
}

872 873 874 875 876
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
877
 * Returns 0 if none are active, 1 if at least one is.
878
 */
D
Daniel P. Berrange 已提交
879
int virStateActive(void) {
880 881 882
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
883 884
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
885 886 887 888 889
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
890
#endif
891

892 893


894 895 896
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
897 898 899 900 901 902 903 904 905
 * @type: the type of connection/driver looked at, if @typeVer is not NULL
 * @typeVer: optional return value for the version of the hypervisor (OUT)
 *
 * Provides information on up to two versions: @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. If @typeVer is not NULL it will be set to the
 * version of the hypervisor @type against which the library was compiled.
 * If @type is NULL, "Xen" is assumed, if @type is unknown or not
 * available, an error code will be returned and @typeVer will be 0.
906 907 908 909 910
 *
 * 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
911 912 913
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
914
    VIR_DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
915

916
    if (!initialized)
917
        if (virInitialize() < 0)
918
            goto error;
919

920
    if (libVer == NULL)
921
        goto error;
922 923 924
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
925
        if (type == NULL)
926
            type = "Xen";
927 928 929 930 931

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

934
# if WITH_XEN
935 936
        if (STRCASEEQ(type, "Xen"))
            *typeVer = xenUnifiedVersion();
937 938
# endif
# if WITH_TEST
939 940
        if (STRCASEEQ(type, "Test"))
            *typeVer = LIBVIR_VERSION_NUMBER;
941 942
# endif
# if WITH_QEMU
943 944
        if (STRCASEEQ(type, "QEMU"))
            *typeVer = LIBVIR_VERSION_NUMBER;
945 946
# endif
# if WITH_LXC
947 948
        if (STRCASEEQ(type, "LXC"))
            *typeVer = LIBVIR_VERSION_NUMBER;
949
# endif
J
Jim Fehlig 已提交
950 951 952 953
# if WITH_LIBXL
        if (STRCASEEQ(type, "xenlight"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
954
# if WITH_PHYP
955 956
        if (STRCASEEQ(type, "phyp"))
            *typeVer = LIBVIR_VERSION_NUMBER;
957 958
# endif
# if WITH_OPENVZ
959 960
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
961
# endif
962 963 964 965
# if WITH_VMWARE
        if (STRCASEEQ(type, "VMware"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
966
# if WITH_VBOX
967 968
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
969 970
# endif
# if WITH_UML
971 972
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
973 974
# endif
# if WITH_ONE
D
Daniel Veillard 已提交
975 976
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
977 978
# endif
# if WITH_ESX
979 980
        if (STRCASEEQ(type, "ESX"))
            *typeVer = LIBVIR_VERSION_NUMBER;
981
# endif
982 983 984 985
# if WITH_XENAPI
        if (STRCASEEQ(type, "XenAPI"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
986
# if WITH_REMOTE
987 988
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
989
# endif
990
        if (*typeVer == 0) {
991
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
992
            goto error;
993
        }
994
#endif /* WITH_DRIVER_MODULES */
995
    }
996
    return 0;
997 998 999 1000

error:
    virDispatchError(NULL);
    return -1;
1001 1002
}

1003
static virConnectPtr
1004 1005 1006
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
1007
{
1008
    int i, res;
1009 1010
    virConnectPtr ret;

1011 1012
    virResetLastError();

1013 1014 1015
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
1016

1017 1018 1019 1020 1021 1022 1023 1024
    /*
     *  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) {
1025
            VIR_DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
1026 1027
            name = defname;
        } else {
1028
            name = NULL;
1029
        }
1030
    }
1031

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
    if (name) {
        /* Convert xen -> xen:/// for back compat */
        if (STRCASEEQ(name, "xen"))
            name = "xen:///";

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

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

1050
        VIR_DEBUG("name \"%s\" to URI components:\n"
1051 1052 1053 1054 1055 1056 1057 1058
              "  scheme %s\n"
              "  opaque %s\n"
              "  authority %s\n"
              "  server %s\n"
              "  user %s\n"
              "  port %d\n"
              "  path %s\n",
              name,
1059 1060 1061 1062
              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));
1063
    } else {
1064
        VIR_DEBUG("no name, allowing driver auto-select");
1065 1066
    }

1067 1068 1069
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1070
    for (i = 0; i < virDriverTabCount; i++) {
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
        /* 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
1085
             STRCASEEQ(ret->uri->scheme, "vpx") ||
1086 1087 1088 1089 1090 1091 1092
             STRCASEEQ(ret->uri->scheme, "esx") ||
             STRCASEEQ(ret->uri->scheme, "gsx") ||
#endif
#ifndef WITH_XENAPI
             STRCASEEQ(ret->uri->scheme, "xenapi") ||
#endif
             false)) {
1093
            virReportErrorHelper(VIR_FROM_NONE, VIR_ERR_INVALID_ARG,
1094 1095 1096 1097 1098 1099
                                 __FILE__, __FUNCTION__, __LINE__,
                                 _("libvirt was built without the '%s' driver"),
                                 ret->uri->scheme);
            goto failed;
        }

1100
        VIR_DEBUG("trying driver %d (%s) ...",
1101
              i, virDriverTab[i]->name);
1102
        res = virDriverTab[i]->open (ret, auth, flags);
1103
        VIR_DEBUG("driver %d %s returned %s",
1104 1105 1106 1107
              i, virDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1108 1109 1110 1111 1112
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1113 1114
    }

1115
    if (!ret->driver) {
1116
        /* If we reach here, then all drivers declined the connection. */
1117 1118 1119
        virLibConnError(VIR_ERR_NO_CONNECT,
                        _("No connection for URI %s"),
                        NULLSTR(name));
1120
        goto failed;
1121 1122
    }

1123
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1124
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1125
        VIR_DEBUG("network driver %d %s returned %s",
1126 1127 1128 1129
              i, virNetworkDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1130 1131 1132
        if (res == VIR_DRV_OPEN_ERROR) {
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1133 1134 1135
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1136
    }
1137

D
Daniel Veillard 已提交
1138 1139
    for (i = 0; i < virInterfaceDriverTabCount; i++) {
        res = virInterfaceDriverTab[i]->open (ret, auth, flags);
1140
        VIR_DEBUG("interface driver %d %s returned %s",
D
Daniel Veillard 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
              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;
        }
    }
1152 1153 1154

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1155
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1156
        VIR_DEBUG("storage driver %d %s returned %s",
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
              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;
        }
    }

1169 1170 1171
    /* Node driver (optional) */
    for (i = 0; i < virDeviceMonitorTabCount; i++) {
        res = virDeviceMonitorTab[i]->open (ret, auth, flags);
1172
        VIR_DEBUG("node driver %d %s returned %s",
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
              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;
        }
    }

1185 1186 1187
    /* Secret manipulation driver. Optional */
    for (i = 0; i < virSecretDriverTabCount; i++) {
        res = virSecretDriverTab[i]->open (ret, auth, flags);
1188
        VIR_DEBUG("secret driver %d %s returned %s",
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
              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 已提交
1201 1202 1203
    /* Network filter driver. Optional */
    for (i = 0; i < virNWFilterDriverTabCount; i++) {
        res = virNWFilterDriverTab[i]->open (ret, auth, flags);
1204
        VIR_DEBUG("nwfilter driver %d %s returned %s",
S
Stefan Berger 已提交
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
              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;
        }
    }

1217
    return ret;
1218 1219

failed:
1220 1221
    virUnrefConnect(ret);

1222
    return NULL;
1223 1224
}

1225 1226
/**
 * virConnectOpen:
1227
 * @name: URI of the hypervisor
1228
 *
1229
 * This function should be called first to get a connection to the
1230 1231 1232
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1233
 *
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
 * 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
 *
1245
 * URIs are documented at http://libvirt.org/uri.html
1246 1247 1248 1249
 */
virConnectPtr
virConnectOpen (const char *name)
{
1250
    virConnectPtr ret = NULL;
1251 1252
    if (!initialized)
        if (virInitialize() < 0)
1253
            goto error;
1254

1255
    VIR_DEBUG("name=%s", name);
1256 1257 1258 1259 1260 1261 1262 1263
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1264 1265
}

1266
/**
1267
 * virConnectOpenReadOnly:
1268
 * @name: URI of the hypervisor
1269
 *
1270
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1271
 * library functionalities. The set of APIs usable are then restricted
1272
 * on the available methods to control the domains.
1273
 *
1274 1275 1276
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1277
 * Returns a pointer to the hypervisor connection or NULL in case of error
1278 1279
 *
 * URIs are documented at http://libvirt.org/uri.html
1280
 */
1281
virConnectPtr
1282 1283
virConnectOpenReadOnly(const char *name)
{
1284
    virConnectPtr ret = NULL;
1285 1286
    if (!initialized)
        if (virInitialize() < 0)
1287
            goto error;
1288

1289
    VIR_DEBUG("name=%s", name);
1290 1291 1292 1293 1294 1295 1296 1297
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1298 1299 1300 1301 1302 1303 1304 1305
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1306
 * This function should be called first to get a connection to the
1307
 * Hypervisor. If necessary, authentication will be performed fetching
1308 1309
 * credentials via the callback
 *
1310 1311 1312
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1313 1314 1315 1316 1317 1318 1319 1320 1321
 * Returns a pointer to the hypervisor connection or NULL in case of error
 *
 * URIs are documented at http://libvirt.org/uri.html
 */
virConnectPtr
virConnectOpenAuth(const char *name,
                   virConnectAuthPtr auth,
                   int flags)
{
1322
    virConnectPtr ret = NULL;
1323 1324
    if (!initialized)
        if (virInitialize() < 0)
1325
            goto error;
1326

1327
    VIR_DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1328 1329 1330 1331 1332 1333 1334 1335
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1336 1337 1338
}

/**
1339
 * virConnectClose:
D
Daniel Veillard 已提交
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
 * @conn: pointer to the hypervisor connection
 *
 * This function closes the connection to the Hypervisor. This should
 * not be called if further interaction with the Hypervisor are needed
 * especially if there is running domain which need further monitoring by
 * the application.
 *
 * Returns 0 in case of success or -1 in case of error.
 */
int
1350 1351
virConnectClose(virConnectPtr conn)
{
1352
    int ret = -1;
1353
    VIR_DEBUG("conn=%p", conn);
1354

1355 1356 1357
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1358
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1359
        goto error;
1360
    }
1361

1362 1363 1364 1365 1366 1367 1368 1369
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

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

1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
/**
 * 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 已提交
1386 1387
 *
 * Returns 0 in case of success, -1 in case of failure
1388 1389 1390 1391 1392
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
1393
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1394
        virDispatchError(NULL);
1395
        return -1;
1396 1397
    }
    virMutexLock(&conn->lock);
1398
    VIR_DEBUG("conn=%p refs=%d", conn, conn->refs);
1399 1400 1401 1402 1403
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1404 1405
/*
 * Not for public use.  This function is part of the internal
1406 1407 1408
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1409
virDrvSupportsFeature (virConnectPtr conn, int feature)
1410
{
1411
    int ret;
1412
    VIR_DEBUG("conn=%p, feature=%d", conn, feature);
1413

1414 1415 1416
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1417
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1418
        virDispatchError(NULL);
1419
        return -1;
1420
    }
1421

1422 1423 1424 1425
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1426 1427

    if (ret < 0)
1428
        virDispatchError(conn);
1429

1430
    return ret;
1431 1432
}

1433 1434 1435 1436 1437 1438 1439
/**
 * 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.
1440 1441 1442
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1443 1444
 */
const char *
1445 1446
virConnectGetType(virConnectPtr conn)
{
1447
    const char *ret;
1448
    VIR_DEBUG("conn=%p", conn);
1449

1450 1451
    virResetLastError();

D
Daniel Veillard 已提交
1452
    if (!VIR_IS_CONNECT(conn)) {
1453
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1454
        virDispatchError(NULL);
1455
        return NULL;
D
Daniel Veillard 已提交
1456
    }
1457 1458 1459 1460

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1461
    }
1462
    return conn->driver->name;
1463 1464
}

D
Daniel Veillard 已提交
1465
/**
1466
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1467
 * @conn: pointer to the hypervisor connection
1468
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1469
 *
1470
 * Get the version level of the Hypervisor running. This may work only with
1471
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1472
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1473
 *
1474 1475 1476
 * 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 已提交
1477
 */
1478
int
1479 1480
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1481
    VIR_DEBUG("conn=%p, hvVer=%p", conn, hvVer);
1482

1483 1484
    virResetLastError();

D
Daniel Veillard 已提交
1485
    if (!VIR_IS_CONNECT(conn)) {
1486
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1487
        virDispatchError(NULL);
1488
        return -1;
D
Daniel Veillard 已提交
1489
    }
1490

D
Daniel Veillard 已提交
1491
    if (hvVer == NULL) {
1492
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1493
        goto error;
D
Daniel Veillard 已提交
1494
    }
1495

1496 1497 1498 1499 1500 1501
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1502

1503
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1504 1505

error:
1506
    virDispatchError(conn);
1507
    return -1;
1508 1509
}

1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
/**
 * 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;
1525
    VIR_DEBUG("conn=%p, libVir=%p", conn, libVer);
1526 1527 1528 1529

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1530
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1531
        virDispatchError(NULL);
1532 1533 1534 1535
        return -1;
    }

    if (libVer == NULL) {
1536
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
        goto error;
    }

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

1547 1548 1549
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1550
error:
1551
    virDispatchError(conn);
1552 1553 1554
    return ret;
}

1555 1556 1557 1558 1559
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
1560
 * running (the result of the gethostname system call).  If
1561 1562 1563 1564 1565 1566 1567 1568 1569
 * 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)
{
1570
    VIR_DEBUG("conn=%p", conn);
1571

1572 1573
    virResetLastError();

1574
    if (!VIR_IS_CONNECT(conn)) {
1575
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1576
        virDispatchError(NULL);
1577 1578 1579
        return NULL;
    }

1580 1581 1582 1583 1584 1585
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1586

1587
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1588 1589

error:
1590
    virDispatchError(conn);
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
    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)
{
1612
    char *name;
1613
    VIR_DEBUG("conn=%p", conn);
1614

1615 1616
    virResetLastError();

1617
    if (!VIR_IS_CONNECT(conn)) {
1618
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1619
        virDispatchError(NULL);
1620 1621 1622
        return NULL;
    }

1623
    name = (char *)xmlSaveUri(conn->uri);
1624
    if (!name) {
1625
        virReportOOMError();
1626
        goto error;
1627 1628
    }
    return name;
1629 1630

error:
1631
    virDispatchError(conn);
1632
    return NULL;
1633 1634
}

E
Eric Blake 已提交
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
/**
 * 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)
{
1651
    VIR_DEBUG("conn=%p", conn);
E
Eric Blake 已提交
1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674

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

1675 1676 1677 1678 1679
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1680
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1681 1682 1683 1684 1685 1686 1687 1688 1689
 * 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)
{
1690
    VIR_DEBUG("conn=%p, type=%s", conn, type);
1691

1692 1693
    virResetLastError();

1694
    if (!VIR_IS_CONNECT(conn)) {
1695
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1696
        virDispatchError(NULL);
1697
        return -1;
1698 1699
    }

1700 1701 1702 1703 1704 1705
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1706

1707
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1708
error:
1709
    virDispatchError(conn);
1710
    return -1;
1711 1712
}

1713
/**
1714
 * virConnectListDomains:
1715 1716 1717 1718 1719 1720 1721 1722 1723
 * @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
1724 1725
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1726
    VIR_DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);
1727

1728 1729
    virResetLastError();

D
Daniel Veillard 已提交
1730
    if (!VIR_IS_CONNECT(conn)) {
1731
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1732
        virDispatchError(NULL);
1733
        return -1;
D
Daniel Veillard 已提交
1734
    }
1735

1736
    if ((ids == NULL) || (maxids < 0)) {
1737
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1738
        goto error;
D
Daniel Veillard 已提交
1739
    }
1740

1741 1742 1743 1744 1745 1746
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1747

1748
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1749
error:
1750
    virDispatchError(conn);
1751
    return -1;
D
Daniel Veillard 已提交
1752 1753
}

K
 
Karel Zak 已提交
1754 1755 1756 1757
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1758 1759
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1760 1761 1762
 * Returns the number of domain found or -1 in case of error
 */
int
1763 1764
virConnectNumOfDomains(virConnectPtr conn)
{
1765
    VIR_DEBUG("conn=%p", conn);
1766

1767 1768
    virResetLastError();

D
Daniel Veillard 已提交
1769
    if (!VIR_IS_CONNECT(conn)) {
1770
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1771
        virDispatchError(NULL);
1772
        return -1;
D
Daniel Veillard 已提交
1773
    }
K
Karel Zak 已提交
1774

1775 1776 1777 1778 1779 1780
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1781

1782
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1783
error:
1784
    virDispatchError(conn);
1785
    return -1;
K
 
Karel Zak 已提交
1786 1787
}

1788 1789 1790 1791
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1792
 * Provides the connection pointer associated with a domain.  The
1793 1794 1795
 * reference counter on the connection is not increased by this
 * call.
 *
1796 1797 1798 1799
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1800 1801 1802 1803 1804
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1805
    VIR_DOMAIN_DEBUG(dom);
1806

1807 1808 1809
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1810
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1811
        virDispatchError(NULL);
1812 1813 1814 1815 1816
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1817
/**
1818
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1819
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1820
 * @xmlDesc: string containing an XML description of the domain
1821
 * @flags: bitwise-or of supported virDomainCreateFlags
D
Daniel Veillard 已提交
1822
 *
1823
 * Launch a new guest domain, based on an XML description similar
1824
 * to the one returned by virDomainGetXMLDesc()
1825
 * This function may requires privileged access to the hypervisor.
1826 1827 1828
 * 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).
1829
 *
D
Daniel Veillard 已提交
1830 1831
 * Returns a new domain object or NULL in case of failure
 */
1832
virDomainPtr
1833 1834
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1835
{
1836
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);
1837

1838 1839
    virResetLastError();

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

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

1862
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1863
error:
1864
    virDispatchError(conn);
1865
    return NULL;
D
Daniel Veillard 已提交
1866 1867
}

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

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

1904 1905
    virResetLastError();

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

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

1924
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1925 1926

error:
1927
    virDispatchError(conn);
1928
    return NULL;
1929 1930 1931 1932 1933
}

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

1947
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
1948

1949 1950
    virResetLastError();

D
Daniel Veillard 已提交
1951
    if (!VIR_IS_CONNECT(conn)) {
1952
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1953
        virDispatchError(NULL);
1954
        return NULL;
D
Daniel Veillard 已提交
1955 1956
    }
    if (uuid == NULL) {
1957
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1958
        goto error;
D
Daniel Veillard 已提交
1959
    }
1960

1961 1962 1963 1964 1965 1966 1967
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1968

1969
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1970 1971

error:
1972
    virDispatchError(conn);
1973
    return NULL;
1974 1975
}

K
Karel Zak 已提交
1976 1977 1978 1979 1980 1981 1982
/**
 * 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.
 *
1983 1984
 * 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 已提交
1985 1986 1987 1988
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1989
    unsigned char uuid[VIR_UUID_BUFLEN];
1990
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
1991

1992 1993
    virResetLastError();

K
Karel Zak 已提交
1994
    if (!VIR_IS_CONNECT(conn)) {
1995
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1996
        virDispatchError(NULL);
1997
        return NULL;
K
Karel Zak 已提交
1998 1999
    }
    if (uuidstr == NULL) {
2000
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2001
        goto error;
K
Karel Zak 已提交
2002
    }
2003 2004

    if (virUUIDParse(uuidstr, uuid) < 0) {
2005
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2006
        goto error;
K
Karel Zak 已提交
2007
    }
2008

K
Karel Zak 已提交
2009
    return virDomainLookupByUUID(conn, &uuid[0]);
2010 2011

error:
2012
    virDispatchError(conn);
2013
    return NULL;
K
Karel Zak 已提交
2014 2015
}

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

2031 2032
    virResetLastError();

D
Daniel Veillard 已提交
2033
    if (!VIR_IS_CONNECT(conn)) {
2034
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2035
        virDispatchError(NULL);
2036
        return NULL;
D
Daniel Veillard 已提交
2037 2038
    }
    if (name == NULL) {
2039
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2040
        goto error;
D
Daniel Veillard 已提交
2041
    }
2042

2043 2044 2045 2046 2047 2048 2049
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2050

2051
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2052 2053

error:
2054
    virDispatchError(conn);
2055
    return NULL;
2056 2057
}

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

2074
    VIR_DOMAIN_DEBUG(domain);
2075

2076 2077
    virResetLastError();

D
Daniel Veillard 已提交
2078
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2079
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2080
        virDispatchError(NULL);
2081
        return -1;
D
Daniel Veillard 已提交
2082
    }
2083

2084
    conn = domain->conn;
2085
    if (conn->flags & VIR_CONNECT_RO) {
2086
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2087
        goto error;
2088
    }
2089

2090 2091 2092 2093 2094 2095 2096
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2097

2098
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2099 2100

error:
2101
    virDispatchError(conn);
2102
    return -1;
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
}

/**
 * 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
2115 2116
virDomainFree(virDomainPtr domain)
{
2117
    VIR_DOMAIN_DEBUG(domain);
2118

2119 2120 2121
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2122
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2123
        virDispatchError(NULL);
2124
        return -1;
D
Daniel Veillard 已提交
2125
    }
2126 2127
    if (virUnrefDomain(domain) < 0) {
        virDispatchError(NULL);
2128
        return -1;
2129
    }
2130
    return 0;
D
Daniel Veillard 已提交
2131 2132
}

2133 2134
/**
 * virDomainRef:
D
Daniel Veillard 已提交
2135
 * @domain: the domain to hold a reference on
2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
 *
 * 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 已提交
2147 2148
 *
 * Returns 0 in case of success and -1 in case of failure.
2149 2150 2151 2152 2153
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
2154
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2155
        virDispatchError(NULL);
2156
        return -1;
2157 2158
    }
    virMutexLock(&domain->conn->lock);
2159
    VIR_DOMAIN_DEBUG(domain, "refs=%d", domain->refs);
2160 2161 2162 2163 2164 2165
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
2166
/**
2167
 * virDomainSuspend:
D
Daniel Veillard 已提交
2168 2169 2170
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
2171
 * to CPU resources and I/O but the memory used by the domain at the
2172
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
2173
 * the domain.
2174
 * This function may requires privileged access.
D
Daniel Veillard 已提交
2175 2176 2177 2178
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2179 2180
virDomainSuspend(virDomainPtr domain)
{
2181
    virConnectPtr conn;
2182

2183
    VIR_DOMAIN_DEBUG(domain);
2184

2185 2186
    virResetLastError();

D
Daniel Veillard 已提交
2187
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2188
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2189
        virDispatchError(NULL);
2190
        return -1;
D
Daniel Veillard 已提交
2191
    }
2192
    if (domain->conn->flags & VIR_CONNECT_RO) {
2193
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2194
        goto error;
2195
    }
D
Daniel Veillard 已提交
2196

2197 2198
    conn = domain->conn;

2199 2200 2201 2202 2203 2204 2205
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2206

2207
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2208 2209

error:
2210
    virDispatchError(domain->conn);
2211
    return -1;
D
Daniel Veillard 已提交
2212 2213 2214
}

/**
2215
 * virDomainResume:
D
Daniel Veillard 已提交
2216 2217
 * @domain: a domain object
 *
D
Dan Kenigsberg 已提交
2218
 * Resume a suspended domain, the process is restarted from the state where
2219
 * it was frozen by calling virSuspendDomain().
2220
 * This function may requires privileged access
D
Daniel Veillard 已提交
2221 2222 2223 2224
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2225 2226
virDomainResume(virDomainPtr domain)
{
2227
    virConnectPtr conn;
2228

2229
    VIR_DOMAIN_DEBUG(domain);
2230

2231 2232
    virResetLastError();

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

2243 2244
    conn = domain->conn;

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

2253
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2254 2255

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

2260 2261 2262 2263 2264 2265
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2266 2267 2268
 * a file on disk. After the call, if successful, the domain is not
 * listed as running anymore (this may be a problem).
 * Use virDomainRestore() to restore a domain after saving.
2269 2270 2271 2272
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2273 2274
virDomainSave(virDomainPtr domain, const char *to)
{
2275
    virConnectPtr conn;
2276 2277

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

2279 2280
    virResetLastError();

D
Daniel Veillard 已提交
2281
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2282
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2283
        virDispatchError(NULL);
2284
        return -1;
D
Daniel Veillard 已提交
2285
    }
2286
    if (domain->conn->flags & VIR_CONNECT_RO) {
2287
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2288
        goto error;
2289
    }
2290
    conn = domain->conn;
D
Daniel Veillard 已提交
2291
    if (to == NULL) {
2292
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2293
        goto error;
D
Daniel Veillard 已提交
2294
    }
2295

2296 2297 2298
    if (conn->driver->domainSave) {
        int ret;
        char *absolute_to;
2299

2300 2301 2302 2303 2304 2305
        /* 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;
        }
2306

2307 2308 2309
        ret = conn->driver->domainSave(domain, absolute_to);

        VIR_FREE(absolute_to);
2310

2311 2312 2313 2314
        if (ret < 0)
            goto error;
        return ret;
    }
2315

2316
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2317 2318

error:
2319
    virDispatchError(domain->conn);
2320
    return -1;
2321 2322 2323 2324
}

/**
 * virDomainRestore:
2325
 * @conn: pointer to the hypervisor connection
2326
 * @from: path to the input file
2327 2328 2329 2330 2331 2332
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2333 2334
virDomainRestore(virConnectPtr conn, const char *from)
{
2335
    VIR_DEBUG("conn=%p, from=%s", conn, from);
2336

2337 2338
    virResetLastError();

D
Daniel Veillard 已提交
2339
    if (!VIR_IS_CONNECT(conn)) {
2340
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2341
        virDispatchError(NULL);
2342
        return -1;
D
Daniel Veillard 已提交
2343
    }
2344
    if (conn->flags & VIR_CONNECT_RO) {
2345
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2346
        goto error;
2347
    }
D
Daniel Veillard 已提交
2348
    if (from == NULL) {
2349
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2350
        goto error;
D
Daniel Veillard 已提交
2351 2352
    }

2353 2354 2355
    if (conn->driver->domainRestore) {
        int ret;
        char *absolute_from;
2356

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

2364 2365 2366 2367
        ret = conn->driver->domainRestore(conn, absolute_from);

        VIR_FREE(absolute_from);

2368 2369 2370 2371
        if (ret < 0)
            goto error;
        return ret;
    }
2372

2373
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2374 2375

error:
2376
    virDispatchError(conn);
2377
    return -1;
D
Daniel Veillard 已提交
2378 2379 2380 2381 2382 2383
}

/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
2384
 * @flags: an OR'ed set of virDomainCoreDumpFlags
D
Daniel Veillard 已提交
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395
 *
 * This method will dump the core of a domain on a given file for analysis.
 * Note that for remote Xen Daemon the file path will be interpreted in
 * the remote host.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainCoreDump(virDomainPtr domain, const char *to, int flags)
{
    virConnectPtr conn;
2396 2397

    VIR_DOMAIN_DEBUG(domain, "to=%s, flags=%d", to, flags);
D
Daniel Veillard 已提交
2398

2399 2400
    virResetLastError();

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

2416 2417 2418 2419 2420 2421
    if ((flags & VIR_DUMP_CRASH) && (flags & VIR_DUMP_LIVE)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("crash and live flags are mutually exclusive"));
        goto error;
    }

2422 2423 2424
    if (conn->driver->domainCoreDump) {
        int ret;
        char *absolute_to;
D
Daniel Veillard 已提交
2425

2426 2427 2428 2429
        /* 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"));
2430 2431
            goto error;
        }
D
Daniel Veillard 已提交
2432

2433 2434 2435
        ret = conn->driver->domainCoreDump(domain, absolute_to, flags);

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

2437 2438 2439 2440
        if (ret < 0)
            goto error;
        return ret;
    }
2441

2442
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2443 2444

error:
2445
    virDispatchError(domain->conn);
2446
    return -1;
2447 2448
}

2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513
/**
 * 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
 * the first head on the second card.
 *
 * 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)
{
    VIR_DOMAIN_DEBUG(domain, "stream=%p flags=%u", stream, flags);

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

2514 2515 2516 2517 2518
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2519 2520
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2521 2522 2523 2524 2525 2526 2527
 *
 * TODO: should we add an option for reboot, knowing it may not be doable
 *       in the general case ?
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2528 2529
virDomainShutdown(virDomainPtr domain)
{
2530
    virConnectPtr conn;
2531

2532
    VIR_DOMAIN_DEBUG(domain);
2533

2534 2535
    virResetLastError();

D
Daniel Veillard 已提交
2536
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2537
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2538
        virDispatchError(NULL);
2539
        return -1;
D
Daniel Veillard 已提交
2540
    }
2541
    if (domain->conn->flags & VIR_CONNECT_RO) {
2542
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2543
        goto error;
2544
    }
2545

2546 2547
    conn = domain->conn;

2548 2549 2550 2551 2552 2553 2554
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2555

2556
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2557 2558

error:
2559
    virDispatchError(domain->conn);
2560
    return -1;
2561 2562
}

2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576
/**
 * 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)
{
2577
    virConnectPtr conn;
2578 2579

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
2580

2581 2582
    virResetLastError();

2583
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2584
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2585
        virDispatchError(NULL);
2586
        return -1;
2587
    }
2588
    if (domain->conn->flags & VIR_CONNECT_RO) {
2589
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2590
        goto error;
2591
    }
2592

2593 2594
    conn = domain->conn;

2595 2596 2597 2598 2599 2600 2601
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2602

2603
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2604 2605

error:
2606
    virDispatchError(domain->conn);
2607
    return -1;
2608 2609
}

2610
/**
2611
 * virDomainGetName:
2612 2613 2614 2615 2616 2617 2618 2619
 * @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 *
2620 2621
virDomainGetName(virDomainPtr domain)
{
2622
    VIR_DEBUG("domain=%p", domain);
2623

2624 2625
    virResetLastError();

D
Daniel Veillard 已提交
2626
    if (!VIR_IS_DOMAIN(domain)) {
2627
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2628
        virDispatchError(NULL);
2629
        return NULL;
D
Daniel Veillard 已提交
2630
    }
2631
    return domain->name;
2632 2633
}

2634 2635 2636
/**
 * virDomainGetUUID:
 * @domain: a domain object
2637
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2638 2639 2640 2641 2642 2643
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2644 2645
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2646
    VIR_DOMAIN_DEBUG(domain, "uuid=%p", uuid);
2647

2648 2649
    virResetLastError();

D
Daniel Veillard 已提交
2650
    if (!VIR_IS_DOMAIN(domain)) {
2651
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2652
        virDispatchError(NULL);
2653
        return -1;
D
Daniel Veillard 已提交
2654 2655
    }
    if (uuid == NULL) {
2656
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2657
        virDispatchError(domain->conn);
2658
        return -1;
D
Daniel Veillard 已提交
2659 2660
    }

2661 2662
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2663
    return 0;
2664 2665
}

K
Karel Zak 已提交
2666 2667 2668
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2669
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2670
 *
2671
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2672 2673 2674 2675 2676 2677 2678
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2679
    unsigned char uuid[VIR_UUID_BUFLEN];
2680 2681

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

2683 2684
    virResetLastError();

K
Karel Zak 已提交
2685
    if (!VIR_IS_DOMAIN(domain)) {
2686
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2687
        virDispatchError(NULL);
2688
        return -1;
K
Karel Zak 已提交
2689 2690
    }
    if (buf == NULL) {
2691
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2692
        goto error;
K
Karel Zak 已提交
2693
    }
2694

K
Karel Zak 已提交
2695
    if (virDomainGetUUID(domain, &uuid[0]))
2696
        goto error;
K
Karel Zak 已提交
2697

2698
    virUUIDFormat(uuid, buf);
2699
    return 0;
2700 2701

error:
2702
    virDispatchError(domain->conn);
2703
    return -1;
K
Karel Zak 已提交
2704 2705
}

2706
/**
2707
 * virDomainGetID:
2708 2709 2710 2711 2712 2713 2714
 * @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
2715 2716
virDomainGetID(virDomainPtr domain)
{
2717
    VIR_DOMAIN_DEBUG(domain);
2718

2719 2720
    virResetLastError();

D
Daniel Veillard 已提交
2721
    if (!VIR_IS_DOMAIN(domain)) {
2722
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2723
        virDispatchError(NULL);
2724
        return (unsigned int)-1;
D
Daniel Veillard 已提交
2725
    }
2726
    return domain->id;
2727 2728
}

2729 2730 2731 2732 2733 2734
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2735 2736
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2737 2738
 */
char *
2739 2740
virDomainGetOSType(virDomainPtr domain)
{
2741
    virConnectPtr conn;
2742

2743
    VIR_DOMAIN_DEBUG(domain);
2744

2745 2746 2747
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2748
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2749
        virDispatchError(NULL);
2750
        return NULL;
D
Daniel Veillard 已提交
2751
    }
2752

2753 2754
    conn = domain->conn;

2755 2756 2757 2758 2759 2760 2761
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2762

2763
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2764 2765

error:
2766
    virDispatchError(domain->conn);
2767
    return NULL;
2768 2769
}

2770
/**
2771
 * virDomainGetMaxMemory:
2772
 * @domain: a domain object or NULL
2773
 *
2774 2775 2776 2777 2778 2779 2780
 * 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
2781 2782
virDomainGetMaxMemory(virDomainPtr domain)
{
2783
    virConnectPtr conn;
2784

2785
    VIR_DOMAIN_DEBUG(domain);
2786

2787 2788
    virResetLastError();

D
Daniel Veillard 已提交
2789
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2790
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2791
        virDispatchError(NULL);
2792
        return 0;
D
Daniel Veillard 已提交
2793
    }
2794

2795 2796
    conn = domain->conn;

2797 2798 2799 2800 2801 2802 2803
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2804

2805
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2806 2807

error:
2808
    virDispatchError(domain->conn);
2809
    return 0;
2810 2811
}

D
Daniel Veillard 已提交
2812
/**
2813
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2814 2815
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2816
 *
D
Daniel Veillard 已提交
2817 2818 2819
 * 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.
2820
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2821
 *
2822 2823 2824
 * This command is hypervisor-specific for whether active, persistent,
 * or both configurations are changed; for more control, use
 * virDomainSetMemoryFlags().
2825
 *
D
Daniel Veillard 已提交
2826 2827 2828
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2829 2830
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2831
    virConnectPtr conn;
2832 2833

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

2835 2836
    virResetLastError();

2837
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2838
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2839
        virDispatchError(NULL);
2840
        return -1;
2841
    }
2842
    if (domain->conn->flags & VIR_CONNECT_RO) {
2843
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2844
        goto error;
2845
    }
2846
    if (!memory) {
2847
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2848
        goto error;
2849
    }
2850
    conn = domain->conn;
2851

2852 2853 2854 2855 2856 2857 2858
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2859

2860
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2861 2862

error:
2863
    virDispatchError(domain->conn);
2864
    return -1;
2865
}
2866

2867 2868 2869 2870
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2871
 *
2872 2873 2874
 * 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.
2875
 * This function may requires privileged access to the hypervisor.
2876
 *
2877 2878 2879
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
2880 2881 2882 2883 2884 2885
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2886 2887

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

2889 2890
    virResetLastError();

2891
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2892
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2893
        virDispatchError(NULL);
2894
        return -1;
2895
    }
2896
    if (domain->conn->flags & VIR_CONNECT_RO) {
2897
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2898
        goto error;
2899
    }
2900
    if (!memory) {
2901
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2902
        goto error;
2903 2904 2905
    }

    conn = domain->conn;
2906

2907 2908 2909 2910 2911 2912 2913
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2914

2915
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2916 2917

error:
2918
    virDispatchError(domain->conn);
2919
    return -1;
D
Daniel Veillard 已提交
2920 2921
}

2922
/*
2923
 * virDomainSetMemoryFlags:
2924 2925 2926 2927 2928 2929 2930
 * @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.
2931
 * This function may requires privileged access to the hypervisor.
2932
 *
2933 2934 2935 2936 2937 2938 2939 2940
 * @flags may include VIR_DOMAIN_MEM_LIVE or VIR_DOMAIN_MEM_CONFIG.
 * Both flags may be set. If VIR_DOMAIN_MEM_LIVE is set, the change affects
 * a running domain and will fail if domain is not active.
 * If VIR_DOMAIN_MEM_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_MEM_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.
2941 2942
 * If VIR_DOMAIN_MEM_MAXIMUM is set, the change affects domain's maximum memory
 * size rather than current memory size.
2943
 * Not all hypervisors can support all flag combinations.
2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

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

    VIR_DOMAIN_DEBUG(domain, "memory=%lu flags=%u", memory, 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;
    }

2969
    if (!memory) {
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983
        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;
    }

2984 2985
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

2991 2992 2993 2994
/**
 * virDomainSetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter objects
2995
 * @nparams: number of memory parameter (this value can be the same or
2996 2997 2998
 *          less than the number of parameters supported)
 * @flags: currently unused, for future extension
 *
2999
 * Change all or a subset of the memory tunables.
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009
 * This function requires privileged access to the hypervisor.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetMemoryParameters(virDomainPtr domain,
                             virMemoryParameterPtr params,
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;
3010 3011 3012

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%u",
                     params, nparams, flags);
3013 3014 3015 3016

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3017
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3018 3019 3020 3021
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
3022
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3023 3024 3025
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
3026
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038
        goto error;
    }
    conn = domain->conn;

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

3039
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053

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

/**
 * virDomainGetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter object
 *          (return value, allocated by the caller)
 * @nparams: pointer to number of memory parameters
 * @flags: currently unused, for future extension
 *
3054
 * Get all memory parameters, the @params array will be filled with the values
3055 3056
 * equal to the number of parameters suggested by @nparams
 *
3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073
 * As the value of @nparams is dynamic, call the API setting @nparams to 0 and
 * @params as NULL, the API returns the number of parameters supported by the
 * HV by updating @nparams on SUCCESS. The caller should then allocate @params
 * array, i.e. (sizeof(@virMemoryParameter) * @nparams) bytes and call the API
 * again.
 *
 * Here is the sample code snippet:
 *
 * if ((virDomainGetMemoryParameters(dom, NULL, &nparams, 0) == 0) &&
 *     (nparams != 0)) {
 *     params = vshMalloc(ctl, sizeof(virMemoryParameter) * nparams);
 *     memset(params, 0, sizeof(virMemoryParameter) * nparams);
 *     if (virDomainGetMemoryParameters(dom, params, &nparams, 0)) {
 *         vshError(ctl, "%s", _("Unable to get memory parameters"));
 *         goto error;
 *     }
 * }
3074 3075
 *
 * This function requires privileged access to the hypervisor. This function
3076
 * expects the caller to allocate the @params.
3077 3078 3079 3080 3081 3082 3083 3084 3085
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
                             virMemoryParameterPtr params,
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
3086 3087 3088

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%u",
                     params, (nparams) ? *nparams : -1, flags);
3089 3090 3091 3092

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3093
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3094 3095 3096
        virDispatchError(NULL);
        return -1;
    }
3097 3098
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3099
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainGetMemoryParameters) {
        int ret;
        ret = conn->driver->domainGetMemoryParameters (domain, params, nparams, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
3111
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3112 3113 3114 3115 3116 3117

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

3118 3119 3120 3121
/**
 * virDomainSetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter objects
3122
 * @nparams: number of blkio parameters (this value can be the same or
3123 3124 3125
 *          less than the number of parameters supported)
 * @flags: currently unused, for future extension
 *
3126
 * Change all or a subset of the blkio tunables.
3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180
 * This function requires privileged access to the hypervisor.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetBlkioParameters(virDomainPtr domain,
                             virBlkioParameterPtr params,
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;

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

    virResetLastError();

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainGetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter object
 *          (return value, allocated by the caller)
 * @nparams: pointer to number of blkio parameters
 * @flags: currently unused, for future extension
 *
3181 3182 3183
 * Get all blkio parameters, the @params array will be filled with the values
 * equal to the number of parameters suggested by @nparams.
 * See virDomainGetMemoryParameters for an equivalent usage example.
3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206
 *
 * This function requires privileged access to the hypervisor. This function
 * expects the caller to allocate the @params.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetBlkioParameters(virDomainPtr domain,
                             virBlkioParameterPtr params,
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%u",
                     params, (nparams) ? *nparams : -1, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
3207 3208
    if ((nparams == NULL) || (*nparams < 0) ||
        (params == NULL && *nparams != 0)) {
3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

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

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

3228 3229
/**
 * virDomainGetInfo:
3230
 * @domain: a domain object
3231
 * @info: pointer to a virDomainInfo structure allocated by the user
3232
 *
3233
 * Extract information about a domain. Note that if the connection
3234
 * used to get the domain is limited only a partial set of the information
3235 3236 3237 3238 3239
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3240 3241
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3242
    virConnectPtr conn;
3243 3244

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

3246 3247
    virResetLastError();

D
Daniel Veillard 已提交
3248
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3249
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3250
        virDispatchError(NULL);
3251
        return -1;
D
Daniel Veillard 已提交
3252 3253
    }
    if (info == NULL) {
3254
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3255
        goto error;
D
Daniel Veillard 已提交
3256
    }
3257

3258
    memset(info, 0, sizeof(virDomainInfo));
3259

3260 3261
    conn = domain->conn;

3262 3263 3264 3265 3266 3267 3268
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3269

3270
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3271 3272

error:
3273
    virDispatchError(domain->conn);
3274
    return -1;
3275
}
3276

3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327
/**
 * 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;

    VIR_DOMAIN_DEBUG(domain, "state=%p, reason=%p", state, reason);

    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)
            goto error;
        return ret;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

3328 3329 3330
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3331
 * @flags: an OR'ed set of virDomainXMLFlags
3332 3333
 *
 * Provide an XML description of the domain. The description may be reused
3334
 * later to relaunch the domain with virDomainCreateXML().
3335 3336 3337 3338 3339
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3340 3341
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
3342
    virConnectPtr conn;
3343 3344

    VIR_DOMAIN_DEBUG(domain, "flags=%d", flags);
3345

3346 3347 3348
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3349
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3350
        virDispatchError(NULL);
3351
        return NULL;
D
Daniel Veillard 已提交
3352
    }
3353

3354 3355
    conn = domain->conn;

3356
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
3357
        virLibConnError(VIR_ERR_OPERATION_DENIED,
3358 3359 3360 3361
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

3362 3363
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

3364
    if (conn->driver->domainGetXMLDesc) {
3365
        char *ret;
3366
        ret = conn->driver->domainGetXMLDesc(domain, flags);
3367 3368 3369 3370
        if (!ret)
            goto error;
        return ret;
    }
3371

3372
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3373 3374

error:
3375
    virDispatchError(domain->conn);
3376
    return NULL;
3377
}
3378

3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397
/**
 * 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)
{
3398
    VIR_DEBUG("conn=%p, format=%s config=%s flags=%u", conn, nativeFormat, nativeConfig, flags);
3399 3400 3401 3402

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3403
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3404
        virDispatchError(NULL);
3405
        return NULL;
3406 3407 3408
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
3409
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3410
        goto error;
3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423
    }

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

3424
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3425 3426

error:
3427
    virDispatchError(conn);
3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438
    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 已提交
3439
 * a native configuration file describing the domain.
3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
 * 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)
{
3450
    VIR_DEBUG("conn=%p, format=%s xml=%s flags=%u", conn, nativeFormat, domainXml, flags);
3451 3452 3453 3454

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3455
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3456
        virDispatchError(NULL);
3457
        return NULL;
3458
    }
3459 3460 3461 3462
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
3463 3464

    if (nativeFormat == NULL || domainXml == NULL) {
3465
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3466
        goto error;
3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479
    }

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

3480
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3481 3482

error:
3483
    virDispatchError(conn);
3484 3485 3486 3487
    return NULL;
}


3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503
/*
 * 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
 *
 */
3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514
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;
3515 3516 3517 3518 3519 3520 3521
    int cookielen = 0, ret;
    virDomainInfo info;

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539

    /* 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) {
3540
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571
                         _("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;
}

3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590
/*
 * 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
 *
 */
3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603
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;
3604
    virDomainInfo info;
3605
    virErrorPtr orig_err = NULL;
3606
    int cancelled;
3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623

    /* 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.
     */
3624
    if (!domain->conn->driver->domainGetXMLDesc) {
3625
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
3626
        virDispatchError(domain->conn);
3627 3628
        return NULL;
    }
3629 3630 3631
    dom_xml = domain->conn->driver->domainGetXMLDesc(domain,
                                                     VIR_DOMAIN_XML_SECURE |
                                                     VIR_DOMAIN_XML_UPDATE_CPU);
3632 3633 3634
    if (!dom_xml)
        return NULL;

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

3640
    VIR_DEBUG("Prepare2 %p", dconn);
3641 3642 3643 3644 3645 3646 3647 3648
    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) {
3649
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
3650
                         _("domainMigratePrepare2 did not set uri"));
3651
        virDispatchError(domain->conn);
3652 3653
        cancelled = 1;
        goto finish;
3654 3655 3656 3657 3658 3659 3660
    }
    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.
     */
3661
    VIR_DEBUG("Perform %p", domain->conn);
3662 3663 3664
    ret = domain->conn->driver->domainMigratePerform
        (domain, cookie, cookielen, uri, flags, dname, bandwidth);

3665 3666 3667 3668
    /* Perform failed. Make sure Finish doesn't overwrite the error */
    if (ret < 0)
        orig_err = virSaveLastError();

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

finish:
3675 3676 3677 3678 3679
    /* 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;
3680
    VIR_DEBUG("Finish2 %p ret=%d", dconn, ret);
3681
    ddomain = dconn->driver->domainMigrateFinish2
3682
        (dconn, dname, cookie, cookielen, uri, flags, cancelled);
3683 3684

 done:
3685 3686 3687 3688
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
3689 3690 3691 3692 3693
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

3694

3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776
/*
 * 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,
                         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;
    int cancelled;

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

    VIR_DEBUG("Begin3 %p", domain->conn);
    dom_xml = domain->conn->driver->domainMigrateBegin3
        (domain, &cookieout, &cookieoutlen, flags, dname,
         bandwidth);
    if (!dom_xml)
        goto done;

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

    VIR_DEBUG("Prepare3 %p", dconn);
    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);
    if (ret == -1)
        goto done;

    if (uri == NULL && uri_out == NULL) {
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("domainMigratePrepare3 did not set uri"));
        virDispatchError(domain->conn);
3777 3778
        cancelled = 1;
        goto finish;
3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806
    }
    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;
    ret = domain->conn->driver->domainMigratePerform3
        (domain, cookiein, cookieinlen, &cookieout, &cookieoutlen,
         uri, flags, dname, bandwidth);

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

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

3807
finish:
3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863
    /*
     * 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;
    ret = dconn->driver->domainMigrateFinish3
        (dconn, dname, cookiein, cookieinlen, &cookieout, &cookieoutlen,
         uri, flags, cancelled, &ddomain);

    /* If ret is 0 then 'ddomain' indicates whether the VM is
     * running on the dest. If not running, we can restart
     * the source.  If ret is -1, we can't be sure what happened
     * to the VM on the dest, thus the only safe option is to
     * kill the VM on the source, even though that may leave
     * no VM at all on either host.
     */
    cancelled = ret == 0 && ddomain == NULL ? 1 : 0;

    /*
     * If cancelled, then src VM will be restarted, else
     * it will be killed
     */
    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, 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.
     */

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


3864
 /*
3865 3866
  * In normal migration, the libvirt client co-ordinates communcation
  * between the 2 libvirtd instances on source & dest hosts.
3867
  *
3868 3869 3870 3871
  * 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.
3872 3873 3874 3875 3876 3877 3878 3879
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
                           unsigned long flags,
                           const char *dname,
                           const char *uri,
                           unsigned long bandwidth)
{
3880 3881
    xmlURIPtr tempuri = NULL;

3882
    if (!domain->conn->driver->domainMigratePerform) {
3883
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3884
        virDispatchError(domain->conn);
3885 3886 3887
        return -1;
    }

3888 3889
    tempuri = xmlParseURI(uri);
    if (!tempuri) {
3890
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3891 3892 3893 3894 3895
        virDispatchError(domain->conn);
        return -1;
    }

    if (!tempuri->server || STRPREFIX(tempuri->server, "localhost")) {
3896
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3897 3898 3899 3900 3901 3902
        virDispatchError(domain->conn);
        xmlFreeURI(tempuri);
        return -1;
    }
    xmlFreeURI(tempuri);

3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
}


C
Chris Lalancette 已提交
3916
/*
3917 3918
 * In normal migration, the libvirt client co-ordinates communcation
 * between the 2 libvirtd instances on source & dest hosts.
C
Chris Lalancette 已提交
3919
 *
3920 3921 3922
 * Some hypervisors support an alternative, direct migration where
 * there is no requirement for a libvirtd instance on the dest host.
 * In this case
3923
 *
3924 3925
 * 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 已提交
3926
 */
3927 3928 3929 3930 3931 3932 3933 3934
static int
virDomainMigrateDirect (virDomainPtr domain,
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
3935
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3936
        virDispatchError(domain->conn);
3937 3938 3939
        return -1;
    }

C
Chris Lalancette 已提交
3940 3941 3942
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
3943 3944 3945 3946 3947 3948 3949
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
C
Chris Lalancette 已提交
3950 3951
}

3952

3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965
/**
 * 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:
3966 3967 3968
 *   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 已提交
3969 3970 3971 3972
 *   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.
3973
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
3974 3975 3976 3977 3978
 *
 * 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.
3979 3980 3981 3982 3983 3984
 *
 * 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.
 *
3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995
 * 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.
 *
3996
 * In either case it is typically only necessary to specify a
3997 3998
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026
 *
 * 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;
4027 4028 4029

    VIR_DOMAIN_DEBUG(domain, "dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
                     dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
4030

4031 4032
    virResetLastError();

4033
    /* First checkout the source */
4034
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4035
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4036
        virDispatchError(NULL);
4037 4038
        return NULL;
    }
4039
    if (domain->conn->flags & VIR_CONNECT_RO) {
4040
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4041
        goto error;
4042 4043
    }

4044 4045
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
4046
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4047 4048 4049 4050
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
4051
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4052 4053 4054
        goto error;
    }

4055 4056 4057 4058 4059 4060
    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);
4061
                if (!dstURI)
4062 4063
                    return NULL;
            }
4064

4065
            VIR_DEBUG("Using peer2peer migration");
4066 4067 4068 4069 4070
            if (virDomainMigratePeer2Peer(domain, flags, dname, uri ? uri : dstURI, bandwidth) < 0) {
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
4071

4072 4073 4074
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
4075
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4076 4077
            goto error;
        }
4078
    } else {
4079
        if (flags & VIR_MIGRATE_TUNNELLED) {
4080
            virLibConnError(VIR_ERR_OPERATION_INVALID,
4081 4082 4083 4084
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
4085 4086
        /* Check that migration is supported by both drivers. */
        if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
4087
                                     VIR_DRV_FEATURE_MIGRATION_V3) &&
C
Chris Lalancette 已提交
4088
            VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
4089 4090 4091 4092 4093 4094 4095 4096
                                     VIR_DRV_FEATURE_MIGRATION_V3)) {
            VIR_DEBUG("Using migration protocol 3");
            ddomain = virDomainMigrateVersion3(domain, dconn, flags, dname, uri, bandwidth);
        } else if (VIR_DRV_SUPPORTS_FEATURE(domain->conn->driver, domain->conn,
                                            VIR_DRV_FEATURE_MIGRATION_V2) &&
                   VIR_DRV_SUPPORTS_FEATURE(dconn->driver, dconn,
                                          VIR_DRV_FEATURE_MIGRATION_V2)) {
            VIR_DEBUG("Using migration protocol 2");
C
Chris Lalancette 已提交
4097
            ddomain = virDomainMigrateVersion2(domain, dconn, flags, dname, uri, bandwidth);
4098 4099 4100 4101 4102 4103 4104
        } 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");
            ddomain = virDomainMigrateVersion1(domain, dconn, flags, dname, uri, bandwidth);
        } else {
4105
            /* This driver does not support any migration method */
4106
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
4107 4108
            goto error;
        }
4109 4110
    }

4111 4112
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
4113

4114
    return ddomain;
4115 4116

error:
4117
    virDispatchError(domain->conn);
4118
    return NULL;
4119 4120
}

4121 4122 4123 4124 4125 4126 4127 4128 4129 4130

/**
 * 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 已提交
4131
 * host given by duri.
4132 4133 4134 4135 4136
 *
 * 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
4137 4138 4139 4140
 *   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.
4141
 *
4142 4143 4144 4145 4146 4147 4148 4149 4150 4151
 * 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
4152
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
4153
 * libvirt driver can connect to the destination libvirt.
4154
 *
4155 4156 4157 4158 4159 4160 4161
 * 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.
4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185
 *
 * 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)
{
4186 4187
    VIR_DOMAIN_DEBUG(domain, "duri=%p, flags=%lu, dname=%s, bandwidth=%lu",
                     NULLSTR(duri), flags, NULLSTR(dname), bandwidth);
4188 4189 4190 4191 4192

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4193
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4194
        virDispatchError(NULL);
4195 4196 4197
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
4198
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4199 4200 4201 4202
        goto error;
    }

    if (duri == NULL) {
4203
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
        goto error;
    }

    if (flags & VIR_MIGRATE_PEER2PEER) {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_P2P)) {
            if (virDomainMigratePeer2Peer (domain, flags, dname, duri, bandwidth) < 0)
                goto error;
        } else {
            /* No peer to peer migration supported */
4214
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4215 4216 4217 4218 4219 4220 4221 4222 4223
            goto error;
        }
    } else {
        if (VIR_DRV_SUPPORTS_FEATURE (domain->conn->driver, domain->conn,
                                      VIR_DRV_FEATURE_MIGRATION_DIRECT)) {
            if (virDomainMigrateDirect (domain, flags, dname, duri, bandwidth) < 0)
                goto error;
        } else {
            /* Cannot do a migration with only the perform step */
4224
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4225 4226 4227 4228 4229 4230 4231
            goto error;
        }
    }

    return 0;

error:
4232
    virDispatchError(domain->conn);
4233 4234 4235 4236
    return -1;
}


D
Daniel Veillard 已提交
4237 4238
/*
 * Not for public use.  This function is part of the internal
4239 4240 4241
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
4242
virDomainMigratePrepare (virConnectPtr dconn,
4243 4244 4245 4246 4247 4248 4249
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
4250
{
J
John Levon 已提交
4251 4252 4253
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, "
              "flags=%lu, dname=%s, bandwidth=%lu", dconn, cookie, cookielen,
              NULLSTR(uri_in), uri_out, flags, NULLSTR(dname), bandwidth);
4254

4255 4256
    virResetLastError();

4257
    if (!VIR_IS_CONNECT (dconn)) {
4258
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4259
        virDispatchError(NULL);
4260 4261 4262
        return -1;
    }

4263
    if (dconn->flags & VIR_CONNECT_RO) {
4264
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4265
        goto error;
4266 4267
    }

4268 4269 4270 4271 4272 4273 4274 4275 4276
    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;
    }
4277

4278
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4279 4280

error:
4281
    virDispatchError(dconn);
4282 4283 4284
    return -1;
}

D
Daniel Veillard 已提交
4285 4286
/*
 * Not for public use.  This function is part of the internal
4287 4288 4289
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
4290
virDomainMigratePerform (virDomainPtr domain,
4291 4292 4293 4294 4295 4296 4297 4298
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
4299 4300 4301 4302

    VIR_DOMAIN_DEBUG(domain, "cookie=%p, cookielen=%d, uri=%s, flags=%lu, "
                     "dname=%s, bandwidth=%lu", cookie, cookielen, uri, flags,
                     NULLSTR(dname), bandwidth);
4303

4304 4305 4306
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
4307
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4308
        virDispatchError(NULL);
4309 4310 4311 4312
        return -1;
    }
    conn = domain->conn;

4313
    if (domain->conn->flags & VIR_CONNECT_RO) {
4314
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4315
        goto error;
4316 4317
    }

4318 4319 4320 4321 4322 4323 4324 4325 4326
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
4327

4328
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4329 4330

error:
4331
    virDispatchError(domain->conn);
4332 4333 4334
    return -1;
}

D
Daniel Veillard 已提交
4335 4336
/*
 * Not for public use.  This function is part of the internal
4337 4338 4339
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
4340
virDomainMigrateFinish (virConnectPtr dconn,
4341 4342 4343 4344 4345 4346
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
4347 4348 4349
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
4350

4351 4352
    virResetLastError();

4353
    if (!VIR_IS_CONNECT (dconn)) {
4354
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4355
        virDispatchError(NULL);
4356 4357 4358
        return NULL;
    }

4359
    if (dconn->flags & VIR_CONNECT_RO) {
4360
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4361
        goto error;
4362 4363
    }

4364 4365 4366 4367 4368 4369 4370 4371 4372
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
4373

4374
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4375 4376

error:
4377
    virDispatchError(dconn);
4378
    return NULL;
D
Daniel Veillard 已提交
4379 4380 4381
}


D
Daniel Veillard 已提交
4382 4383
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
4384 4385 4386
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
4387 4388 4389 4390 4391 4392 4393 4394 4395
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 已提交
4396
{
J
John Levon 已提交
4397 4398 4399 4400
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p,"
              "flags=%lu, dname=%s, bandwidth=%lu, dom_xml=%s", dconn,
              cookie, cookielen, uri_in, uri_out, flags, NULLSTR(dname),
              bandwidth, dom_xml);
D
Daniel Veillard 已提交
4401

4402 4403
    virResetLastError();

D
Daniel Veillard 已提交
4404
    if (!VIR_IS_CONNECT (dconn)) {
4405
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4406
        virDispatchError(NULL);
D
Daniel Veillard 已提交
4407 4408 4409
        return -1;
    }

4410
    if (dconn->flags & VIR_CONNECT_RO) {
4411
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4412
        goto error;
4413 4414
    }

4415 4416 4417 4418 4419 4420 4421 4422 4423 4424
    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 已提交
4425

4426
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4427 4428

error:
4429
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4430 4431 4432
    return -1;
}

D
Daniel Veillard 已提交
4433 4434
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
4435 4436 4437
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
4438 4439 4440 4441 4442 4443 4444
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
4445
{
J
John Levon 已提交
4446 4447 4448
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu, retcode=%d", dconn, NULLSTR(dname), cookie,
              cookielen, uri, flags, retcode);
D
Daniel Veillard 已提交
4449

4450 4451
    virResetLastError();

D
Daniel Veillard 已提交
4452
    if (!VIR_IS_CONNECT (dconn)) {
4453
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4454
        virDispatchError(NULL);
D
Daniel Veillard 已提交
4455 4456 4457
        return NULL;
    }

4458
    if (dconn->flags & VIR_CONNECT_RO) {
4459
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4460
        goto error;
4461 4462
    }

4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
    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 已提交
4473

4474
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4475 4476

error:
4477
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4478
    return NULL;
4479 4480 4481
}


C
Chris Lalancette 已提交
4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494
/*
 * 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)

{
4495 4496
    VIR_DEBUG("conn=%p, stream=%p, flags=%lu, dname=%s, "
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
4497 4498 4499 4500 4501
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4502
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4503
        virDispatchError(NULL);
C
Chris Lalancette 已提交
4504 4505 4506 4507
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
4508
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
4509 4510 4511 4512
        goto error;
    }

    if (conn != st->conn) {
4513
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
4514 4515 4516 4517
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
4518
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
4519 4520 4521 4522 4523 4524 4525
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

4526
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
4527 4528

error:
4529
    virDispatchError(conn);
C
Chris Lalancette 已提交
4530 4531 4532
    return -1;
}

4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856
/*
 * Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
char *
virDomainMigrateBegin3(virDomainPtr domain,
                       char **cookieout,
                       int *cookieoutlen,
                       unsigned long flags,
                       const char *dname,
                       unsigned long bandwidth)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "cookieout=%p, cookieoutlen=%p, "
                     "flags=%lu, dname=%s, bandwidth=%lu",
                     cookieout, cookieoutlen, flags,
                     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;
        xml = conn->driver->domainMigrateBegin3(domain,
                                                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)
{
    VIR_DEBUG("dconn=%p, cookiein=%p, cookieinlen=%d, cookieout=%p, cookieoutlen=%p,"
              "uri_in=%s, uri_out=%p, flags=%lu, dname=%s, bandwidth=%lu, dom_xml=%s",
              dconn, cookiein, cookieinlen, cookieout, cookieoutlen, uri_in, uri_out,
              flags, NULLSTR(dname), bandwidth, dom_xml);

    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)

{
    VIR_DEBUG("conn=%p, stream=%p, cookiein=%p, cookieinlen=%d, cookieout=%p,"
              " cookieoutlen=%p, flags=%lu, dname=%s, bandwidth=%lu, dom_xml=%s",
              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,
                         const char *cookiein,
                         int cookieinlen,
                         char **cookieout,
                         int *cookieoutlen,
                         const char *uri,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "cookiein=%p, cookieinlen=%d, cookieout=%p, cookieoutlen=%p,"
                     "uri=%s, flags=%lu, dname=%s, bandwidth=%lu",
                     cookiein, cookieinlen, cookieout, cookieoutlen,
                     uri, flags, NULLSTR(dname), bandwidth);

    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;
        ret = conn->driver->domainMigratePerform3(domain,
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
                                                  uri,
                                                  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.
 */
int
virDomainMigrateFinish3(virConnectPtr dconn,
                        const char *dname,
                        const char *cookiein,
                        int cookieinlen,
                        char **cookieout,
                        int *cookieoutlen,
                        const char *uri,
                        unsigned long flags,
                        int cancelled,
                        virDomainPtr *newdom)
{
    VIR_DEBUG("dconn=%p, dname=%s, cookiein=%p, cookieinlen=%d, cookieout=%p,"
              "cookieoutlen=%p, uri=%s, flags=%lu, retcode=%d newdom=%p",
              dconn, NULLSTR(dname), cookiein, cookieinlen, cookieout,
              cookieoutlen, uri, flags, cancelled, newdom);

    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->domainMigrateFinish3) {
        int ret;
        ret = dconn->driver->domainMigrateFinish3(dconn, dname,
                                                  cookiein, cookieinlen,
                                                  cookieout, cookieoutlen,
                                                  uri, flags,
                                                  cancelled,
                                                  newdom);
        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
virDomainMigrateConfirm3(virDomainPtr domain,
                         const char *cookiein,
                         int cookieinlen,
                         unsigned long flags,
                         int cancelled)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "cookiein=%p, cookieinlen=%d, flags=%lu, cancelled=%d",
                     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 已提交
4857

4858 4859 4860 4861
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
4862
 *
4863 4864 4865 4866 4867
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
4868 4869
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
4870
    VIR_DEBUG("conn=%p, info=%p", conn, info);
4871

4872 4873
    virResetLastError();

4874
    if (!VIR_IS_CONNECT(conn)) {
4875
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4876
        virDispatchError(NULL);
4877
        return -1;
4878 4879
    }
    if (info == NULL) {
4880
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4881
        goto error;
4882 4883
    }

4884 4885 4886 4887 4888 4889 4890
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
4891

4892
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4893 4894

error:
4895
    virDispatchError(conn);
4896
    return -1;
4897
}
4898

4899 4900 4901 4902 4903 4904
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
4905 4906
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
4907 4908 4909 4910 4911
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
4912
    VIR_DEBUG("conn=%p", conn);
4913

4914 4915
    virResetLastError();

4916
    if (!VIR_IS_CONNECT (conn)) {
4917
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4918
        virDispatchError(NULL);
4919 4920 4921
        return NULL;
    }

4922 4923 4924 4925 4926
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
4927
        VIR_DEBUG("conn=%p ret=%s", conn, ret);
4928 4929
        return ret;
    }
4930

4931
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4932 4933

error:
4934
    virDispatchError(conn);
4935 4936 4937
    return NULL;
}

4938 4939 4940
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
4941
 *
D
Daniel Veillard 已提交
4942
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
4943 4944
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
4945
 *
D
Daniel Veillard 已提交
4946
 * Returns the available free memory in bytes or 0 in case of error
4947 4948 4949 4950
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
4951
    VIR_DEBUG("conn=%p", conn);
4952

4953 4954
    virResetLastError();

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

4961
    if (conn->driver->nodeGetFreeMemory) {
4962
        unsigned long long ret;
4963
        ret = conn->driver->nodeGetFreeMemory (conn);
4964 4965 4966 4967
        if (ret == 0)
            goto error;
        return ret;
    }
4968

4969
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4970 4971

error:
4972
    virDispatchError(conn);
4973 4974 4975
    return 0;
}

4976 4977 4978
/**
 * virDomainGetSchedulerType:
 * @domain: pointer to domain object
4979 4980
 * @nparams: pointer to number of scheduler parameters, can be NULL
 *           (return value)
4981
 *
4982
 * Get the scheduler type and the number of scheduler parameters.
4983 4984 4985 4986 4987 4988 4989 4990
 *
 * Returns NULL in case of error. The caller must free the returned string.
 */
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
{
    virConnectPtr conn;
    char *schedtype;
4991 4992

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

4994 4995
    virResetLastError();

4996
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4997
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4998
        virDispatchError(NULL);
4999 5000 5001 5002 5003 5004
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
5005 5006
        if (!schedtype)
            goto error;
5007 5008 5009
        return schedtype;
    }

5010
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5011 5012

error:
5013
    virDispatchError(domain->conn);
5014 5015 5016 5017 5018 5019 5020
    return NULL;
}


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
5021
 * @params: pointer to scheduler parameter objects
5022
 *          (return value)
5023 5024
 * @nparams: pointer to number of scheduler parameter objects
 *          (this value must be at least as large as the returned value
5025 5026
 *           nparams of virDomainGetSchedulerType)
 *
5027 5028 5029
 * Get all scheduler parameters, the @params array will be filled with the
 * values and @nparams will be updated to the number of valid elements in
 * @params.
5030 5031 5032 5033 5034
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
5035
                                virSchedParameterPtr params, int *nparams)
5036 5037
{
    virConnectPtr conn;
5038 5039

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

5041 5042
    virResetLastError();

5043
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5044
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5045
        virDispatchError(NULL);
5046 5047
        return -1;
    }
5048 5049 5050 5051 5052 5053

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

5054 5055
    conn = domain->conn;

5056 5057 5058 5059 5060 5061 5062
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
5063

5064
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5065 5066

error:
5067
    virDispatchError(domain->conn);
5068 5069 5070 5071 5072 5073 5074
    return -1;
}

/**
 * virDomainSetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
5075 5076
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
5077 5078
 *           nparams of virDomainGetSchedulerType)
 *
5079
 * Change all or a subset or the scheduler parameters.
5080 5081 5082 5083
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
5084
virDomainSetSchedulerParameters(virDomainPtr domain,
5085
                                virSchedParameterPtr params, int nparams)
5086 5087
{
    virConnectPtr conn;
5088 5089

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

5091 5092
    virResetLastError();

5093
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5094
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5095
        virDispatchError(NULL);
5096 5097
        return -1;
    }
5098 5099 5100 5101 5102 5103

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

5104
    if (domain->conn->flags & VIR_CONNECT_RO) {
5105
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5106
        goto error;
5107
    }
5108 5109
    conn = domain->conn;

5110 5111 5112 5113 5114 5115 5116
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
5117

5118
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129

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


/**
 * virDomainSetSchedulerParametersFlags:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
5130 5131
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
5132 5133 5134
 *           nparams of virDomainGetSchedulerType)
 * @flags: virDomainSchedParameterFlags
 *
5135
 * Change a subset or all scheduler parameters.
5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetSchedulerParametersFlags(virDomainPtr domain,
                                     virSchedParameterPtr params,
                                     int nparams,
                                     unsigned int flags)
{
    virConnectPtr conn;

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

    virResetLastError();

    if (!(flags & (VIR_DOMAIN_SCHEDPARAM_LIVE |
                   VIR_DOMAIN_SCHEDPARAM_CONFIG |
                   VIR_DOMAIN_SCHEDPARAM_CURRENT))) {
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
5165 5166 5167 5168 5169 5170

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

5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
    conn = domain->conn;

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5189 5190

error:
5191
    virDispatchError(domain->conn);
5192 5193 5194 5195
    return -1;
}


5196
/**
5197
 * virDomainBlockStats:
5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224
 * @dom: pointer to the domain object
 * @path: path to the block device
 * @stats: block device stats (returned)
 * @size: size of stats structure
 *
 * This function returns block device (disk) stats for block
 * devices attached to the domain.
 *
 * The path parameter is the name of the block device.  Get this
 * by calling virDomainGetXMLDesc and finding the <target dev='...'>
 * attribute within //domain/devices/disk.  (For example, "xvda").
 *
 * Domains may have more than one block device.  To get stats for
 * each you should make multiple calls to this function.
 *
 * Individual fields within the stats structure may be returned
 * as -1, which indicates that the hypervisor does not support
 * that particular statistic.
 *
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainBlockStats (virDomainPtr dom, const char *path,
                     virDomainBlockStatsPtr stats, size_t size)
{
    virConnectPtr conn;
    struct _virDomainBlockStats stats2 = { -1, -1, -1, -1, -1 };
5225 5226

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

5228 5229
    virResetLastError();

5230
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
5231
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5232
        virDispatchError(NULL);
5233 5234
        return -1;
    }
5235
    if (!path || !stats || size > sizeof stats2) {
5236
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5237 5238
        goto error;
    }
5239 5240 5241 5242
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
5243
            goto error;
5244 5245 5246 5247 5248

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

5249
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5250 5251

error:
5252
    virDispatchError(dom->conn);
5253 5254 5255 5256
    return -1;
}

/**
5257
 * virDomainInterfaceStats:
5258 5259 5260 5261 5262 5263 5264 5265 5266 5267
 * @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 已提交
5268
 * Domains may have more than one network interface.  To get stats for
5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283
 * 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 };
5284 5285 5286

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

5288 5289
    virResetLastError();

5290
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
5291
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5292
        virDispatchError(NULL);
5293 5294
        return -1;
    }
5295
    if (!path || !stats || size > sizeof stats2) {
5296
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5297 5298
        goto error;
    }
5299 5300 5301 5302
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
5303
            goto error;
5304 5305 5306 5307 5308

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

5309
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5310 5311

error:
5312
    virDispatchError(dom->conn);
5313 5314 5315
    return -1;
}

5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350
/**
 * virDomainMemoryStats:
 * @dom: pointer to the domain object
 * @stats: nr_stats-sized array of stat structures (returned)
 * @nr_stats: number of memory statistics requested
 * @flags: unused, always pass 0
 *
 * This function provides memory statistics for the domain.
 *
 * Up to 'nr_stats' elements of 'stats' will be populated with memory statistics
 * from the domain.  Only statistics supported by the domain, the driver, and
 * this version of libvirt will be returned.
 *
 * Memory Statistics:
 *
 * VIR_DOMAIN_MEMORY_STAT_SWAP_IN:
 *     The total amount of data read from swap space (in kb).
 * VIR_DOMAIN_MEMORY_STAT_SWAP_OUT:
 *     The total amount of memory written out to swap space (in kb).
 * VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT:
 *     The number of page faults that required disk IO to service.
 * VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT:
 *     The number of page faults serviced without disk IO.
 * VIR_DOMAIN_MEMORY_STAT_UNUSED:
 *     The amount of memory which is not being used for any purpose (in kb).
 * VIR_DOMAIN_MEMORY_STAT_AVAILABLE:
 *     The total amount of memory available to the domain's OS (in kb).
 *
 * Returns: The number of stats provided or -1 in case of failure.
 */
int virDomainMemoryStats (virDomainPtr dom, virDomainMemoryStatPtr stats,
                          unsigned int nr_stats, unsigned int flags)
{
    virConnectPtr conn;
    unsigned long nr_stats_ret = 0;
5351 5352

    VIR_DOMAIN_DEBUG(dom, "stats=%p, nr_stats=%u", stats, nr_stats);
5353 5354 5355 5356

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
5357
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5358
        virDispatchError(NULL);
5359 5360
        return -1;
    }
5361 5362 5363 5364 5365 5366
    if (flags != 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
        goto error;
    }

5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380
    if (!stats || nr_stats == 0)
        return 0;

    if (nr_stats > VIR_DOMAIN_MEMORY_STAT_NR)
        nr_stats = VIR_DOMAIN_MEMORY_STAT_NR;

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

5381
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5382 5383

error:
5384
    virDispatchError(dom->conn);
5385 5386 5387
    return -1;
}

R
Richard W.M. Jones 已提交
5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420
/**
 * virDomainBlockPeek:
 * @dom: pointer to the domain object
 * @path: path to the block device
 * @offset: offset within block device
 * @size: size to read
 * @buffer: return buffer (must be at least size bytes)
 * @flags: unused, always pass 0
 *
 * This function allows you to read the contents of a domain's
 * disk device.
 *
 * Typical uses for this are to determine if the domain has
 * written a Master Boot Record (indicating that the domain
 * has completed installation), or to try to work out the state
 * of the domain's filesystems.
 *
 * (Note that in the local case you might try to open the
 * block device or file directly, but that won't work in the
 * remote case, nor if you don't have sufficient permission.
 * Hence the need for this call).
 *
 * 'path' must be a device or file corresponding to the domain.
 * In other words it must be the precise string returned in
 * a <disk><source dev='...'/></disk> from
 * virDomainGetXMLDesc.
 *
 * 'offset' and 'size' represent an area which must lie entirely
 * within the device or file.  'size' may be 0 to test if the
 * call would succeed.
 *
 * 'buffer' is the return buffer and must be at least 'size' bytes.
 *
R
Richard W.M. Jones 已提交
5421 5422 5423 5424
 * 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 已提交
5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435
 * Returns: 0 in case of success or -1 in case of failure.
 */
int
virDomainBlockPeek (virDomainPtr dom,
                    const char *path,
                    unsigned long long offset /* really 64 bits */,
                    size_t size,
                    void *buffer,
                    unsigned int flags)
{
    virConnectPtr conn;
5436 5437 5438

    VIR_DOMAIN_DEBUG(dom, "path=%s, offset=%lld, size=%zi, buffer=%p",
                     path, offset, size, buffer);
R
Richard W.M. Jones 已提交
5439

5440 5441
    virResetLastError();

R
Richard W.M. Jones 已提交
5442
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
5443
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5444
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
5445 5446 5447
        return -1;
    }
    conn = dom->conn;
5448

5449
    if (dom->conn->flags & VIR_CONNECT_RO) {
5450
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5451
        goto error;
5452 5453
    }

R
Richard W.M. Jones 已提交
5454
    if (!path) {
5455
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
5456
                           _("path is NULL"));
5457
        goto error;
R
Richard W.M. Jones 已提交
5458 5459 5460
    }

    if (flags != 0) {
5461
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
5462
                           _("flags must be zero"));
5463
        goto error;
R
Richard W.M. Jones 已提交
5464 5465 5466 5467
    }

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

5473 5474 5475 5476 5477 5478 5479 5480
    if (conn->driver->domainBlockPeek) {
        int ret;
        ret =conn->driver->domainBlockPeek (dom, path, offset, size,
                                            buffer, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
R
Richard W.M. Jones 已提交
5481

5482
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5483 5484

error:
5485
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
5486 5487
    return -1;
}
5488

R
Richard W.M. Jones 已提交
5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527
/**
 * 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;
5528 5529 5530

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

5532 5533
    virResetLastError();

R
Richard W.M. Jones 已提交
5534
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
5535
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5536
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
5537 5538 5539 5540
        return -1;
    }
    conn = dom->conn;

5541
    if (dom->conn->flags & VIR_CONNECT_RO) {
5542
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5543
        goto error;
5544 5545
    }

5546
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
5547 5548 5549 5550 5551 5552
     * 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.
     *
5553
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
5554 5555 5556
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
5557 5558 5559
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
5560 5561 5562 5563 5564 5565 5566 5567
     * 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.
     */
5568 5569

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
5570
        virLibDomainError(VIR_ERR_INVALID_ARG,
5571
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
5572
        goto error;
R
Richard W.M. Jones 已提交
5573 5574 5575 5576
    }

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

5582 5583 5584 5585 5586 5587 5588 5589
    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 已提交
5590

5591
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5592 5593

error:
5594
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
5595 5596 5597
    return -1;
}

5598

5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613
/**
 * virDomainGetBlockInfo:
 * @domain: a domain object
 * @path: path to the block device or file
 * @info: pointer to a virDomainBlockInfo structure allocated by the user
 * @flags: currently unused, pass zero
 *
 * Extract information about a domain's block device.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainGetBlockInfo(virDomainPtr domain, const char *path, virDomainBlockInfoPtr info, unsigned int flags)
{
    virConnectPtr conn;
5614 5615

    VIR_DOMAIN_DEBUG(domain, "info=%p flags=%u", info, flags);
5616 5617 5618 5619

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5620
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5621
        virDispatchError(NULL);
5622
        return -1;
5623 5624
    }
    if (info == NULL) {
5625
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640
        goto error;
    }

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

    conn = domain->conn;

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

5641
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5642 5643 5644 5645 5646 5647 5648

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


5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659
/************************************************************************
 *									*
 *		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
 *
5660 5661
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
5662 5663
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
5664 5665 5666 5667 5668
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
5669
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
5670

5671 5672
    virResetLastError();

5673
    if (!VIR_IS_CONNECT(conn)) {
5674
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5675
        virDispatchError(NULL);
5676
        return NULL;
5677
    }
5678
    if (conn->flags & VIR_CONNECT_RO) {
5679
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5680
        goto error;
5681
    }
5682
    if (xml == NULL) {
5683
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5684
        goto error;
5685 5686
    }

5687 5688 5689 5690 5691 5692 5693
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
5694

5695
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5696 5697

error:
5698
    virDispatchError(conn);
5699
    return NULL;
5700 5701 5702 5703 5704 5705
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
5706
 * Undefine a domain but does not stop it if it is running
5707 5708 5709 5710 5711
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
5712
    virConnectPtr conn;
5713

5714
    VIR_DOMAIN_DEBUG(domain);
5715

5716 5717
    virResetLastError();

5718
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5719
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5720
        virDispatchError(NULL);
5721
        return -1;
5722
    }
5723 5724
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5725
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5726
        goto error;
5727 5728
    }

5729 5730 5731 5732 5733 5734 5735
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5736

5737
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5738 5739

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

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
5748
 * Provides the number of defined but inactive domains.
5749 5750 5751 5752 5753 5754
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
5755
    VIR_DEBUG("conn=%p", conn);
5756

5757 5758
    virResetLastError();

5759
    if (!VIR_IS_CONNECT(conn)) {
5760
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5761
        virDispatchError(NULL);
5762
        return -1;
5763 5764
    }

5765 5766 5767 5768 5769 5770 5771
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5772

5773
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5774 5775

error:
5776
    virDispatchError(conn);
5777
    return -1;
5778 5779 5780 5781 5782 5783 5784 5785
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
5786 5787
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
5788
 *
5789 5790 5791
 * Returns the number of names provided in the array or -1 in case of error
 */
int
5792
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
5793
                             int maxnames) {
5794
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
5795

5796 5797
    virResetLastError();

5798
    if (!VIR_IS_CONNECT(conn)) {
5799
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5800
        virDispatchError(NULL);
5801
        return -1;
5802 5803
    }

5804
    if ((names == NULL) || (maxnames < 0)) {
5805
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5806
        goto error;
5807 5808
    }

5809 5810 5811 5812 5813 5814 5815
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5816

5817
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5818 5819

error:
5820
    virDispatchError(conn);
5821
    return -1;
5822 5823 5824 5825 5826 5827
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
5828
 * Launch a defined domain. If the call succeeds the domain moves from the
5829 5830 5831 5832 5833 5834
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
5835
    virConnectPtr conn;
5836

5837
    VIR_DOMAIN_DEBUG(domain);
5838

5839 5840
    virResetLastError();

5841
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5842
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5843
        virDispatchError(NULL);
5844
        return -1;
5845
    }
5846 5847
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5848
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5849
        goto error;
5850
    }
5851

5852 5853 5854 5855 5856 5857 5858
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5859

5860
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5861 5862

error:
5863
    virDispatchError(domain->conn);
5864
    return -1;
5865 5866
}

5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879
/**
 * virDomainCreateWithFlags:
 * @domain: pointer to a defined domain
 * @flags: bitwise-or of supported virDomainCreateFlags
 *
 * Launch a defined domain. If the call succeeds the domain moves from the
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreateWithFlags(virDomainPtr domain, unsigned int flags) {
    virConnectPtr conn;
5880 5881

    VIR_DOMAIN_DEBUG(domain, "flags=%d", flags);
5882 5883 5884 5885

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5886
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5887
        virDispatchError(NULL);
5888
        return -1;
5889 5890 5891
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5892
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903
        goto error;
    }

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

5904
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5905 5906 5907 5908 5909 5910

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

5911 5912 5913
/**
 * virDomainGetAutostart:
 * @domain: a domain object
5914
 * @autostart: the value returned
5915
 *
5916
 * Provides a boolean value indicating whether the domain
5917 5918 5919 5920 5921 5922 5923
 * 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,
5924 5925 5926
                      int *autostart)
{
    virConnectPtr conn;
5927 5928

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

5930 5931 5932
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5933
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5934
        virDispatchError(NULL);
5935
        return -1;
5936 5937
    }
    if (!autostart) {
5938
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5939
        goto error;
5940 5941
    }

5942 5943
    conn = domain->conn;

5944 5945 5946 5947 5948 5949 5950
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5951

5952
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5953 5954

error:
5955
    virDispatchError(domain->conn);
5956
    return -1;
5957 5958 5959 5960 5961
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
5962
 * @autostart: whether the domain should be automatically started 0 or 1
5963 5964 5965 5966 5967 5968 5969 5970
 *
 * 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,
5971 5972 5973
                      int autostart)
{
    virConnectPtr conn;
5974 5975

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

5977 5978 5979
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5980
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5981
        virDispatchError(NULL);
5982
        return -1;
5983 5984
    }

5985 5986
    conn = domain->conn;

5987
    if (domain->conn->flags & VIR_CONNECT_RO) {
5988
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5989
        goto error;
5990 5991
    }

5992 5993 5994 5995 5996 5997 5998
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5999

6000
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6001 6002

error:
6003
    virDispatchError(domain->conn);
6004
    return -1;
6005 6006
}

6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050
/**
 * 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;
    VIR_DOMAIN_DEBUG(domain, "flags=%u", 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->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;
}

6051 6052 6053 6054 6055 6056 6057 6058
/**
 * 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.
6059
 * This function requires privileged access to the hypervisor.
6060
 *
6061
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
6062 6063 6064
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
6065
 *
6066 6067 6068 6069 6070 6071
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
6072
    virConnectPtr conn;
6073 6074

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

6076 6077
    virResetLastError();

6078
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6079
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6080
        virDispatchError(NULL);
6081
        return -1;
6082
    }
6083
    if (domain->conn->flags & VIR_CONNECT_RO) {
6084
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6085
        goto error;
6086
    }
6087

6088
    if (nvcpus < 1) {
6089
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6090
        goto error;
6091
    }
6092
    conn = domain->conn;
6093

6094 6095 6096 6097 6098 6099 6100
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
6101

6102
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6103 6104

error:
6105
    virDispatchError(domain->conn);
6106
    return -1;
6107 6108
}

E
Eric Blake 已提交
6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139
/**
 * virDomainSetVcpusFlags:
 * @domain: pointer to domain object, or NULL for Domain0
 * @nvcpus: the new number of virtual CPUs for this domain, must be at least 1
 * @flags: an OR'ed set of virDomainVcpuFlags
 *
 * Dynamically change the number of virtual CPUs used by the domain.
 * Note that this call may fail if the underlying virtualization hypervisor
 * does not support it or if growing the number is arbitrary limited.
 * This function requires privileged access to the hypervisor.
 *
 * @flags must include VIR_DOMAIN_VCPU_LIVE to affect a running
 * domain (which may fail if domain is not active), or
 * VIR_DOMAIN_VCPU_CONFIG to affect the next boot via the XML
 * description of the domain.  Both flags may be set.
 *
 * If @flags includes VIR_DOMAIN_VCPU_MAXIMUM, then
 * VIR_DOMAIN_VCPU_LIVE must be clear, and only the maximum virtual
 * CPU limit is altered; generally, this value must be less than or
 * equal to virConnectGetMaxVcpus().  Otherwise, this call affects the
 * current virtual CPU limit, which must be less than or equal to the
 * maximum limit.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

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

    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u, flags=%u", nvcpus, flags);
E
Eric Blake 已提交
6142 6143 6144 6145

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6146
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
6147
        virDispatchError(NULL);
6148
        return -1;
E
Eric Blake 已提交
6149 6150
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6151
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
6152 6153 6154 6155 6156 6157
        goto error;
    }

    /* Perform some argument validation common to all implementations.  */
    if (nvcpus < 1 || (unsigned short) nvcpus != nvcpus ||
        (flags & (VIR_DOMAIN_VCPU_LIVE | VIR_DOMAIN_VCPU_CONFIG)) == 0) {
6158
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170
        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;
    }

6171
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203

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

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

int
virDomainGetVcpusFlags(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
6204 6205

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
E
Eric Blake 已提交
6206 6207 6208 6209

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6210
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
6211
        virDispatchError(NULL);
6212
        return -1;
E
Eric Blake 已提交
6213 6214 6215 6216
    }

    /* Exactly one of these two flags should be set.  */
    if (!(flags & VIR_DOMAIN_VCPU_LIVE) == !(flags & VIR_DOMAIN_VCPU_CONFIG)) {
6217
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229
        goto error;
    }
    conn = domain->conn;

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

6230
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
6231 6232 6233 6234 6235 6236

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

6237 6238 6239 6240 6241
/**
 * 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 已提交
6242 6243 6244
 *      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.
6245 6246 6247 6248
 * @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.
6249
 *
6250
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
6251
 * This function requires privileged access to the hypervisor.
6252
 *
6253 6254 6255
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
6256 6257 6258 6259 6260 6261
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
6262
    virConnectPtr conn;
6263 6264 6265

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

6267 6268
    virResetLastError();

6269
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6270
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6271
        virDispatchError(NULL);
6272
        return -1;
6273
    }
6274
    if (domain->conn->flags & VIR_CONNECT_RO) {
6275
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6276
        goto error;
6277
    }
6278

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

6284 6285
    conn = domain->conn;

6286 6287 6288 6289 6290 6291 6292
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
6293

6294
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6295 6296

error:
6297
    virDispatchError(domain->conn);
6298
    return -1;
6299 6300 6301 6302 6303 6304 6305
}

/**
 * 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 已提交
6306
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
6307
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
6308
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
6309 6310 6311 6312 6313 6314 6315
 *	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...).
6316
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
6317
 *
6318
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
6319
 * and also in cpumaps if this pointer isn't NULL.
6320 6321 6322 6323 6324
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
6325
                  unsigned char *cpumaps, int maplen)
6326
{
6327
    virConnectPtr conn;
6328 6329 6330

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

6332 6333
    virResetLastError();

6334
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6335
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6336
        virDispatchError(NULL);
6337
        return -1;
6338 6339
    }
    if ((info == NULL) || (maxinfo < 1)) {
6340
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6341
        goto error;
6342
    }
6343 6344 6345 6346 6347

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

6352 6353
    conn = domain->conn;

6354 6355 6356 6357 6358 6359 6360 6361
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
6362

6363
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6364 6365

error:
6366
    virDispatchError(domain->conn);
6367
    return -1;
6368
}
6369

6370 6371 6372
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
6373
 *
6374 6375
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
6376
 * the same as virConnectGetMaxVcpus(). If the guest is running
6377
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
6378
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
6379 6380 6381 6382
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
6383 6384
virDomainGetMaxVcpus(virDomainPtr domain)
{
6385
    virConnectPtr conn;
6386

6387
    VIR_DOMAIN_DEBUG(domain);
6388

6389 6390
    virResetLastError();

6391
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6392
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6393
        virDispatchError(NULL);
6394
        return -1;
6395 6396 6397 6398
    }

    conn = domain->conn;

6399 6400 6401 6402 6403 6404 6405
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
6406

6407
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6408 6409

error:
6410
    virDispatchError(domain->conn);
6411
    return -1;
6412 6413
}

6414 6415 6416 6417 6418
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
6419 6420 6421
 * 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.
6422
 *
6423
 * Returns 0 in case of success, -1 in case of failure
6424 6425 6426 6427 6428 6429
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

6430 6431
    VIR_DOMAIN_DEBUG(domain, "seclabel=%p", seclabel);

6432
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6433
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6434
        virDispatchError(NULL);
6435 6436 6437 6438
        return -1;
    }

    if (seclabel == NULL) {
6439
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6440
        goto error;
6441 6442 6443 6444
    }

    conn = domain->conn;

6445 6446 6447 6448 6449 6450 6451 6452
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

6453
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6454

6455
error:
6456
    virDispatchError(domain->conn);
6457
    return -1;
6458 6459 6460 6461 6462 6463 6464
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
6465 6466 6467
 * 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.
6468
 *
6469
 * Returns 0 in case of success, -1 in case of failure
6470 6471 6472 6473
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
6474
    VIR_DEBUG("conn=%p secmodel=%p", conn, secmodel);
6475

6476
    if (!VIR_IS_CONNECT(conn)) {
6477
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6478
        virDispatchError(NULL);
6479 6480 6481 6482
        return -1;
    }

    if (secmodel == NULL) {
6483
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6484 6485 6486 6487 6488 6489 6490 6491 6492
        goto error;
    }

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

6495
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6496

6497
error:
6498
    virDispatchError(conn);
6499
    return -1;
6500
}
6501

6502 6503 6504 6505
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
6506
 *
6507 6508
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
6509
 *
6510 6511 6512 6513
 * 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.
 *
6514 6515 6516
 * Returns 0 in case of success, -1 in case of failure.
 */
int
6517
virDomainAttachDevice(virDomainPtr domain, const char *xml)
6518 6519
{
    virConnectPtr conn;
6520 6521

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

6523 6524
    virResetLastError();

6525
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6526
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6527
        virDispatchError(NULL);
6528
        return -1;
6529 6530
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6531
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6532
        goto error;
6533 6534 6535
    }
    conn = domain->conn;

6536
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
6537 6538 6539 6540 6541 6542 6543
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

6544
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568

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

/**
 * virDomainAttachDeviceFlags:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
 * @flags: an OR'ed set of virDomainDeviceModifyFlags
 *
 * Attach a virtual device to a domain, using the flags parameter
 * to control how the device is attached.  VIR_DOMAIN_DEVICE_MODIFY_CURRENT
 * specifies that the device allocation is made based on current domain
 * state.  VIR_DOMAIN_DEVICE_MODIFY_LIVE specifies that the device shall be
 * allocated to the active domain instance only and is not added to the
 * persisted domain configuration.  VIR_DOMAIN_DEVICE_MODIFY_CONFIG
 * specifies that the device shall be allocated to the persisted domain
 * configuration only.  Note that the target hypervisor must return an
 * error if unable to satisfy flags.  E.g. the hypervisor driver will
 * return failure if LIVE is specified but it only supports modifying the
 * persisted device allocation.
 *
6569 6570 6571 6572
 * 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 已提交
6573 6574 6575 6576 6577 6578 6579
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
6580 6581

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
6582 6583 6584 6585

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6586
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
6587
        virDispatchError(NULL);
6588
        return -1;
J
Jim Fehlig 已提交
6589 6590
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6591
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
6592 6593 6594 6595 6596
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
6597
        int ret;
J
Jim Fehlig 已提交
6598
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
6599 6600 6601 6602
        if (ret < 0)
            goto error;
        return ret;
    }
6603

6604
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6605 6606

error:
6607
    virDispatchError(domain->conn);
6608
    return -1;
6609 6610 6611 6612 6613 6614
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
6615
 *
6616 6617
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
6618 6619 6620 6621
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
6622
virDomainDetachDevice(virDomainPtr domain, const char *xml)
6623 6624
{
    virConnectPtr conn;
6625 6626

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

6628 6629
    virResetLastError();

6630
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6631
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6632
        virDispatchError(NULL);
6633
        return -1;
6634 6635
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6636
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6637
        goto error;
6638 6639 6640
    }
    conn = domain->conn;

6641 6642 6643
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
6644 6645 6646 6647 6648
         if (ret < 0)
             goto error;
         return ret;
     }

6649
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680

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

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

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
6683 6684 6685 6686

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6687
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
6688
        virDispatchError(NULL);
6689
        return -1;
J
Jim Fehlig 已提交
6690 6691
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6692
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
6693 6694 6695 6696 6697 6698 6699
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
6700 6701 6702 6703 6704
        if (ret < 0)
            goto error;
        return ret;
    }

6705
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740

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

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

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
6743 6744 6745 6746

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6747
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
6748
        virDispatchError(NULL);
6749
        return -1;
6750 6751
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6752
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6753 6754 6755 6756 6757 6758 6759
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
6760 6761 6762 6763
        if (ret < 0)
            goto error;
        return ret;
    }
6764

6765
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6766 6767

error:
6768
    virDispatchError(domain->conn);
6769
    return -1;
6770
}
6771

6772 6773 6774 6775 6776 6777 6778 6779 6780 6781
/**
 * 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
6782
 * with the amount of free memory in bytes for each cell requested,
6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793
 * 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)
{
6794
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
6795 6796
          conn, freeMems, startCell, maxCells);

6797 6798
    virResetLastError();

6799
    if (!VIR_IS_CONNECT(conn)) {
6800
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6801
        virDispatchError(NULL);
6802
        return -1;
6803 6804
    }

D
Daniel Veillard 已提交
6805
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
6806
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6807
        goto error;
6808 6809
    }

6810 6811 6812 6813 6814 6815 6816
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
6817

6818
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6819 6820

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

6825 6826 6827 6828
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
6829
 * Provides the connection pointer associated with a network.  The
6830 6831 6832
 * reference counter on the connection is not increased by this
 * call.
 *
6833 6834 6835 6836
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
6837 6838 6839 6840 6841
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
6842
    VIR_DEBUG("net=%p", net);
6843

6844 6845 6846
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
6847
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6848
        virDispatchError(NULL);
6849 6850 6851 6852 6853
        return NULL;
    }
    return net->conn;
}

6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864
/**
 * 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)
{
6865
    VIR_DEBUG("conn=%p", conn);
6866

6867 6868
    virResetLastError();

6869
    if (!VIR_IS_CONNECT(conn)) {
6870
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6871
        virDispatchError(NULL);
6872
        return -1;
6873 6874
    }

6875 6876 6877 6878 6879 6880 6881
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6882

6883
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6884 6885

error:
6886
    virDispatchError(conn);
6887
    return -1;
6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900
}

/**
 * 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
6901
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
6902
{
6903
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6904

6905 6906
    virResetLastError();

6907
    if (!VIR_IS_CONNECT(conn)) {
6908
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6909
        virDispatchError(NULL);
6910
        return -1;
6911 6912
    }

6913
    if ((names == NULL) || (maxnames < 0)) {
6914
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6915
        goto error;
6916 6917
    }

6918 6919 6920 6921 6922 6923 6924
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6925

6926
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6927 6928

error:
6929
    virDispatchError(conn);
6930
    return -1;
6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943
}

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

6946 6947
    virResetLastError();

6948
    if (!VIR_IS_CONNECT(conn)) {
6949
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6950
        virDispatchError(NULL);
6951
        return -1;
6952 6953
    }

6954 6955 6956 6957 6958 6959 6960
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6961

6962
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6963 6964

error:
6965
    virDispatchError(conn);
6966
    return -1;
6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979
}

/**
 * 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
6980
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
6981 6982
                              int maxnames)
{
6983
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6984

6985 6986
    virResetLastError();

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

6993
    if ((names == NULL) || (maxnames < 0)) {
6994
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6995
        goto error;
6996 6997
    }

6998 6999 7000 7001 7002 7003 7004 7005
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7006

7007
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7008 7009

error:
7010
    virDispatchError(conn);
7011
    return -1;
7012 7013 7014 7015 7016 7017 7018 7019 7020
}

/**
 * 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.
 *
7021 7022
 * 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.
7023 7024 7025 7026
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
7027
    VIR_DEBUG("conn=%p, name=%s", conn, name);
7028

7029 7030
    virResetLastError();

7031
    if (!VIR_IS_CONNECT(conn)) {
7032
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7033
        virDispatchError(NULL);
7034
        return NULL;
7035 7036
    }
    if (name == NULL) {
7037
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7038
        goto  error;
7039 7040
    }

7041 7042 7043 7044 7045 7046 7047
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7048

7049
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7050 7051

error:
7052
    virDispatchError(conn);
7053
    return NULL;
7054 7055 7056 7057 7058 7059 7060 7061 7062
}

/**
 * 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.
 *
7063 7064
 * 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.
7065 7066 7067 7068
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
7069 7070 7071
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    virUUIDFormat(uuid, uuidstr);

7072
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
7073

7074 7075
    virResetLastError();

7076
    if (!VIR_IS_CONNECT(conn)) {
7077
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7078
        virDispatchError(NULL);
7079
        return NULL;
7080 7081
    }
    if (uuid == NULL) {
7082
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7083
        goto error;
7084 7085
    }

7086 7087 7088 7089 7090 7091 7092
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
7093

7094
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7095 7096

error:
7097
    virDispatchError(conn);
7098
    return NULL;
7099 7100 7101 7102 7103 7104 7105 7106 7107
}

/**
 * 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.
 *
7108 7109
 * 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.
7110 7111 7112 7113 7114
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
7115
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
7116

7117 7118
    virResetLastError();

7119
    if (!VIR_IS_CONNECT(conn)) {
7120
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7121
        virDispatchError(NULL);
7122
        return NULL;
7123 7124
    }
    if (uuidstr == NULL) {
7125
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7126
        goto error;
7127 7128
    }

7129
    if (virUUIDParse(uuidstr, uuid) < 0) {
7130
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7131
        goto error;
7132 7133 7134
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
7135 7136

error:
7137
    virDispatchError(conn);
7138
    return NULL;
7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153
}

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

7156 7157
    virResetLastError();

7158
    if (!VIR_IS_CONNECT(conn)) {
7159
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7160
        virDispatchError(NULL);
7161
        return NULL;
7162 7163
    }
    if (xmlDesc == NULL) {
7164
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7165
        goto error;
7166 7167
    }
    if (conn->flags & VIR_CONNECT_RO) {
7168
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7169
        goto error;
7170 7171
    }

7172 7173 7174 7175 7176 7177 7178
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
7179

7180
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7181 7182

error:
7183
    virDispatchError(conn);
7184
    return NULL;
7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196
}

/**
 * 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
7197 7198
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
7199
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
7200

7201 7202
    virResetLastError();

7203
    if (!VIR_IS_CONNECT(conn)) {
7204
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7205
        virDispatchError(NULL);
7206
        return NULL;
7207 7208
    }
    if (conn->flags & VIR_CONNECT_RO) {
7209
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7210
        goto error;
7211 7212
    }
    if (xml == NULL) {
7213
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7214
        goto error;
7215 7216
    }

7217 7218 7219 7220 7221 7222 7223
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
7224

7225
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7226 7227

error:
7228
    virDispatchError(conn);
7229
    return NULL;
7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242
}

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

7245 7246
    virResetLastError();

7247
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7248
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7249
        virDispatchError(NULL);
7250
        return -1;
7251 7252 7253
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7254
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7255
        goto error;
7256 7257
    }

7258 7259 7260 7261 7262 7263 7264
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
7265

7266
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7267 7268

error:
7269
    virDispatchError(network->conn);
7270
    return -1;
7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282
}

/**
 * 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
7283 7284
virNetworkCreate(virNetworkPtr network)
{
7285
    virConnectPtr conn;
7286
    VIR_DEBUG("network=%p", network);
7287

7288 7289
    virResetLastError();

7290
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7291
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7292
        virDispatchError(NULL);
7293
        return -1;
7294 7295 7296
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7297
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7298
        goto error;
7299 7300
    }

7301 7302 7303 7304 7305 7306 7307
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
7308

7309
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7310 7311

error:
7312
    virDispatchError(network->conn);
7313
    return -1;
7314 7315 7316 7317 7318 7319 7320
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
7321 7322 7323
 * 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
7324 7325 7326 7327 7328 7329 7330
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
7331
    VIR_DEBUG("network=%p", network);
7332

7333 7334
    virResetLastError();

7335
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7336
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7337
        virDispatchError(NULL);
7338
        return -1;
7339 7340 7341 7342
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7343
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7344
        goto error;
7345 7346
    }

7347 7348 7349 7350 7351 7352 7353
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
7354

7355
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7356 7357

error:
7358
    virDispatchError(network->conn);
7359
    return -1;
7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373
}

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

7376 7377 7378
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7379
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7380
        virDispatchError(NULL);
7381
        return -1;
7382
    }
7383 7384
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
7385
        return -1;
7386
    }
7387
    return 0;
7388 7389
}

7390 7391
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
7392
 * @network: the network to hold a reference on
7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403
 *
 * 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 已提交
7404 7405
 *
 * Returns 0 in case of success, -1 in case of failure.
7406 7407 7408 7409 7410
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
7411
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7412
        virDispatchError(NULL);
7413
        return -1;
7414 7415
    }
    virMutexLock(&network->conn->lock);
7416
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
7417 7418 7419 7420 7421
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433
/**
 * 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)
{
7434
    VIR_DEBUG("network=%p", network);
7435

7436 7437
    virResetLastError();

7438
    if (!VIR_IS_NETWORK(network)) {
7439
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7440
        virDispatchError(NULL);
7441
        return NULL;
7442
    }
7443
    return network->name;
7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457
}

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

7460 7461
    virResetLastError();

7462
    if (!VIR_IS_NETWORK(network)) {
7463
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7464
        virDispatchError(NULL);
7465
        return -1;
7466 7467
    }
    if (uuid == NULL) {
7468
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7469
        goto error;
7470 7471 7472 7473
    }

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

7474
    return 0;
7475 7476

error:
7477
    virDispatchError(network->conn);
7478
    return -1;
7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494
}

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

7497 7498
    virResetLastError();

7499
    if (!VIR_IS_NETWORK(network)) {
7500
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7501
        virDispatchError(NULL);
7502
        return -1;
7503 7504
    }
    if (buf == NULL) {
7505
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7506
        goto error;
7507 7508 7509
    }

    if (virNetworkGetUUID(network, &uuid[0]))
7510
        goto error;
7511

7512
    virUUIDFormat(uuid, buf);
7513
    return 0;
7514 7515

error:
7516
    virDispatchError(network->conn);
7517
    return -1;
7518 7519 7520 7521 7522
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
7523
 * @flags: an OR'ed set of extraction flags, not used yet
7524 7525 7526 7527 7528 7529 7530 7531 7532 7533
 *
 * Provide an XML description of the network. The description may be reused
 * later to relaunch the network with virNetworkCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNetworkGetXMLDesc(virNetworkPtr network, int flags)
{
7534
    virConnectPtr conn;
7535
    VIR_DEBUG("network=%p, flags=%d", network, flags);
7536

7537 7538 7539
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7540
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7541
        virDispatchError(NULL);
7542
        return NULL;
7543 7544
    }
    if (flags != 0) {
7545
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7546
        goto error;
7547 7548
    }

7549 7550
    conn = network->conn;

7551
    if (conn->networkDriver && conn->networkDriver->networkGetXMLDesc) {
7552
        char *ret;
7553
        ret = conn->networkDriver->networkGetXMLDesc(network, flags);
7554 7555 7556 7557
        if (!ret)
            goto error;
        return ret;
    }
7558

7559
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7560 7561

error:
7562
    virDispatchError(network->conn);
7563
    return NULL;
7564
}
7565 7566 7567 7568 7569

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
7570
 * Provides a bridge interface name to which a domain may connect
7571 7572 7573 7574 7575 7576 7577 7578
 * 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)
{
7579
    virConnectPtr conn;
7580
    VIR_DEBUG("network=%p", network);
7581

7582 7583 7584
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7585
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7586
        virDispatchError(NULL);
7587
        return NULL;
7588 7589
    }

7590 7591
    conn = network->conn;

7592 7593 7594 7595 7596 7597 7598
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
7599

7600
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7601 7602

error:
7603
    virDispatchError(network->conn);
7604
    return NULL;
7605
}
7606 7607 7608 7609

/**
 * virNetworkGetAutostart:
 * @network: a network object
7610
 * @autostart: the value returned
7611
 *
7612
 * Provides a boolean value indicating whether the network
7613 7614 7615 7616 7617 7618 7619
 * 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,
7620 7621 7622
                       int *autostart)
{
    virConnectPtr conn;
7623
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
7624

7625 7626 7627
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7628
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7629
        virDispatchError(NULL);
7630
        return -1;
7631 7632
    }
    if (!autostart) {
7633
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7634
        goto error;
7635 7636
    }

7637 7638
    conn = network->conn;

7639 7640 7641 7642 7643 7644 7645
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7646

7647
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7648 7649

error:
7650
    virDispatchError(network->conn);
7651
    return -1;
7652 7653 7654 7655 7656
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
7657
 * @autostart: whether the network should be automatically started 0 or 1
7658 7659 7660 7661 7662 7663 7664 7665
 *
 * 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,
7666 7667 7668
                       int autostart)
{
    virConnectPtr conn;
7669
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
7670

7671 7672 7673
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7674
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7675
        virDispatchError(NULL);
7676
        return -1;
7677 7678
    }

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

7684 7685
    conn = network->conn;

7686 7687 7688 7689 7690 7691 7692
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7693

7694
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7695 7696

error:
7697
    virDispatchError(network->conn);
7698
    return -1;
7699
}
7700

D
Daniel Veillard 已提交
7701 7702
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
7703
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715
 *
 * 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
7716
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
7717
{
7718
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7719 7720 7721

    virResetLastError();

7722
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
7723
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7724
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7725 7726
        return NULL;
    }
7727
    return iface->conn;
D
Daniel Veillard 已提交
7728 7729 7730 7731 7732 7733
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
7734
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
7735
 *
7736
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
7737 7738 7739 7740
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
7741
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
7742 7743 7744 7745

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7746
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7747
        virDispatchError(NULL);
7748
        return -1;
D
Daniel Veillard 已提交
7749 7750 7751 7752 7753 7754 7755 7756 7757 7758
    }

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

7759
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7760 7761

error:
7762
    virDispatchError(conn);
D
Daniel Veillard 已提交
7763 7764 7765 7766 7767 7768 7769 7770 7771
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
7772 7773
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
7774 7775 7776 7777 7778 7779
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
7780
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
7781 7782 7783 7784

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7785
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7786
        virDispatchError(NULL);
7787
        return -1;
D
Daniel Veillard 已提交
7788 7789 7790
    }

    if ((names == NULL) || (maxnames < 0)) {
7791
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802
        goto error;
    }

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

7803
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7804 7805

error:
7806
    virDispatchError(conn);
D
Daniel Veillard 已提交
7807 7808 7809
    return -1;
}

7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820
/**
 * 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)
{
7821
    VIR_DEBUG("conn=%p", conn);
7822 7823 7824 7825

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7826
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7827
        virDispatchError(NULL);
7828
        return -1;
7829 7830 7831 7832 7833 7834 7835 7836 7837 7838
    }

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

7839
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7840 7841

error:
7842
    virDispatchError(conn);
7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861
    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)
{
7862
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7863 7864 7865 7866

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7867
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7868
        virDispatchError(NULL);
7869
        return -1;
7870 7871 7872
    }

    if ((names == NULL) || (maxnames < 0)) {
7873
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884
        goto error;
    }

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

7885
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7886 7887

error:
7888
    virDispatchError(conn);
7889 7890 7891
    return -1;
}

D
Daniel Veillard 已提交
7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904
/**
 * 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)
{
7905
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
7906 7907 7908 7909

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7910
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7911
        virDispatchError(NULL);
7912
        return NULL;
D
Daniel Veillard 已提交
7913 7914
    }
    if (name == NULL) {
7915
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926
        goto  error;
    }

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

7927
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7928 7929

error:
7930
    virDispatchError(conn);
D
Daniel Veillard 已提交
7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946
    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)
{
7947
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
7948 7949 7950 7951

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7952
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7953
        virDispatchError(NULL);
7954
        return NULL;
D
Daniel Veillard 已提交
7955 7956
    }
    if (macstr == NULL) {
7957
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968
        goto  error;
    }

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

7969
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7970 7971

error:
7972
    virDispatchError(conn);
D
Daniel Veillard 已提交
7973 7974 7975 7976 7977
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
7978
 * @iface: an interface object
D
Daniel Veillard 已提交
7979 7980 7981 7982 7983 7984 7985
 *
 * 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 *
7986
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
7987
{
7988
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7989 7990 7991

    virResetLastError();

7992
    if (!VIR_IS_INTERFACE(iface)) {
7993
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7994
        virDispatchError(NULL);
7995
        return NULL;
D
Daniel Veillard 已提交
7996
    }
7997
    return iface->name;
D
Daniel Veillard 已提交
7998 7999 8000 8001
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
8002
 * @iface: an interface object
D
Daniel Veillard 已提交
8003
 *
L
Laine Stump 已提交
8004
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
8005 8006 8007 8008 8009 8010 8011
 * 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 *
8012
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
8013
{
8014
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8015 8016 8017

    virResetLastError();

8018
    if (!VIR_IS_INTERFACE(iface)) {
8019
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8020
        virDispatchError(NULL);
8021
        return NULL;
D
Daniel Veillard 已提交
8022
    }
8023
    return iface->mac;
D
Daniel Veillard 已提交
8024 8025 8026 8027
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
8028
 * @iface: an interface object
8029 8030 8031 8032 8033
 * @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 已提交
8034
 *
8035 8036 8037 8038 8039
 * 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 已提交
8040 8041 8042 8043 8044
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
8045
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
8046 8047
{
    virConnectPtr conn;
8048
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
8049 8050 8051

    virResetLastError();

8052
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8053
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8054
        virDispatchError(NULL);
8055
        return NULL;
D
Daniel Veillard 已提交
8056
    }
8057
    if ((flags & ~VIR_INTERFACE_XML_INACTIVE) != 0) {
8058
        virLibInterfaceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
8059 8060 8061
        goto error;
    }

8062
    conn = iface->conn;
D
Daniel Veillard 已提交
8063 8064 8065

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
8066
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
8067 8068 8069 8070 8071
        if (!ret)
            goto error;
        return ret;
    }

8072
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8073 8074

error:
8075
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091
    return NULL;
}

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

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
8097
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8098
        virDispatchError(NULL);
8099
        return NULL;
D
Daniel Veillard 已提交
8100 8101
    }
    if (conn->flags & VIR_CONNECT_RO) {
8102
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8103 8104 8105
        goto error;
    }
    if (xml == NULL) {
8106
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117
        goto error;
    }

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

8118
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8119 8120

error:
8121
    virDispatchError(conn);
D
Daniel Veillard 已提交
8122 8123 8124 8125 8126
    return NULL;
}

/**
 * virInterfaceUndefine:
8127
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
8128 8129 8130 8131 8132 8133 8134
 *
 * Undefine an interface, ie remove it from the config.
 * This does not free the associated virInterfacePtr object.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
8135
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
8136
    virConnectPtr conn;
8137
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8138 8139 8140

    virResetLastError();

8141
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8142
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8143
        virDispatchError(NULL);
8144
        return -1;
D
Daniel Veillard 已提交
8145
    }
8146
    conn = iface->conn;
D
Daniel Veillard 已提交
8147
    if (conn->flags & VIR_CONNECT_RO) {
8148
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8149 8150 8151 8152 8153
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
8154
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
8155 8156 8157 8158 8159
        if (ret < 0)
            goto error;
        return ret;
    }

8160
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8161 8162

error:
8163
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8164 8165 8166 8167 8168
    return -1;
}

/**
 * virInterfaceCreate:
8169
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
8170 8171 8172 8173 8174 8175 8176
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Activate an interface (ie call "ifup")
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
8177
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
8178 8179
{
    virConnectPtr conn;
8180
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
8181 8182 8183

    virResetLastError();

8184
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8185
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8186
        virDispatchError(NULL);
8187
        return -1;
D
Daniel Veillard 已提交
8188
    }
8189
    conn = iface->conn;
D
Daniel Veillard 已提交
8190
    if (conn->flags & VIR_CONNECT_RO) {
8191
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8192 8193 8194 8195 8196
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
8197
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
8198 8199 8200 8201 8202
        if (ret < 0)
            goto error;
        return ret;
    }

8203
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8204 8205

error:
8206
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8207 8208 8209 8210 8211
    return -1;
}

/**
 * virInterfaceDestroy:
8212
 * @iface: an interface object
D
Daniel Veillard 已提交
8213 8214 8215 8216 8217 8218 8219 8220 8221
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * deactivate an interface (ie call "ifdown")
 * This does not remove the interface from the config, and
 * does not free the associated virInterfacePtr object.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
8222
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
8223 8224
{
    virConnectPtr conn;
8225
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
8226 8227 8228

    virResetLastError();

8229
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8230
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8231
        virDispatchError(NULL);
8232
        return -1;
D
Daniel Veillard 已提交
8233 8234
    }

8235
    conn = iface->conn;
D
Daniel Veillard 已提交
8236
    if (conn->flags & VIR_CONNECT_RO) {
8237
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8238 8239 8240 8241 8242
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
8243
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
8244 8245 8246 8247 8248
        if (ret < 0)
            goto error;
        return ret;
    }

8249
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8250 8251

error:
8252
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8253 8254 8255 8256 8257
    return -1;
}

/**
 * virInterfaceRef:
8258
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
8259 8260 8261 8262 8263 8264 8265 8266 8267
 *
 * 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 已提交
8268
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
8269 8270 8271 8272 8273
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8274
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
8275
{
8276
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
8277
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8278
        virDispatchError(NULL);
8279
        return -1;
D
Daniel Veillard 已提交
8280
    }
8281
    virMutexLock(&iface->conn->lock);
8282
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
8283 8284
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
8285 8286 8287 8288 8289
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
8290
 * @iface: an interface object
D
Daniel Veillard 已提交
8291 8292 8293 8294 8295 8296 8297
 *
 * 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
8298
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
8299
{
8300
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8301 8302 8303

    virResetLastError();

8304
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8305
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8306
        virDispatchError(NULL);
8307
        return -1;
D
Daniel Veillard 已提交
8308
    }
8309 8310
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
8311
        return -1;
8312
    }
8313
    return 0;
D
Daniel Veillard 已提交
8314 8315
}

8316 8317 8318

/**
 * virStoragePoolGetConnect:
8319
 * @pool: pointer to a pool
8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333
 *
 * 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)
{
8334
    VIR_DEBUG("pool=%p", pool);
8335

8336 8337 8338
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
8339
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8340
        virDispatchError(NULL);
8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356
        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)
{
8357
    VIR_DEBUG("conn=%p", conn);
8358

8359 8360
    virResetLastError();

8361
    if (!VIR_IS_CONNECT(conn)) {
8362
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8363
        virDispatchError(NULL);
8364
        return -1;
8365 8366
    }

8367 8368 8369 8370 8371 8372 8373
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8374

8375
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8376 8377

error:
8378
    virDispatchError(conn);
8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398
    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)
{
8399
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8400

8401 8402
    virResetLastError();

8403
    if (!VIR_IS_CONNECT(conn)) {
8404
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8405
        virDispatchError(NULL);
8406
        return -1;
8407 8408 8409
    }

    if ((names == NULL) || (maxnames < 0)) {
8410
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8411
        goto error;
8412 8413
    }

8414 8415 8416 8417 8418 8419 8420
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8421

8422
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8423

8424
error:
8425
    virDispatchError(conn);
8426
    return -1;
8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440
}


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

8443 8444
    virResetLastError();

8445
    if (!VIR_IS_CONNECT(conn)) {
8446
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8447
        virDispatchError(NULL);
8448
        return -1;
8449 8450
    }

8451 8452 8453 8454 8455 8456 8457
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8458

8459
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8460 8461

error:
8462
    virDispatchError(conn);
8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483
    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)
{
8484
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8485

8486 8487
    virResetLastError();

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

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

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

8507
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8508 8509

error:
8510
    virDispatchError(conn);
8511 8512 8513 8514
    return -1;
}


8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541
/**
 * 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)
{
8542
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);
8543 8544 8545

    virResetLastError();

8546
    if (!VIR_IS_CONNECT(conn)) {
8547
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8548
        virDispatchError(NULL);
8549
        return NULL;
8550 8551
    }
    if (type == NULL) {
8552
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8553
        goto error;
8554 8555
    }

8556
    if (conn->flags & VIR_CONNECT_RO) {
8557
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8558
        goto error;
8559 8560
    }

8561 8562 8563 8564 8565 8566 8567
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
8568

8569
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8570 8571

error:
8572
    virDispatchError(conn);
8573 8574 8575 8576
    return NULL;
}


8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589
/**
 * 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)
{
8590
    VIR_DEBUG("conn=%p, name=%s", conn, name);
8591

8592 8593
    virResetLastError();

8594
    if (!VIR_IS_CONNECT(conn)) {
8595
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8596
        virDispatchError(NULL);
8597
        return NULL;
8598 8599
    }
    if (name == NULL) {
8600
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8601
        goto error;
8602 8603
    }

8604 8605 8606 8607 8608 8609 8610
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8611

8612
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8613 8614

error:
8615
    virDispatchError(conn);
8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632
    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)
{
8633
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
8634

8635 8636
    virResetLastError();

8637
    if (!VIR_IS_CONNECT(conn)) {
8638
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8639
        virDispatchError(NULL);
8640
        return NULL;
8641 8642
    }
    if (uuid == NULL) {
8643
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8644
        goto error;
8645 8646
    }

8647 8648 8649 8650 8651 8652 8653
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
8654

8655
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8656

8657
error:
8658
    virDispatchError(conn);
8659
    return NULL;
8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673
}


/**
 * 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,
8674
                                 const char *uuidstr)
8675 8676
{
    unsigned char uuid[VIR_UUID_BUFLEN];
8677
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
8678

8679 8680
    virResetLastError();

8681
    if (!VIR_IS_CONNECT(conn)) {
8682
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8683
        virDispatchError(NULL);
8684
        return NULL;
8685 8686
    }
    if (uuidstr == NULL) {
8687
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8688
        goto error;
8689 8690 8691
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
8692
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8693
        goto error;
8694 8695 8696
    }

    return virStoragePoolLookupByUUID(conn, uuid);
8697 8698

error:
8699
    virDispatchError(conn);
8700
    return NULL;
8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714
}


/**
 * 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)
{
8715
    VIR_DEBUG("vol=%p", vol);
8716

8717 8718 8719
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
8720
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8721
        virDispatchError(NULL);
8722
        return NULL;
8723 8724
    }

8725 8726 8727 8728 8729 8730 8731
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
8732

8733
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8734

8735
error:
8736
    virDispatchError(vol->conn);
8737
    return NULL;
8738 8739 8740 8741 8742 8743
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
8744
 * @flags: future flags, use 0 for now
8745 8746
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
8747
 * pool is not persistent, so its definition will disappear
8748 8749 8750 8751 8752 8753 8754 8755 8756
 * 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)
{
8757
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
8758

8759 8760
    virResetLastError();

8761
    if (!VIR_IS_CONNECT(conn)) {
8762
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8763
        virDispatchError(NULL);
8764
        return NULL;
8765 8766
    }
    if (xmlDesc == NULL) {
8767
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8768
        goto error;
8769 8770
    }
    if (conn->flags & VIR_CONNECT_RO) {
8771
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8772
        goto error;
8773 8774
    }

8775 8776 8777 8778 8779 8780 8781
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
8782

8783
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8784 8785

error:
8786
    virDispatchError(conn);
8787 8788 8789 8790 8791 8792 8793
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
8794
 * @flags: future flags, use 0 for now
8795 8796
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
8797
 * pool is persistent, until explicitly undefined.
8798 8799 8800 8801 8802 8803 8804 8805
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
8806
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
8807

8808 8809
    virResetLastError();

8810
    if (!VIR_IS_CONNECT(conn)) {
8811
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8812
        virDispatchError(NULL);
8813
        return NULL;
8814 8815
    }
    if (conn->flags & VIR_CONNECT_RO) {
8816
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8817
        goto error;
8818 8819
    }
    if (xml == NULL) {
8820
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8821
        goto error;
8822 8823
    }

8824 8825 8826 8827 8828 8829 8830
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
8831

8832
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8833

8834
error:
8835
    virDispatchError(conn);
8836
    return NULL;
8837 8838 8839 8840 8841
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
8842
 * @flags: future flags, use 0 for now
8843 8844 8845 8846 8847 8848 8849 8850 8851 8852
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
8853
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8854

8855 8856
    virResetLastError();

8857
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8858
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8859
        virDispatchError(NULL);
8860
        return -1;
8861 8862 8863
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8864
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8865
        goto error;
8866 8867
    }

8868 8869 8870 8871 8872 8873 8874
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8875

8876
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8877

8878
error:
8879
    virDispatchError(pool->conn);
8880
    return -1;
8881 8882 8883 8884 8885 8886 8887 8888 8889
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
8890
 * Returns 0 on success, -1 on failure
8891 8892 8893 8894 8895
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
8896
    VIR_DEBUG("pool=%p", pool);
8897

8898 8899
    virResetLastError();

8900
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8901
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8902
        virDispatchError(NULL);
8903
        return -1;
8904 8905 8906
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8907
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8908
        goto error;
8909 8910
    }

8911 8912 8913 8914 8915 8916 8917
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8918

8919
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8920

8921
error:
8922
    virDispatchError(pool->conn);
8923
    return -1;
8924 8925 8926 8927 8928 8929
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
8930
 * @flags: future flags, use 0 for now
8931 8932 8933 8934 8935 8936 8937 8938 8939 8940
 *
 * 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;
8941
    VIR_DEBUG("pool=%p", pool);
8942

8943 8944
    virResetLastError();

8945
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8946
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8947
        virDispatchError(NULL);
8948
        return -1;
8949 8950 8951
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8952
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8953
        goto error;
8954 8955
    }

8956 8957 8958 8959 8960 8961 8962
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8963

8964
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8965

8966
error:
8967
    virDispatchError(pool->conn);
8968
    return -1;
8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987
}


/**
 * 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;
8988
    VIR_DEBUG("pool=%p", pool);
8989

8990 8991
    virResetLastError();

8992
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8993
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8994
        virDispatchError(NULL);
8995
        return -1;
8996 8997 8998 8999
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9000
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9001
        goto error;
9002 9003
    }

9004 9005 9006 9007 9008 9009 9010
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
9011

9012
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9013 9014

error:
9015
    virDispatchError(pool->conn);
9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034
    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;
9035
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
9036

9037 9038
    virResetLastError();

9039
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9040
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9041
        virDispatchError(NULL);
9042
        return -1;
9043 9044 9045 9046
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9047
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9048
        goto error;
9049 9050
    }

9051 9052 9053 9054 9055 9056 9057
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9058

9059
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9060 9061

error:
9062
    virDispatchError(pool->conn);
9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078
    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)
{
9079
    VIR_DEBUG("pool=%p", pool);
9080

9081 9082 9083
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9084
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9085
        virDispatchError(NULL);
9086
        return -1;
9087
    }
9088 9089
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
9090
        return -1;
9091
    }
9092
    return 0;
9093 9094 9095 9096

}


9097 9098
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
9099
 * @pool: the pool to hold a reference on
9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110
 *
 * 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 已提交
9111 9112
 *
 * Returns 0 in case of success, -1 in case of failure.
9113 9114 9115 9116 9117
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
9118
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9119
        virDispatchError(NULL);
9120
        return -1;
9121 9122
    }
    virMutexLock(&pool->conn->lock);
9123
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
9124 9125 9126 9127 9128
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

9129 9130 9131 9132 9133 9134 9135 9136 9137
/**
 * 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
 *
9138
 * Returns 0 if the volume list was refreshed, -1 on failure
9139 9140 9141 9142 9143 9144
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
9145
    VIR_DEBUG("pool=%p flags=%u", pool, flags);
9146

9147 9148
    virResetLastError();

9149
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9150
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9151
        virDispatchError(NULL);
9152
        return -1;
9153 9154 9155 9156
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9157
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9158
        goto error;
9159 9160
    }

9161 9162 9163 9164 9165 9166 9167
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9168

9169
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9170 9171

error:
9172
    virDispatchError(pool->conn);
9173 9174 9175 9176 9177 9178 9179 9180 9181 9182
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
9183
 * Returns the name of the pool, or NULL on error
9184 9185 9186 9187
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
9188
    VIR_DEBUG("pool=%p", pool);
9189

9190 9191
    virResetLastError();

9192
    if (!VIR_IS_STORAGE_POOL(pool)) {
9193
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9194
        virDispatchError(NULL);
9195
        return NULL;
9196
    }
9197
    return pool->name;
9198 9199 9200 9201 9202 9203 9204 9205 9206 9207
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
9208
 * Returns 0 on success, or -1 on error;
9209 9210 9211 9212 9213
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
9214
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
9215

9216 9217
    virResetLastError();

9218
    if (!VIR_IS_STORAGE_POOL(pool)) {
9219
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9220
        virDispatchError(NULL);
9221
        return -1;
9222 9223
    }
    if (uuid == NULL) {
9224
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9225
        goto error;
9226 9227 9228 9229
    }

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

9230
    return 0;
9231

9232
error:
9233
    virDispatchError(pool->conn);
9234
    return -1;
9235 9236 9237 9238 9239 9240 9241 9242 9243
}

/**
 * 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
 *
9244
 * Returns 0 on success, or -1 on error;
9245 9246 9247 9248 9249 9250
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
9251
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
9252

9253 9254
    virResetLastError();

9255
    if (!VIR_IS_STORAGE_POOL(pool)) {
9256
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9257
        virDispatchError(NULL);
9258
        return -1;
9259 9260
    }
    if (buf == NULL) {
9261
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9262
        goto error;
9263 9264 9265
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
9266
        goto error;
9267 9268

    virUUIDFormat(uuid, buf);
9269
    return 0;
9270

9271
error:
9272
    virDispatchError(pool->conn);
9273
    return -1;
9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284
}


/**
 * 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
 *
9285
 * Returns 0 on success, or -1 on failure.
9286 9287 9288 9289 9290 9291
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
9292
    VIR_DEBUG("pool=%p, info=%p", pool, info);
9293

9294 9295
    virResetLastError();

9296
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9297
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9298
        virDispatchError(NULL);
9299
        return -1;
9300 9301
    }
    if (info == NULL) {
9302
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9303
        goto error;
9304 9305 9306 9307 9308 9309
    }

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

    conn = pool->conn;

9310 9311 9312 9313 9314 9315 9316
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
9317

9318
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9319

9320
error:
9321
    virDispatchError(pool->conn);
9322
    return -1;
9323 9324 9325 9326 9327 9328
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
9329
 * @flags: flags for XML format options (set of virDomainXMLFlags)
9330 9331 9332 9333 9334
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
9335
 * Returns a XML document, or NULL on error
9336 9337 9338 9339 9340 9341
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
9342
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
9343

9344 9345 9346
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9347
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9348
        virDispatchError(NULL);
9349
        return NULL;
9350 9351
    }
    if (flags != 0) {
9352
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9353
        goto error;
9354 9355 9356 9357
    }

    conn = pool->conn;

9358 9359 9360 9361 9362 9363 9364
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
9365

9366
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9367

9368
error:
9369
    virDispatchError(pool->conn);
9370
    return NULL;
9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381
}


/**
 * 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
 *
9382
 * Returns 0 on success, -1 on failure
9383 9384 9385 9386 9387 9388
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
9389
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
9390

9391 9392 9393
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9394
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9395
        virDispatchError(NULL);
9396
        return -1;
9397 9398
    }
    if (!autostart) {
9399
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9400
        goto error;
9401 9402 9403 9404
    }

    conn = pool->conn;

9405 9406 9407 9408 9409 9410 9411
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9412

9413
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9414 9415

error:
9416
    virDispatchError(pool->conn);
9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
9428
 * Returns 0 on success, -1 on failure
9429 9430 9431 9432 9433 9434
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
9435
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
9436

9437 9438 9439
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9440
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9441
        virDispatchError(NULL);
9442
        return -1;
9443 9444
    }

9445
    if (pool->conn->flags & VIR_CONNECT_RO) {
9446
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9447
        goto error;
9448 9449
    }

9450 9451
    conn = pool->conn;

9452 9453 9454 9455 9456 9457 9458
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9459

9460
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9461 9462

error:
9463
    virDispatchError(pool->conn);
9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478
    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)
{
9479
    VIR_DEBUG("pool=%p", pool);
9480

9481 9482
    virResetLastError();

9483
    if (!VIR_IS_STORAGE_POOL(pool)) {
9484
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9485
        virDispatchError(NULL);
9486
        return -1;
9487 9488
    }

9489 9490 9491 9492 9493 9494 9495
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
9496

9497
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9498 9499

error:
9500
    virDispatchError(pool->conn);
9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520
    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)
{
9521
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
9522

9523 9524
    virResetLastError();

9525
    if (!VIR_IS_STORAGE_POOL(pool)) {
9526
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9527
        virDispatchError(NULL);
9528
        return -1;
9529 9530 9531
    }

    if ((names == NULL) || (maxnames < 0)) {
9532
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9533
        goto error;
9534 9535
    }

9536 9537 9538 9539 9540 9541 9542
    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;
    }
9543

9544
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9545 9546

error:
9547
    virDispatchError(pool->conn);
9548 9549 9550 9551 9552 9553
    return -1;
}


/**
 * virStorageVolGetConnect:
9554
 * @vol: pointer to a pool
9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568
 *
 * 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)
{
9569
    VIR_DEBUG("vol=%p", vol);
9570

9571 9572
    virResetLastError();

9573
    if (!VIR_IS_STORAGE_VOL (vol)) {
9574
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9575
        virDispatchError(NULL);
9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589
        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
 *
9590
 * Returns a storage volume, or NULL if not found / error
9591 9592 9593 9594 9595
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
9596
    VIR_DEBUG("pool=%p, name=%s", pool, name);
9597

9598 9599
    virResetLastError();

9600
    if (!VIR_IS_STORAGE_POOL(pool)) {
9601
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9602
        virDispatchError(NULL);
9603
        return NULL;
9604 9605
    }
    if (name == NULL) {
9606
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9607
        goto error;
9608 9609
    }

9610 9611 9612 9613 9614 9615 9616
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
9617

9618
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9619 9620

error:
9621
    virDispatchError(pool->conn);
9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634
    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
 *
9635
 * Returns a storage volume, or NULL if not found / error
9636 9637 9638 9639 9640
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
9641
    VIR_DEBUG("conn=%p, key=%s", conn, key);
9642

9643 9644
    virResetLastError();

9645
    if (!VIR_IS_CONNECT(conn)) {
9646
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9647
        virDispatchError(NULL);
9648
        return NULL;
9649 9650
    }
    if (key == NULL) {
9651
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9652
        goto error;
9653 9654
    }

9655 9656 9657 9658 9659 9660 9661
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
9662

9663
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9664 9665

error:
9666
    virDispatchError(conn);
9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677
    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
 *
9678
 * Returns a storage volume, or NULL if not found / error
9679 9680 9681 9682 9683
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
9684
    VIR_DEBUG("conn=%p, path=%s", conn, path);
9685

9686 9687
    virResetLastError();

9688
    if (!VIR_IS_CONNECT(conn)) {
9689
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9690
        virDispatchError(NULL);
9691
        return NULL;
9692 9693
    }
    if (path == NULL) {
9694
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9695
        goto error;
9696 9697
    }

9698 9699 9700 9701 9702 9703 9704
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
9705

9706
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9707 9708

error:
9709
    virDispatchError(conn);
9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
9721
 * Returns the volume name, or NULL on error
9722 9723 9724 9725
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
9726
    VIR_DEBUG("vol=%p", vol);
9727

9728 9729
    virResetLastError();

9730
    if (!VIR_IS_STORAGE_VOL(vol)) {
9731
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9732
        virDispatchError(NULL);
9733
        return NULL;
9734
    }
9735
    return vol->name;
9736 9737 9738 9739 9740 9741 9742 9743
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
9744
 * unique, so the same volume will have the same
9745 9746
 * key no matter what host it is accessed from
 *
9747
 * Returns the volume key, or NULL on error
9748 9749 9750 9751
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
9752
    VIR_DEBUG("vol=%p", vol);
9753

9754 9755
    virResetLastError();

9756
    if (!VIR_IS_STORAGE_VOL(vol)) {
9757
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9758
        virDispatchError(NULL);
9759
        return NULL;
9760
    }
9761
    return vol->key;
9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774
}


/**
 * 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
 *
9775
 * Returns the storage volume, or NULL on error
9776 9777 9778 9779 9780 9781
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
9782
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
9783

9784 9785
    virResetLastError();

9786
    if (!VIR_IS_STORAGE_POOL(pool)) {
9787
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9788
        virDispatchError(NULL);
9789
        return NULL;
9790 9791 9792
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
9793
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9794
        goto error;
9795 9796
    }

9797 9798 9799 9800 9801 9802 9803
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
9804

9805
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9806 9807

error:
9808
    virDispatchError(pool->conn);
9809 9810 9811 9812
    return NULL;
}


9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824
/**
 * 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.
 *
9825
 * Returns the storage volume, or NULL on error
9826 9827 9828 9829 9830 9831 9832
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
9833
    VIR_DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);
9834 9835 9836 9837

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
9838
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9839
        virDispatchError(NULL);
9840
        return NULL;
9841 9842 9843
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
9844
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9845
        goto error;
9846 9847 9848 9849
    }

    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
9850
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863
        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;
    }

9864
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9865 9866

error:
9867
    virDispatchError(pool->conn);
9868 9869 9870 9871
    return NULL;
}


9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011
/**
 * 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)
{
    VIR_DEBUG("vol=%p stream=%p offset=%llu length=%llu flags=%u",
              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)
{
    VIR_DEBUG("vol=%p stream=%p offset=%llu length=%llu flags=%u",
              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;
}


10012 10013 10014
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
10015
 * @flags: future flags, use 0 for now
10016 10017 10018
 *
 * Delete the storage volume from the pool
 *
10019
 * Returns 0 on success, or -1 on error
10020 10021 10022 10023 10024 10025
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
10026
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
10027

10028 10029
    virResetLastError();

10030
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10031
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10032
        virDispatchError(NULL);
10033
        return -1;
10034 10035 10036 10037
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10038
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10039
        goto error;
10040 10041
    }

10042 10043 10044 10045 10046 10047 10048
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10049

10050
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10051 10052

error:
10053
    virDispatchError(vol->conn);
10054 10055 10056 10057
    return -1;
}


10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076
/**
 * virStorageVolWipe:
 * @vol: pointer to storage volume
 * @flags: future flags, use 0 for now
 *
 * Ensure data previously on a volume is not accessible to future reads
 *
 * Returns 0 on success, or -1 on error
 */
int
virStorageVolWipe(virStorageVolPtr vol,
                  unsigned int flags)
{
    virConnectPtr conn;
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10077
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10078
        virDispatchError(NULL);
10079
        return -1;
10080 10081 10082 10083
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10084
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

10097
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10098 10099 10100 10101 10102 10103 10104

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


10105 10106 10107 10108 10109
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
10110
 * storage volume continues to exist.
10111
 *
10112
 * Returns 0 on success, or -1 on error
10113 10114 10115 10116
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
10117
    VIR_DEBUG("vol=%p", vol);
10118

10119 10120
    virResetLastError();

10121
    if (!VIR_IS_STORAGE_VOL(vol)) {
10122
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10123
        virDispatchError(NULL);
10124
        return -1;
10125
    }
10126 10127
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
10128
        return -1;
10129
    }
10130
    return 0;
10131 10132 10133
}


10134 10135
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
10136
 * @vol: the vol to hold a reference on
10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147
 *
 * 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 已提交
10148 10149
 *
 * Returns 0 in case of success, -1 in case of failure.
10150 10151 10152 10153 10154
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
10155
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10156
        virDispatchError(NULL);
10157
        return -1;
10158 10159
    }
    virMutexLock(&vol->conn->lock);
10160
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
10161 10162 10163 10164 10165
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

10166 10167 10168 10169 10170 10171 10172 10173
/**
 * 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
 *
10174
 * Returns 0 on success, or -1 on failure
10175 10176 10177 10178 10179 10180
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
10181
    VIR_DEBUG("vol=%p, info=%p", vol, info);
10182

10183 10184
    virResetLastError();

10185
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10186
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10187
        virDispatchError(NULL);
10188
        return -1;
10189 10190
    }
    if (info == NULL) {
10191
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10192
        goto error;
10193 10194 10195 10196 10197 10198
    }

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

    conn = vol->conn;

10199 10200 10201 10202 10203 10204 10205
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
10206

10207
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10208 10209

error:
10210
    virDispatchError(vol->conn);
10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222
    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
 *
10223
 * Returns the XML document, or NULL on error
10224 10225 10226 10227 10228 10229
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
10230
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
10231

10232 10233
    virResetLastError();

10234
    if (!VIR_IS_STORAGE_VOL(vol)) {
10235
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10236
        virDispatchError(NULL);
10237
        return NULL;
10238 10239
    }
    if (flags != 0) {
10240
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10241
        goto error;
10242 10243 10244 10245
    }

    conn = vol->conn;

10246 10247 10248 10249 10250 10251 10252
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
10253

10254
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10255

10256
error:
10257
    virDispatchError(vol->conn);
10258
    return NULL;
10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277
}


/**
 * virStorageVolGetPath:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume path. Depending on the pool
 * configuration this is either persistent across hosts,
 * or dynamically assigned at pool startup. Consult
 * pool documentation for information on getting the
 * persistent naming
 *
 * Returns the storage volume path, or NULL on error
 */
char *
virStorageVolGetPath(virStorageVolPtr vol)
{
    virConnectPtr conn;
10278
    VIR_DEBUG("vol=%p", vol);
10279

10280 10281
    virResetLastError();

10282
    if (!VIR_IS_STORAGE_VOL(vol)) {
10283
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10284
        virDispatchError(NULL);
10285
        return NULL;
10286 10287 10288 10289
    }

    conn = vol->conn;

10290 10291 10292 10293 10294 10295 10296
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
10297

10298
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10299 10300

error:
10301
    virDispatchError(vol->conn);
10302 10303
    return NULL;
}
10304 10305


10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321
/**
 * 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)
{
10322
    VIR_DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
10323

10324 10325
    virResetLastError();

10326
    if (!VIR_IS_CONNECT(conn)) {
10327
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10328
        virDispatchError(NULL);
10329
        return -1;
10330 10331
    }
    if (flags != 0) {
10332
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10333
        goto error;
10334 10335
    }

10336 10337 10338 10339 10340 10341 10342
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10343

10344
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10345 10346

error:
10347
    virDispatchError(conn);
10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372
    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)
{
10373
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%d",
10374 10375
          conn, cap, names, maxnames, flags);

10376 10377
    virResetLastError();

10378
    if (!VIR_IS_CONNECT(conn)) {
10379
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10380
        virDispatchError(NULL);
10381
        return -1;
10382 10383
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
10384
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10385
        goto error;
10386 10387
    }

10388 10389 10390 10391 10392 10393 10394
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10395

10396
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10397 10398

error:
10399
    virDispatchError(conn);
10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414
    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)
{
10415
    VIR_DEBUG("conn=%p, name=%p", conn, name);
10416

10417 10418
    virResetLastError();

10419
    if (!VIR_IS_CONNECT(conn)) {
10420
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10421
        virDispatchError(NULL);
10422 10423 10424 10425
        return NULL;
    }

    if (name == NULL) {
10426
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10427
        goto error;
10428 10429
    }

10430 10431 10432 10433 10434 10435 10436
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
10437

10438
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10439 10440

error:
10441
    virDispatchError(conn);
10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453
    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.
 *
10454
 * Returns the XML document, or NULL on error
10455 10456 10457
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
10458
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10459

10460 10461
    virResetLastError();

10462
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10463
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10464
        virDispatchError(NULL);
10465 10466 10467
        return NULL;
    }

10468
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetXMLDesc) {
10469
        char *ret;
10470
        ret = dev->conn->deviceMonitor->deviceGetXMLDesc(dev, flags);
10471 10472 10473 10474
        if (!ret)
            goto error;
        return ret;
    }
10475

10476
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10477 10478

error:
10479
    virDispatchError(dev->conn);
10480 10481 10482 10483 10484 10485 10486 10487
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
10488 10489 10490
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
10491 10492 10493
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
10494
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10495 10496

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10497
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10498
        virDispatchError(NULL);
10499 10500 10501 10502 10503 10504 10505 10506 10507 10508
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
10509 10510
 * Accessor for the parent of the device
 *
10511 10512 10513 10514 10515
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
10516
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10517

10518 10519
    virResetLastError();

10520
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10521
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10522
        virDispatchError(NULL);
10523 10524 10525
        return NULL;
    }

10526 10527 10528 10529
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
10530
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10531
            virDispatchError(dev->conn);
10532 10533 10534 10535
            return NULL;
        }
    }
    return dev->parent;
10536 10537 10538 10539 10540 10541
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
10542 10543
 * Accessor for the number of capabilities supported by the device.
 *
10544 10545 10546 10547
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
10548
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10549

10550 10551
    virResetLastError();

10552
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10553
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10554
        virDispatchError(NULL);
10555 10556 10557
        return -1;
    }

10558 10559 10560 10561 10562 10563 10564
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
10565

10566
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10567 10568

error:
10569
    virDispatchError(dev->conn);
10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586
    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)
{
10587
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
10588 10589
          dev, dev ? dev->conn : NULL, names, maxnames);

10590 10591
    virResetLastError();

10592
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10593
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10594
        virDispatchError(NULL);
10595 10596 10597
        return -1;
    }

10598 10599 10600 10601 10602 10603 10604
    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;
    }
10605

10606
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10607 10608

error:
10609
    virDispatchError(dev->conn);
10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624
    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)
{
10625
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10626

10627 10628
    virResetLastError();

10629
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10630
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10631
        virDispatchError(NULL);
10632
        return -1;
10633
    }
10634 10635
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
10636
        return -1;
10637
    }
10638
    return 0;
10639 10640 10641
}


10642 10643
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
10644
 * @dev: the dev to hold a reference on
10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655
 *
 * 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 已提交
10656 10657
 *
 * Returns 0 in case of success, -1 in case of failure.
10658 10659 10660 10661 10662
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
10663
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10664
        virDispatchError(NULL);
10665
        return -1;
10666 10667
    }
    virMutexLock(&dev->conn->lock);
10668
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
10669 10670 10671 10672 10673
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

10674
/**
D
Daniel Veillard 已提交
10675
 * virNodeDeviceDettach:
10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689
 * @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 已提交
10690 10691
 *
 * Returns 0 in case of success, -1 in case of failure.
10692 10693 10694 10695
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
10696
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10697 10698 10699 10700

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10701
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10702
        virDispatchError(NULL);
10703
        return -1;
10704 10705
    }

10706 10707 10708 10709 10710
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10711 10712 10713 10714 10715 10716 10717 10718
    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10719
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10720 10721

error:
10722
    virDispatchError(dev->conn);
10723
    return -1;
10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737
}

/**
 * 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 已提交
10738 10739
 *
 * Returns 0 in case of success, -1 in case of failure.
10740 10741 10742 10743
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
10744
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10745 10746 10747 10748

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10749
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10750
        virDispatchError(NULL);
10751
        return -1;
10752 10753
    }

10754 10755 10756 10757 10758
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10759 10760 10761 10762 10763 10764 10765 10766
    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10767
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10768 10769

error:
10770
    virDispatchError(dev->conn);
10771
    return -1;
10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787
}

/**
 * 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 已提交
10788 10789
 *
 * Returns 0 in case of success, -1 in case of failure.
10790 10791 10792 10793
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
10794
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10795 10796 10797 10798

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10799
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10800
        virDispatchError(NULL);
10801
        return -1;
10802 10803
    }

10804 10805 10806 10807 10808
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10809 10810 10811 10812 10813 10814 10815 10816
    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10817
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10818 10819

error:
10820
    virDispatchError(dev->conn);
10821
    return -1;
10822 10823
}

10824

10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845
/**
 * virNodeDeviceCreateXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: string containing an XML description of the device to be created
 * @flags: callers should always pass 0
 *
 * Create a new device on the VM host machine, for example, virtual
 * HBAs created using vport_create.
 *
 * Returns a node device object if successful, NULL in case of failure
 */
virNodeDevicePtr
virNodeDeviceCreateXML(virConnectPtr conn,
                       const char *xmlDesc,
                       unsigned int flags)
{
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10846
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10847
        virDispatchError(NULL);
10848 10849 10850 10851
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
10852
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10853 10854 10855 10856
        goto error;
    }

    if (xmlDesc == NULL) {
10857
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

10869
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10870 10871

error:
10872
    virDispatchError(conn);
10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888
    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)
{
10889
    VIR_DEBUG("dev=%p", dev);
10890 10891 10892 10893

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10894
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10895
        virDispatchError(NULL);
10896
        return -1;
10897 10898 10899
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
10900
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

10914
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10915 10916

error:
10917
    virDispatchError(dev->conn);
10918 10919 10920 10921
    return -1;
}


10922 10923 10924 10925 10926 10927 10928 10929 10930
/*
 * 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 已提交
10931
 * @freecb: optional function to deallocate opaque when not used anymore
10932
 *
10933 10934 10935 10936 10937 10938
 * 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
10939
 *
10940 10941
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
10942 10943
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
10944 10945 10946
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
10947 10948 10949 10950 10951
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
10952 10953
                              void *opaque,
                              virFreeCallback freecb)
10954
{
10955
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
10956
    virResetLastError();
10957 10958

    if (!VIR_IS_CONNECT(conn)) {
10959
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10960
        virDispatchError(NULL);
10961
        return -1;
10962 10963
    }
    if (cb == NULL) {
10964
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10965
        goto error;
10966 10967
    }

10968 10969 10970 10971 10972 10973 10974 10975
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

10976
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10977
error:
10978
    virDispatchError(conn);
10979 10980 10981 10982 10983 10984 10985 10986
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
10987 10988 10989 10990 10991 10992
 * 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
10993 10994 10995 10996 10997 10998 10999
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
11000
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
11001 11002

    virResetLastError();
11003 11004

    if (!VIR_IS_CONNECT(conn)) {
11005
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11006
        virDispatchError(NULL);
11007
        return -1;
11008 11009
    }
    if (cb == NULL) {
11010
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11011 11012 11013 11014 11015 11016 11017 11018
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
11019 11020
    }

11021
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11022
error:
11023
    virDispatchError(conn);
11024 11025
    return -1;
}
11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041

/**
 * 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)
{
11042
    VIR_DEBUG("secret=%p", secret);
11043 11044 11045 11046

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
11047
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11048
        virDispatchError(NULL);
11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069
        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)) {
11070
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11071
        virDispatchError(NULL);
11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

11085
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11086 11087

error:
11088
    virDispatchError(conn);
11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109
    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)) {
11110
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11111
        virDispatchError(NULL);
11112 11113 11114
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
11115
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127
        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;
    }

11128
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11129 11130

error:
11131
    virDispatchError(conn);
11132 11133 11134 11135
    return -1;
}

/**
11136 11137 11138
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
11139
 *
11140 11141
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
11142
 *
11143 11144
 * 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.
11145 11146
 */
virSecretPtr
11147
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
11148
{
11149
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
11150 11151 11152 11153

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11154
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11155
        virDispatchError(NULL);
11156
        return NULL;
11157 11158
    }
    if (uuid == NULL) {
11159
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11160 11161 11162
        goto error;
    }

11163 11164
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
11165
        virSecretPtr ret;
11166 11167
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
11168 11169 11170 11171
            goto error;
        return ret;
    }

11172
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11173 11174

error:
11175
    virDispatchError(conn);
11176 11177 11178
    return NULL;
}

11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193
/**
 * 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];
11194
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
11195 11196 11197 11198

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11199
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11200
        virDispatchError(NULL);
11201
        return NULL;
11202 11203
    }
    if (uuidstr == NULL) {
11204
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11205 11206
        goto error;
    }
11207 11208

    if (virUUIDParse(uuidstr, uuid) < 0) {
11209
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11210 11211 11212 11213 11214 11215
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
11216
    virDispatchError(conn);
11217 11218 11219 11220
    return NULL;
}


11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238
/**
 * 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)
{
11239
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
11240 11241 11242 11243

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11244
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11245
        virDispatchError(NULL);
11246
        return NULL;
11247 11248
    }
    if (usageID == NULL) {
11249
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

11262
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11263 11264

error:
11265
    virDispatchError(conn);
11266 11267 11268 11269
    return NULL;
}


11270 11271 11272 11273 11274 11275
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
11276
 * If XML specifies a UUID, locates the specified secret and replaces all
11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292
 * attributes of the secret specified by UUID by attributes specified in xml
 * (any attributes not specified in xml are discarded).
 *
 * Otherwise, creates a new secret with an automatically chosen UUID, and
 * initializes its attributes from xml.
 *
 * Returns a the secret on success, NULL on failure.
 */
virSecretPtr
virSecretDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
    VIR_DEBUG("conn=%p, xml=%s, flags=%u", conn, xml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11293
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11294
        virDispatchError(NULL);
11295 11296 11297
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
11298
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11299 11300 11301
        goto error;
    }
    if (xml == NULL) {
11302
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314
        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;
    }

11315
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11316 11317

error:
11318
    virDispatchError(conn);
11319 11320 11321 11322
    return NULL;
}

/**
11323
 * virSecretGetUUID:
11324
 * @secret: A virSecret secret
11325
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
11326 11327 11328
 *
 * Fetches the UUID of the secret.
 *
11329 11330
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
11331
 */
11332 11333
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
11334 11335 11336 11337 11338 11339
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11340
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11341
        virDispatchError(NULL);
11342 11343 11344
        return -1;
    }
    if (uuid == NULL) {
11345
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11346
        virDispatchError(secret->conn);
11347
        return -1;
11348 11349
    }

11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368
    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];
11369
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
11370 11371

    virResetLastError();
11372

11373
    if (!VIR_IS_SECRET(secret)) {
11374
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11375
        virDispatchError(NULL);
11376
        return -1;
11377 11378
    }
    if (buf == NULL) {
11379
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11380 11381 11382 11383 11384 11385 11386
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
11387
    return 0;
11388 11389

error:
11390
    virDispatchError(secret->conn);
11391
    return -1;
11392 11393
}

11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409
/**
 * 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)
{
11410
    VIR_DEBUG("secret=%p", secret);
11411 11412 11413 11414

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
11415
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11416
        virDispatchError(NULL);
11417
        return -1;
11418
    }
11419
    return secret->usageType;
11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440
}

/**
 * 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)
{
11441
    VIR_DEBUG("secret=%p", secret);
11442 11443 11444 11445

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
11446
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11447
        virDispatchError(NULL);
11448
        return NULL;
11449
    }
11450
    return secret->usageID;
11451 11452
}

11453

11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473
/**
 * virSecretGetXMLDesc:
 * @secret: A virSecret secret
 * @flags: flags, use 0 for now
 *
 * Fetches an XML document describing attributes of the secret.
 *
 * Returns the XML document on success, NULL on failure.  The caller must
 * free() the XML.
 */
char *
virSecretGetXMLDesc(virSecretPtr secret, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, flags=%u", secret, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11474
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11475
        virDispatchError(NULL);
11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488
        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;
    }

11489
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11490 11491

error:
11492
    virDispatchError(conn);
11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518
    return NULL;
}

/**
 * virSecretSetValue:
 * @secret: A virSecret secret
 * @value: Value of the secret
 * @value_size: Size of the value
 * @flags: flags, use 0 for now
 *
 * Sets the value of a secret.
 *
 * Returns 0 on success, -1 on failure.
 */
int
virSecretSetValue(virSecretPtr secret, const unsigned char *value,
                  size_t value_size, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, value=%p, value_size=%zu, flags=%u", secret, value,
              value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11519
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11520
        virDispatchError(NULL);
11521 11522 11523 11524
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11525
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11526 11527 11528
        goto error;
    }
    if (value == NULL) {
11529
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541
        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;
    }

11542
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11543 11544

error:
11545
    virDispatchError(conn);
11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569
    return -1;
}

/**
 * virSecretGetValue:
 * @secret: A virSecret connection
 * @value_size: Place for storing size of the secret value
 * @flags: flags, use 0 for now
 *
 * Fetches the value of a secret.
 *
 * Returns the secret value on success, NULL on failure.  The caller must
 * free() the secret value.
 */
unsigned char *
virSecretGetValue(virSecretPtr secret, size_t *value_size, unsigned int flags)
{
    virConnectPtr conn;

    VIR_DEBUG("secret=%p, value_size=%p, flags=%u", secret, value_size, flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11570
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11571
        virDispatchError(NULL);
11572 11573 11574 11575
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11576
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11577 11578 11579
        goto error;
    }
    if (value_size == NULL) {
11580
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11581 11582 11583
        goto error;
    }

11584 11585
    flags &= VIR_SECRET_GET_VALUE_FLAGS_MASK;

11586 11587 11588 11589 11590 11591 11592 11593 11594
    if (conn->secretDriver != NULL && conn->secretDriver->getValue != NULL) {
        unsigned char *ret;

        ret = conn->secretDriver->getValue(secret, value_size, flags);
        if (ret == NULL)
            goto error;
        return ret;
    }

11595
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11596 11597

error:
11598
    virDispatchError(conn);
11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620
    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)) {
11621
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11622
        virDispatchError(NULL);
11623 11624 11625 11626
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11627
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

11640
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11641 11642

error:
11643
    virDispatchError(conn);
11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666
    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)) {
11667
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11668
        virDispatchError(NULL);
11669 11670 11671
        return -1;
    }
    virMutexLock(&secret->conn->lock);
11672
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
11684
 * Returns 0 on success, or -1 on error
11685 11686 11687 11688
 */
int
virSecretFree(virSecretPtr secret)
{
11689
    VIR_DEBUG("secret=%p", secret);
11690 11691 11692 11693

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11694
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11695
        virDispatchError(NULL);
11696 11697
        return -1;
    }
11698 11699
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
11700
        return -1;
11701
    }
11702 11703
    return 0;
}
11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730


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

11731
    VIR_DEBUG("conn=%p, flags=%u", conn, flags);
11732 11733 11734 11735

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11736
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11737
        virDispatchError(NULL);
11738
        return NULL;
11739 11740 11741 11742 11743
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;
11744 11745
    else
        virDispatchError(conn);
11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765

    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))) {
11766
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11767
        virDispatchError(NULL);
11768
        return -1;
11769 11770
    }
    virMutexLock(&stream->conn->lock);
11771
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786
    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
11787
 * it should call virStreamFinish to wait for successful
11788 11789 11790 11791 11792 11793 11794 11795 11796
 * confirmation from the driver, or detect any error
 *
 * This method may not be used if a stream source has been
 * registered
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
11797
 * An example using this with a hypothetical file upload
11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845
 * 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)
{
11846
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
11847 11848 11849 11850

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11851
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11852
        virDispatchError(NULL);
11853
        return -1;
11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866
    }

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

11867
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11868 11869

error:
11870
    virDispatchError(stream->conn);
11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888
    return -1;
}


/**
 * virStreamRecv:
 * @stream: pointer to the stream object
 * @data: buffer to write to stream
 * @nbytes: size of @data buffer
 *
 * Write a series of bytes to the stream. This method may
 * block the calling application for an arbitrary amount
 * of time.
 *
 * Errors are not guaranteed to be reported synchronously
 * with the call, but may instead be delayed until a
 * subsequent call.
 *
D
Dan Kenigsberg 已提交
11889
 * An example using this with a hypothetical file download
11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940
 * 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)
{
11941
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
11942 11943 11944 11945

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11946
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11947
        virDispatchError(NULL);
11948
        return -1;
11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961
    }

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

11962
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11963 11964

error:
11965
    virDispatchError(stream->conn);
11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979
    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 已提交
11980
 * An example using this with a hypothetical file upload
11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001
 * 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);
 *
12002
 * Returns 0 if all the data was successfully sent. The caller
12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016
 * 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;
12017
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
12018 12019 12020 12021

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12022
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12023
        virDispatchError(NULL);
12024
        return -1;
12025 12026 12027
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
12028
        virLibConnError(VIR_ERR_OPERATION_INVALID,
12029 12030 12031 12032 12033
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
12034
        virReportOOMError();
12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060
        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)
12061
        virDispatchError(stream->conn);
12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076

    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 已提交
12077
 * An example using this with a hypothetical file download
12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098
 * 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);
 *
12099
 * Returns 0 if all the data was successfully received. The caller
12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113
 * 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;
12114
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
12115 12116 12117 12118

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12119
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12120
        virDispatchError(NULL);
12121
        return -1;
12122 12123 12124
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
12125
        virLibConnError(VIR_ERR_OPERATION_INVALID,
12126 12127 12128 12129 12130 12131
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
12132
        virReportOOMError();
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
        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)
12159
        virDispatchError(stream->conn);
12160 12161 12162 12163 12164 12165

    return ret;
}


/**
M
Matthias Bolte 已提交
12166
 * virStreamEventAddCallback:
12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185
 * @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)
{
12186
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
12187 12188 12189 12190

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12191
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12192
        virDispatchError(NULL);
12193
        return -1;
12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

12205
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12206 12207

error:
12208
    virDispatchError(stream->conn);
12209 12210 12211 12212 12213
    return -1;
}


/**
M
Matthias Bolte 已提交
12214
 * virStreamEventUpdateCallback:
12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227
 * @stream: pointer to the stream object
 * @events: set of events to monitor
 *
 * Changes the set of events to monitor for a stream. This allows
 * for event notification to be changed without having to
 * unregister & register the callback completely. This method
 * is guarenteed to succeed if a callback is already registered
 *
 * Returns 0 on success, -1 if no callback is registered
 */
int virStreamEventUpdateCallback(virStreamPtr stream,
                                 int events)
{
12228
    VIR_DEBUG("stream=%p, events=%d", stream, events);
12229 12230 12231 12232

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12233
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12234
        virDispatchError(NULL);
12235
        return -1;
12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

12247
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12248 12249

error:
12250
    virDispatchError(stream->conn);
12251 12252 12253 12254
    return -1;
}

/**
M
Matthias Bolte 已提交
12255
 * virStreamEventRemoveCallback:
12256 12257
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
12258
 * Remove an event callback from the stream
12259 12260 12261 12262 12263
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
12264
    VIR_DEBUG("stream=%p", stream);
12265 12266 12267 12268

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12269
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12270
        virDispatchError(NULL);
12271
        return -1;
12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

12283
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12284 12285

error:
12286
    virDispatchError(stream->conn);
12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306
    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)
{
12307
    VIR_DEBUG("stream=%p", stream);
12308 12309 12310 12311

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12312
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12313
        virDispatchError(NULL);
12314
        return -1;
12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

12326
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12327 12328

error:
12329
    virDispatchError(stream->conn);
12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347
    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)
{
12348
    VIR_DEBUG("stream=%p", stream);
12349 12350 12351 12352

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12353
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12354
        virDispatchError(NULL);
12355
        return -1;
12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366
    }

    if (stream->driver &&
        stream->driver->streamAbort) {
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

12367
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12368 12369

error:
12370
    virDispatchError(stream->conn);
12371 12372 12373 12374 12375 12376 12377 12378 12379 12380
    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 已提交
12381
 * There must not be an active data transfer in progress
12382 12383 12384 12385 12386 12387 12388 12389
 * 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)
{
12390
    VIR_DEBUG("stream=%p", stream);
12391 12392 12393 12394

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12395
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12396
        virDispatchError(NULL);
12397
        return -1;
12398 12399 12400 12401
    }

    /* XXX Enforce shutdown before free'ing resources ? */

12402 12403
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
12404
        return -1;
12405
    }
12406
    return 0;
12407
}
12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419


/**
 * 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)
{
12420
    VIR_DEBUG("dom=%p", dom);
12421 12422 12423 12424

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12425
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12426
        virDispatchError(NULL);
12427
        return -1;
12428 12429 12430 12431 12432 12433 12434 12435 12436
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

12437
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12438
error:
12439
    virDispatchError(dom->conn);
12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453
    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)
{
12454
    VIR_DOMAIN_DEBUG(dom);
12455 12456 12457 12458

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12459
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12460
        virDispatchError(NULL);
12461
        return -1;
12462 12463 12464 12465 12466 12467 12468 12469 12470
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

12471
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12472
error:
12473
    virDispatchError(dom->conn);
12474 12475 12476
    return -1;
}

12477 12478 12479 12480 12481 12482 12483 12484 12485 12486
/**
 * 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)
{
12487
    VIR_DOMAIN_DEBUG(dom);
12488 12489 12490 12491

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12492
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12493
        virDispatchError(NULL);
12494
        return -1;
12495 12496 12497 12498 12499 12500 12501 12502 12503
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

12504
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12505 12506 12507 12508 12509
error:
    virDispatchError(dom->conn);
    return -1;
}

12510 12511 12512 12513 12514 12515 12516 12517 12518 12519
/**
 * 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)
{
12520
    VIR_DEBUG("net=%p", net);
12521 12522 12523 12524

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
12525
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12526
        virDispatchError(NULL);
12527
        return -1;
12528 12529 12530 12531 12532 12533 12534 12535 12536
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

12537
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12538
error:
12539
    virDispatchError(net->conn);
12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554
    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)
{
12555
    VIR_DEBUG("net=%p", net);
12556 12557 12558 12559

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
12560
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12561
        virDispatchError(NULL);
12562
        return -1;
12563 12564 12565 12566 12567 12568 12569 12570 12571
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

12572
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12573
error:
12574
    virDispatchError(net->conn);
12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588
    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)
{
12589
    VIR_DEBUG("pool=%p", pool);
12590 12591 12592 12593

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
12594
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12595
        virDispatchError(NULL);
12596
        return -1;
12597 12598 12599 12600 12601 12602 12603 12604 12605
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

12606
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12607
error:
12608
    virDispatchError(pool->conn);
12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623
    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)
{
12624
    VIR_DEBUG("pool=%p", pool);
12625 12626 12627 12628

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
12629
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12630
        virDispatchError(NULL);
12631
        return -1;
12632 12633 12634 12635 12636 12637 12638 12639 12640
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

12641
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12642
error:
12643
    virDispatchError(pool->conn);
12644 12645 12646 12647
    return -1;
}


S
Stefan Berger 已提交
12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659

/**
 * 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)
{
12660
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
12661 12662 12663 12664

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12665
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677
        virDispatchError(NULL);
        return -1;
    }

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

12678
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698

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)
{
12699
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
12700 12701 12702 12703

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12704
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12705 12706 12707 12708 12709
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
12710
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721
        goto error;
    }

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

12722
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742

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)
{
12743
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
12744 12745 12746 12747

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12748
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12749
        virDispatchError(NULL);
12750
        return NULL;
S
Stefan Berger 已提交
12751 12752
    }
    if (name == NULL) {
12753
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

12765
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784

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)
{
12785
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
S
Stefan Berger 已提交
12786 12787 12788 12789

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12790
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12791
        virDispatchError(NULL);
12792
        return NULL;
S
Stefan Berger 已提交
12793 12794
    }
    if (uuid == NULL) {
12795
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

12807
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12808 12809 12810 12811 12812 12813 12814

error:
    virDispatchError(conn);
    return NULL;
}

/**
12815
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827
 * @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];
12828
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
S
Stefan Berger 已提交
12829 12830 12831 12832

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12833
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12834
        virDispatchError(NULL);
12835
        return NULL;
S
Stefan Berger 已提交
12836 12837
    }
    if (uuidstr == NULL) {
12838
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12839 12840 12841 12842
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
12843
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865
        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)
{
12866
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12867 12868 12869 12870

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
12871
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893
        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)
{
12894
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12895 12896 12897 12898

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12899
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12900
        virDispatchError(NULL);
12901
        return NULL;
S
Stefan Berger 已提交
12902
    }
12903
    return nwfilter->name;
S
Stefan Berger 已提交
12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917
}

/**
 * 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)
{
12918
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
12919 12920 12921 12922

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12923
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12924 12925 12926 12927
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
12928
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954
        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];
12955
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
12956 12957 12958 12959

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12960
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12961 12962 12963 12964
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
12965
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993
        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)
{
12994
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
12995 12996 12997 12998

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12999
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
13000
        virDispatchError(NULL);
13001
        return NULL;
S
Stefan Berger 已提交
13002 13003
    }
    if (xmlDesc == NULL) {
13004
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13005 13006 13007
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
13008
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
13009 13010 13011 13012 13013
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
E
Eric Blake 已提交
13014
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc);
S
Stefan Berger 已提交
13015 13016 13017 13018 13019
        if (!ret)
            goto error;
        return ret;
    }

13020
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041

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;
13042
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
13043 13044 13045 13046

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
13047
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
13048 13049 13050 13051 13052 13053
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13054
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

13066
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088

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


/**
 * virNWFilterGetXMLDesc:
 * @nwfilter: a nwfilter object
 * @flags: an OR'ed set of extraction flags, not used yet
 *
 * Provide an XML description of the network filter. The description may be
 * reused later to redefine the network filter with virNWFilterCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, int flags)
{
    virConnectPtr conn;
13089
    VIR_DEBUG("nwfilter=%p, flags=%d", nwfilter, flags);
S
Stefan Berger 已提交
13090 13091 13092 13093

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
13094
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
13095
        virDispatchError(NULL);
13096
        return NULL;
S
Stefan Berger 已提交
13097 13098
    }
    if (flags != 0) {
13099
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112
        goto error;
    }

    conn = nwfilter->conn;

    if (conn->nwfilterDriver && conn->nwfilterDriver->getXMLDesc) {
        char *ret;
        ret = conn->nwfilterDriver->getXMLDesc (nwfilter, flags);
        if (!ret)
            goto error;
        return ret;
    }

13113
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141

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))) {
13142
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13143 13144 13145 13146
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
13147
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
13148 13149 13150 13151 13152 13153
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


13154 13155 13156 13157 13158 13159 13160 13161 13162 13163
/**
 * 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)
{
13164
    VIR_DEBUG("iface=%p", iface);
13165 13166 13167 13168

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
13169
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13170
        virDispatchError(NULL);
13171
        return -1;
13172 13173 13174 13175 13176 13177 13178 13179 13180
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

13181
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13182
error:
13183
    virDispatchError(iface->conn);
13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197
    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)
{
13198
    VIR_DEBUG("conn=%p", conn);
13199 13200 13201 13202

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13203
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13204
        virDispatchError(NULL);
13205
        return -1;
13206 13207 13208 13209 13210 13211 13212 13213 13214
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

13215
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13216
error:
13217
    virDispatchError(conn);
13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234
    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)
{
13235
    VIR_DEBUG("conn=%p", conn);
13236 13237 13238 13239

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13240
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13241
        virDispatchError(NULL);
13242
        return -1;
13243 13244 13245 13246 13247 13248 13249 13250 13251
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

13252
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13253
error:
13254
    virDispatchError(conn);
13255 13256
    return -1;
}
J
Jiri Denemark 已提交
13257 13258 13259 13260 13261


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
13262 13263 13264 13265
 * @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 已提交
13266 13267 13268 13269 13270 13271 13272 13273
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
13274
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%u", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
13275 13276 13277 13278

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13279
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13280
        virDispatchError(NULL);
J
Jiri Denemark 已提交
13281 13282 13283
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
13284
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296
        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;
    }

13297
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
13298 13299

error:
13300
    virDispatchError(conn);
J
Jiri Denemark 已提交
13301 13302
    return VIR_CPU_COMPARE_ERROR;
}
13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335


/**
 * virConnectBaselineCPU:
 *
 * @conn: virConnect connection
 * @xmlCPUs: array of XML descriptions of host CPUs
 * @ncpus: number of CPUs in xmlCPUs
 * @flags: fine-tuning flags, currently unused, pass 0.
 *
 * Computes the most feature-rich CPU which is compatible with all given
 * host CPUs.
 *
 * Returns XML description of the computed CPU or NULL on error.
 */
char *
virConnectBaselineCPU(virConnectPtr conn,
                      const char **xmlCPUs,
                      unsigned int ncpus,
                      unsigned int flags)
{
    unsigned int i;

    VIR_DEBUG("conn=%p, xmlCPUs=%p, ncpus=%u, flags=%u",
              conn, xmlCPUs, ncpus, flags);
    if (xmlCPUs) {
        for (i = 0; i < ncpus; i++)
            VIR_DEBUG("xmlCPUs[%u]=%s", i, NULLSTR(xmlCPUs[i]));
    }

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13336
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13337 13338 13339 13340
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
13341
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353
        goto error;
    }

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

13354
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13355 13356 13357 13358 13359

error:
    virDispatchError(conn);
    return NULL;
}
13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375


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

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
13378 13379 13380 13381

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13382
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13383
        virDispatchError(NULL);
13384
        return -1;
13385 13386
    }
    if (info == NULL) {
13387
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402
        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;
    }

13403
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13404 13405 13406 13407 13408

error:
    virDispatchError(domain->conn);
    return -1;
}
13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425


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

13426
    VIR_DOMAIN_DEBUG(domain);
13427 13428 13429 13430

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13431
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13432
        virDispatchError(NULL);
13433
        return -1;
13434 13435 13436 13437
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13438
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449
        goto error;
    }

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

13450
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13451 13452 13453 13454 13455

error:
    virDispatchError(conn);
    return -1;
}
13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476


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

13477
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%u", downtime, flags);
13478 13479 13480 13481

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13482
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13483 13484 13485 13486 13487 13488
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13489
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13490 13491 13492 13493 13494 13495 13496 13497 13498
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

13499
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13500 13501 13502 13503 13504
error:
    virDispatchError(conn);
    return -1;
}

13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551
/**
 * 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;

    VIR_DOMAIN_DEBUG(domain, "bandwidth=%lu, flags=%u", bandwidth, 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->domainMigrateSetMaxSpeed) {
        if (conn->driver->domainMigrateSetMaxSpeed(domain, bandwidth, flags) < 0)
            goto error;
        return 0;
    }

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573
/**
 * 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.
13574 13575
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592
 * 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)
{
13593 13594 13595
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

13596 13597 13598
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13599
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13600
        virDispatchError(NULL);
13601
        return -1;
13602 13603 13604
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
13605
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13606
        virDispatchError(conn);
13607
        return -1;
13608 13609
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
13610
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621
        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;
    }

13622
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13623 13624 13625 13626
error:
    virDispatchError(conn);
    return -1;
}
13627

13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641
/**
 * 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)
{
13642
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
13643 13644 13645 13646

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13647
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13648
        virDispatchError(NULL);
13649
        return -1;
13650 13651
    }
    if (callbackID < 0) {
13652
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13653 13654 13655 13656 13657 13658 13659 13660 13661 13662
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

13663
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13664 13665 13666 13667
error:
    virDispatchError(conn);
    return -1;
}
13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687

/**
 * virDomainManagedSave:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
 * This method will suspend a domain and save its memory contents to
 * a file on disk. After the call, if successful, the domain is not
 * listed as running anymore.
 * The difference from virDomainSave() is that libvirt is keeping track of
 * the saved state itself, and will reuse it once the domain is being
 * restarted (automatically or via an explicit libvirt call).
 * As a result any running domain is sure to not have a managed saved image.
 *
 * Returns 0 in case of success or -1 in case of failure
 */
int virDomainManagedSave(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

13688
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
13689 13690 13691 13692

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
13693
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13694 13695 13696 13697 13698 13699
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13700
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712
        goto error;
    }

    if (conn->driver->domainManagedSave) {
        int ret;

        ret = conn->driver->domainManagedSave(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

13713
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735

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;

13736
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
13737 13738 13739 13740

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
13741
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756
        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;
    }

13757
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
13769
 * Remove any managed save image for this domain.
13770 13771 13772 13773 13774 13775 13776
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

13777
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
13778 13779 13780 13781

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
13782
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13783 13784 13785 13786 13787 13788
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13789
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801
        goto error;
    }

    if (conn->driver->domainManagedSaveRemove) {
        int ret;

        ret = conn->driver->domainManagedSaveRemove(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

13802
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13803 13804 13805 13806 13807

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826

/**
 * virDomainSnapshotCreateXML:
 * @domain: a domain object
 * @xmlDesc: string containing an XML description of the domain
 * @flags: unused flag parameters; callers should pass 0
 *
 * Creates a new snapshot of a domain based on the snapshot xml
 * contained in xmlDesc.
 *
 * Returns an (opaque) virDomainSnapshotPtr on success, NULL on failure.
 */
virDomainSnapshotPtr
virDomainSnapshotCreateXML(virDomainPtr domain,
                           const char *xmlDesc,
                           unsigned int flags)
{
    virConnectPtr conn;

13827
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%u", xmlDesc, flags);
C
Chris Lalancette 已提交
13828 13829 13830 13831

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13832
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13833 13834 13835 13836 13837 13838
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13839
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850
        goto error;
    }

    if (conn->driver->domainSnapshotCreateXML) {
        virDomainSnapshotPtr ret;
        ret = conn->driver->domainSnapshotCreateXML(domain, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }

13851
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotGetXMLDesc:
 * @snapshot: a domain snapshot object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Provide an XML description of the domain snapshot.
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,
                            unsigned int flags)
{
    virConnectPtr conn;
13872
    VIR_DEBUG("snapshot=%p, flags=%d", snapshot, flags);
C
Chris Lalancette 已提交
13873 13874 13875 13876

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13877
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13878 13879
                                  __FUNCTION__);
        virDispatchError(NULL);
13880
        return NULL;
C
Chris Lalancette 已提交
13881 13882 13883 13884 13885
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
13886
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
13887 13888 13889 13890
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

13891
    if (conn->driver->domainSnapshotGetXMLDesc) {
C
Chris Lalancette 已提交
13892
        char *ret;
13893
        ret = conn->driver->domainSnapshotGetXMLDesc(snapshot, flags);
C
Chris Lalancette 已提交
13894 13895 13896 13897 13898
        if (!ret)
            goto error;
        return ret;
    }

13899
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917
error:
    virDispatchError(conn);
    return NULL;
}

/**
 * virDomainSnapshotNum:
 * @domain: a domain object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Provides the number of domain snapshots for this domain..
 *
 * Returns the number of domain snapshost found or -1 in case of error.
 */
int
virDomainSnapshotNum(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
13918

13919
    VIR_DOMAIN_DEBUG(domain);
C
Chris Lalancette 已提交
13920 13921 13922 13923

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13924
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936
        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;
    }

13937
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotListNames:
 * @domain: a domain object
 * @names: array to collect the list of names of snapshots
 * @nameslen: size of @names
 * @flags: unused flag parameters; callers should pass 0
 *
 * Collect the list of domain snapshots for the given domain, and store
 * their names in @names.  Caller is responsible for freeing each member
 * of the array.
 *
 * Returns the number of domain snapshots found or -1 in case of error.
 */
int
virDomainSnapshotListNames(virDomainPtr domain, char **names, int nameslen,
                           unsigned int flags)
{
    virConnectPtr conn;

13962 13963
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%u",
                     names, nameslen, flags);
C
Chris Lalancette 已提交
13964 13965 13966 13967

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13968
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13969 13970 13971 13972 13973 13974 13975
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
13976
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987
        goto error;
    }

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

13988
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011
error:
    virDispatchError(conn);
    return -1;
}

/**
 * virDomainSnapshotLookupByName:
 * @domain: a domain object
 * @name: name for the domain snapshot
 * @flags: unused flag parameters; callers should pass 0
 *
 * Try to lookup a domain snapshot based on its name.
 *
 * Returns a domain snapshot object or NULL in case of failure.  If the
 * domain snapshot cannot be found, then the VIR_ERR_NO_DOMAIN_SNAPSHOT
 * error is raised.
 */
virDomainSnapshotPtr
virDomainSnapshotLookupByName(virDomainPtr domain,
                              const char *name,
                              unsigned int flags)
{
    virConnectPtr conn;
14012 14013

    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%u", name, flags);
C
Chris Lalancette 已提交
14014 14015 14016 14017

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14018
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14019
        virDispatchError(NULL);
14020
        return NULL;
C
Chris Lalancette 已提交
14021 14022 14023 14024 14025
    }

    conn = domain->conn;

    if (name == NULL) {
14026
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037
        goto error;
    }

    if (conn->driver->domainSnapshotLookupByName) {
        virDomainSnapshotPtr dom;
        dom = conn->driver->domainSnapshotLookupByName(domain, name, flags);
        if (!dom)
            goto error;
        return dom;
    }

14038
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056
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;
14057 14058

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
14059 14060 14061 14062

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14063
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076
        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;
    }

14077
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098
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;
14099 14100

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
14101 14102 14103 14104

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14105
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14106
        virDispatchError(NULL);
14107
        return NULL;
C
Chris Lalancette 已提交
14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

14120
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14121 14122 14123 14124 14125 14126
error:
    virDispatchError(conn);
    return NULL;
}

/**
14127
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140
 * @snapshot: a domain snapshot object
 * @flags: unused flag parameters; callers should pass 0
 *
 * Revert the domain to a given snapshot.
 *
 * Returns 0 if the creation is successful, -1 on error.
 */
int
virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot,
                          unsigned int flags)
{
    virConnectPtr conn;

14141
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
14142 14143 14144 14145

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
14146
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
14147 14148 14149 14150 14151 14152
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
14153 14154 14155 14156
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
14157 14158 14159 14160 14161 14162 14163 14164

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

14165
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14166 14167 14168 14169 14170 14171
error:
    virDispatchError(conn);
    return -1;
}

/**
14172
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190
 * @snapshot: a domain snapshot object
 * @flags: flag parameters
 *
 * Delete the snapshot.
 *
 * If @flags is 0, then just this snapshot is deleted, and changes from
 * this snapshot are automatically merged into children snapshots.  If
 * flags is VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN, then this snapshot
 * and any children snapshots are deleted.
 *
 * Returns 0 if the snapshot was successfully deleted, -1 on error.
 */
int
virDomainSnapshotDelete(virDomainSnapshotPtr snapshot,
                        unsigned int flags)
{
    virConnectPtr conn;

14191
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
14192 14193 14194 14195

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
14196
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
14197 14198 14199 14200 14201 14202
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
14203 14204 14205 14206
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
14207 14208 14209 14210 14211 14212 14213 14214

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

14215
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232
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)
{
14233
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
14234 14235 14236 14237

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
14238
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
14239 14240 14241 14242 14243 14244 14245 14246 14247 14248
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271

/**
 * virDomainOpenConsole:
 * @dom: a domain object
 * @devname: the console, serial or parallel port device alias, or NULL
 * @st: a stream to associate with the console
 * @flags: unused, pass 0
 *
 * This opens the backend associated with a console, serial or
 * parallel port device on a guest, if the backend is supported.
 * If the @devname is omitted, then the first console or serial
 * device is opened. The console is associated with the passed
 * in @st stream, which should have been opened in non-blocking
 * mode for bi-directional I/O.
 *
 * returns 0 if the console was opened, -1 on error
 */
int virDomainOpenConsole(virDomainPtr dom,
                         const char *devname,
                         virStreamPtr st,
                         unsigned int flags)
{
    virConnectPtr conn;
14272 14273 14274

    VIR_DOMAIN_DEBUG(dom, "devname=%s, st=%p, flags=%u",
                     NULLSTR(devname), st, flags);
14275 14276 14277 14278

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
14279
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
14280 14281 14282 14283 14284 14285
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
14286
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
        ret = conn->driver->domainOpenConsole(dom, devname, st, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

14298
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14299 14300 14301 14302 14303

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