libvirt.c 382.6 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_CONN, __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
/*
 * 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)
{
4494 4495
    VIR_DEBUG("conn=%p, stream=%p, flags=%lu, dname=%s, "
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
4496 4497 4498 4499 4500
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

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

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

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

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

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

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

4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 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
/*
 * 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 已提交
4856

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

4871 4872
    virResetLastError();

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

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

4891
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4892 4893

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

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

4913 4914
    virResetLastError();

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

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

4930
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4931 4932

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

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

4952 4953
    virResetLastError();

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

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

4968
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4969 4970

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

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

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

4993 4994
    virResetLastError();

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

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

5009
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5010 5011

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


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
5020
 * @params: pointer to scheduler parameter objects
5021
 *          (return value)
5022 5023
 * @nparams: pointer to number of scheduler parameter objects
 *          (this value must be at least as large as the returned value
5024 5025
 *           nparams of virDomainGetSchedulerType)
 *
5026 5027 5028
 * 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.
5029 5030 5031 5032 5033
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
5034
                                virSchedParameterPtr params, int *nparams)
5035 5036
{
    virConnectPtr conn;
5037 5038

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

5040 5041
    virResetLastError();

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

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

5053 5054
    conn = domain->conn;

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

5063
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5064 5065

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

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

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

5090 5091
    virResetLastError();

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

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

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

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

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

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


/**
 * virDomainSetSchedulerParametersFlags:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
5129 5130
 * @nparams: number of scheduler parameter objects
 *          (this value can be the same or less than the returned value
5131 5132 5133
 *           nparams of virDomainGetSchedulerType)
 * @flags: virDomainSchedParameterFlags
 *
5134
 * Change a subset or all scheduler parameters.
5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163
 *
 * 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;
    }
5164 5165 5166 5167 5168 5169

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

5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187
    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__);
5188 5189

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


5195
/**
5196
 * virDomainBlockStats:
5197 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
 * @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 };
5224 5225

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

5227 5228
    virResetLastError();

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

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

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

5248
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5249 5250

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

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

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

5287 5288
    virResetLastError();

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

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

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

5308
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5309 5310

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

5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349
/**
 * 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;
5350 5351

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

    virResetLastError();

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

5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379
    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;
    }

5380
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5381 5382

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

R
Richard W.M. Jones 已提交
5387 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
/**
 * 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 已提交
5420 5421 5422 5423
 * 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 已提交
5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434
 * 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;
5435 5436 5437

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

5439 5440
    virResetLastError();

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

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

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

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

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

5472 5473 5474 5475 5476 5477 5478 5479
    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 已提交
5480

5481
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5482 5483

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

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

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

5531 5532
    virResetLastError();

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

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

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

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

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

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

5590
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5591 5592

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

5597

5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612
/**
 * 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;
5613 5614

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

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5619
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5620
        virDispatchError(NULL);
5621
        return -1;
5622
    }
5623
    if (path == NULL || info == NULL) {
5624
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639
        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;
    }

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

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


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

5670 5671
    virResetLastError();

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

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

5694
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5695 5696

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

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

5713
    VIR_DOMAIN_DEBUG(domain);
5714

5715 5716
    virResetLastError();

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

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

5736
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5737 5738

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

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

5756 5757
    virResetLastError();

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

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

5772
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5773 5774

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

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

5795 5796
    virResetLastError();

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

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

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

5816
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5817 5818

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

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

5836
    VIR_DOMAIN_DEBUG(domain);
5837

5838 5839
    virResetLastError();

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

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

5859
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5860 5861

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

5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878
/**
 * 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;
5879 5880

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

    virResetLastError();

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

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

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

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

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

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

5929 5930 5931
    virResetLastError();

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

5941 5942
    conn = domain->conn;

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

5951
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5952 5953

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

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

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

5976 5977 5978
    virResetLastError();

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

5984 5985
    conn = domain->conn;

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

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

5999
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6000 6001

error:
6002
    virDispatchError(domain->conn);
6003
    return -1;
6004 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
/**
 * 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;
}

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

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

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

6075 6076
    virResetLastError();

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

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

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

6101
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6102 6103

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

E
Eric Blake 已提交
6108 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
/**
 * 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;
6139 6140

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

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6145
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
6146
        virDispatchError(NULL);
6147
        return -1;
E
Eric Blake 已提交
6148 6149
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
6150
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
6151 6152 6153 6154 6155 6156
        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) {
6157
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169
        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;
    }

6170
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
6171 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

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;
6203 6204

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

    virResetLastError();

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

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

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

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

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

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

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

6266 6267
    virResetLastError();

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

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

6283 6284
    conn = domain->conn;

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

6293
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6294 6295

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

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

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

6331 6332
    virResetLastError();

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

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

6351 6352
    conn = domain->conn;

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

6362
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6363 6364

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

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

6386
    VIR_DOMAIN_DEBUG(domain);
6387

6388 6389
    virResetLastError();

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

    conn = domain->conn;

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

6406
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6407 6408

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

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

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

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

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

    conn = domain->conn;

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

6452
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6453

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

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

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

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

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

6494
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6495

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

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

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

6522 6523
    virResetLastError();

6524
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6525
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
6526
        virDispatchError(NULL);
6527
        return -1;
6528
    }
6529 6530 6531 6532 6533 6534

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

6535
    if (domain->conn->flags & VIR_CONNECT_RO) {
6536
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6537
        goto error;
6538 6539 6540
    }
    conn = domain->conn;

6541
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
6542 6543 6544 6545 6546 6547 6548
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

6549
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573

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.
 *
6574 6575 6576 6577
 * 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 已提交
6578 6579 6580 6581 6582 6583 6584
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
6585 6586

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
6587 6588 6589 6590

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6591
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
6592
        virDispatchError(NULL);
6593
        return -1;
J
Jim Fehlig 已提交
6594
    }
6595 6596 6597 6598 6599 6600

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

J
Jim Fehlig 已提交
6601
    if (domain->conn->flags & VIR_CONNECT_RO) {
6602
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
6603 6604 6605 6606 6607
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
6608
        int ret;
J
Jim Fehlig 已提交
6609
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
6610 6611 6612 6613
        if (ret < 0)
            goto error;
        return ret;
    }
6614

6615
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6616 6617

error:
6618
    virDispatchError(domain->conn);
6619
    return -1;
6620 6621 6622 6623 6624 6625
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
6626
 *
6627 6628
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
6629 6630 6631 6632
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
6633
virDomainDetachDevice(virDomainPtr domain, const char *xml)
6634 6635
{
    virConnectPtr conn;
6636 6637

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

6639 6640
    virResetLastError();

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

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

6652
    if (domain->conn->flags & VIR_CONNECT_RO) {
6653
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6654
        goto error;
6655 6656 6657
    }
    conn = domain->conn;

6658 6659 6660
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
6661 6662 6663 6664 6665
         if (ret < 0)
             goto error;
         return ret;
     }

6666
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697

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;
6698 6699

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
6700 6701 6702 6703

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6704
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
6705
        virDispatchError(NULL);
6706
        return -1;
J
Jim Fehlig 已提交
6707
    }
6708 6709 6710 6711 6712 6713

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

J
Jim Fehlig 已提交
6714
    if (domain->conn->flags & VIR_CONNECT_RO) {
6715
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
6716 6717 6718 6719 6720 6721 6722
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
6723 6724 6725 6726 6727
        if (ret < 0)
            goto error;
        return ret;
    }

6728
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763

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;
6764 6765

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
6766 6767 6768 6769

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
6770
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
6771
        virDispatchError(NULL);
6772
        return -1;
6773
    }
6774 6775 6776 6777 6778 6779

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

6780
    if (domain->conn->flags & VIR_CONNECT_RO) {
6781
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6782 6783 6784 6785 6786 6787 6788
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
6789 6790 6791 6792
        if (ret < 0)
            goto error;
        return ret;
    }
6793

6794
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6795 6796

error:
6797
    virDispatchError(domain->conn);
6798
    return -1;
6799
}
6800

6801 6802 6803 6804 6805 6806 6807 6808 6809 6810
/**
 * 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
6811
 * with the amount of free memory in bytes for each cell requested,
6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822
 * 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)
{
6823
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
6824 6825
          conn, freeMems, startCell, maxCells);

6826 6827
    virResetLastError();

6828
    if (!VIR_IS_CONNECT(conn)) {
6829
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6830
        virDispatchError(NULL);
6831
        return -1;
6832 6833
    }

D
Daniel Veillard 已提交
6834
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
6835
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6836
        goto error;
6837 6838
    }

6839 6840 6841 6842 6843 6844 6845
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
6846

6847
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6848 6849

error:
6850
    virDispatchError(conn);
6851 6852 6853
    return -1;
}

6854 6855 6856 6857
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
6858
 * Provides the connection pointer associated with a network.  The
6859 6860 6861
 * reference counter on the connection is not increased by this
 * call.
 *
6862 6863 6864 6865
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
6866 6867 6868 6869 6870
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
6871
    VIR_DEBUG("net=%p", net);
6872

6873 6874 6875
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
6876
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6877
        virDispatchError(NULL);
6878 6879 6880 6881 6882
        return NULL;
    }
    return net->conn;
}

6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893
/**
 * 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)
{
6894
    VIR_DEBUG("conn=%p", conn);
6895

6896 6897
    virResetLastError();

6898
    if (!VIR_IS_CONNECT(conn)) {
6899
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6900
        virDispatchError(NULL);
6901
        return -1;
6902 6903
    }

6904 6905 6906 6907 6908 6909 6910
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6911

6912
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6913 6914

error:
6915
    virDispatchError(conn);
6916
    return -1;
6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929
}

/**
 * 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
6930
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
6931
{
6932
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6933

6934 6935
    virResetLastError();

6936
    if (!VIR_IS_CONNECT(conn)) {
6937
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6938
        virDispatchError(NULL);
6939
        return -1;
6940 6941
    }

6942
    if ((names == NULL) || (maxnames < 0)) {
6943
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6944
        goto error;
6945 6946
    }

6947 6948 6949 6950 6951 6952 6953
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6954

6955
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6956 6957

error:
6958
    virDispatchError(conn);
6959
    return -1;
6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972
}

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

6975 6976
    virResetLastError();

6977
    if (!VIR_IS_CONNECT(conn)) {
6978
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6979
        virDispatchError(NULL);
6980
        return -1;
6981 6982
    }

6983 6984 6985 6986 6987 6988 6989
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6990

6991
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6992 6993

error:
6994
    virDispatchError(conn);
6995
    return -1;
6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008
}

/**
 * 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
7009
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
7010 7011
                              int maxnames)
{
7012
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7013

7014 7015
    virResetLastError();

7016
    if (!VIR_IS_CONNECT(conn)) {
7017
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7018
        virDispatchError(NULL);
7019
        return -1;
7020 7021
    }

7022
    if ((names == NULL) || (maxnames < 0)) {
7023
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7024
        goto error;
7025 7026
    }

7027 7028 7029 7030 7031 7032 7033 7034
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7035

7036
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7037 7038

error:
7039
    virDispatchError(conn);
7040
    return -1;
7041 7042 7043 7044 7045 7046 7047 7048 7049
}

/**
 * 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.
 *
7050 7051
 * 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.
7052 7053 7054 7055
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
7056
    VIR_DEBUG("conn=%p, name=%s", conn, name);
7057

7058 7059
    virResetLastError();

7060
    if (!VIR_IS_CONNECT(conn)) {
7061
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7062
        virDispatchError(NULL);
7063
        return NULL;
7064 7065
    }
    if (name == NULL) {
7066
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7067
        goto  error;
7068 7069
    }

7070 7071 7072 7073 7074 7075 7076
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7077

7078
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7079 7080

error:
7081
    virDispatchError(conn);
7082
    return NULL;
7083 7084 7085 7086 7087 7088 7089 7090 7091
}

/**
 * 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.
 *
7092 7093
 * 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.
7094 7095 7096 7097
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
7098 7099 7100
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    virUUIDFormat(uuid, uuidstr);

7101
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
7102

7103 7104
    virResetLastError();

7105
    if (!VIR_IS_CONNECT(conn)) {
7106
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7107
        virDispatchError(NULL);
7108
        return NULL;
7109 7110
    }
    if (uuid == NULL) {
7111
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7112
        goto error;
7113 7114
    }

7115 7116 7117 7118 7119 7120 7121
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
7122

7123
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7124 7125

error:
7126
    virDispatchError(conn);
7127
    return NULL;
7128 7129 7130 7131 7132 7133 7134 7135 7136
}

/**
 * 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.
 *
7137 7138
 * 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.
7139 7140 7141 7142 7143
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
7144
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
7145

7146 7147
    virResetLastError();

7148
    if (!VIR_IS_CONNECT(conn)) {
7149
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7150
        virDispatchError(NULL);
7151
        return NULL;
7152 7153
    }
    if (uuidstr == NULL) {
7154
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7155
        goto error;
7156 7157
    }

7158
    if (virUUIDParse(uuidstr, uuid) < 0) {
7159
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7160
        goto error;
7161 7162 7163
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
7164 7165

error:
7166
    virDispatchError(conn);
7167
    return NULL;
7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182
}

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

7185 7186
    virResetLastError();

7187
    if (!VIR_IS_CONNECT(conn)) {
7188
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7189
        virDispatchError(NULL);
7190
        return NULL;
7191 7192
    }
    if (xmlDesc == NULL) {
7193
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7194
        goto error;
7195 7196
    }
    if (conn->flags & VIR_CONNECT_RO) {
7197
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7198
        goto error;
7199 7200
    }

7201 7202 7203 7204 7205 7206 7207
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
7208

7209
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7210 7211

error:
7212
    virDispatchError(conn);
7213
    return NULL;
7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225
}

/**
 * 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
7226 7227
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
7228
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
7229

7230 7231
    virResetLastError();

7232
    if (!VIR_IS_CONNECT(conn)) {
7233
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7234
        virDispatchError(NULL);
7235
        return NULL;
7236 7237
    }
    if (conn->flags & VIR_CONNECT_RO) {
7238
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7239
        goto error;
7240 7241
    }
    if (xml == NULL) {
7242
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7243
        goto error;
7244 7245
    }

7246 7247 7248 7249 7250 7251 7252
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
7253

7254
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7255 7256

error:
7257
    virDispatchError(conn);
7258
    return NULL;
7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271
}

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

7274 7275
    virResetLastError();

7276
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7277
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7278
        virDispatchError(NULL);
7279
        return -1;
7280 7281 7282
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7283
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7284
        goto error;
7285 7286
    }

7287 7288 7289 7290 7291 7292 7293
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
7294

7295
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7296 7297

error:
7298
    virDispatchError(network->conn);
7299
    return -1;
7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311
}

/**
 * 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
7312 7313
virNetworkCreate(virNetworkPtr network)
{
7314
    virConnectPtr conn;
7315
    VIR_DEBUG("network=%p", network);
7316

7317 7318
    virResetLastError();

7319
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7320
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7321
        virDispatchError(NULL);
7322
        return -1;
7323 7324 7325
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7326
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7327
        goto error;
7328 7329
    }

7330 7331 7332 7333 7334 7335 7336
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
7337

7338
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7339 7340

error:
7341
    virDispatchError(network->conn);
7342
    return -1;
7343 7344 7345 7346 7347 7348 7349
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
7350 7351 7352
 * 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
7353 7354 7355 7356 7357 7358 7359
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
7360
    VIR_DEBUG("network=%p", network);
7361

7362 7363
    virResetLastError();

7364
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7365
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7366
        virDispatchError(NULL);
7367
        return -1;
7368 7369 7370 7371
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7372
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7373
        goto error;
7374 7375
    }

7376 7377 7378 7379 7380 7381 7382
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
7383

7384
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7385 7386

error:
7387
    virDispatchError(network->conn);
7388
    return -1;
7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402
}

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

7405 7406 7407
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7408
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7409
        virDispatchError(NULL);
7410
        return -1;
7411
    }
7412 7413
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
7414
        return -1;
7415
    }
7416
    return 0;
7417 7418
}

7419 7420
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
7421
 * @network: the network to hold a reference on
7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432
 *
 * 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 已提交
7433 7434
 *
 * Returns 0 in case of success, -1 in case of failure.
7435 7436 7437 7438 7439
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
7440
        virLibConnError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7441
        virDispatchError(NULL);
7442
        return -1;
7443 7444
    }
    virMutexLock(&network->conn->lock);
7445
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
7446 7447 7448 7449 7450
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462
/**
 * 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)
{
7463
    VIR_DEBUG("network=%p", network);
7464

7465 7466
    virResetLastError();

7467
    if (!VIR_IS_NETWORK(network)) {
7468
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7469
        virDispatchError(NULL);
7470
        return NULL;
7471
    }
7472
    return network->name;
7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486
}

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

7489 7490
    virResetLastError();

7491
    if (!VIR_IS_NETWORK(network)) {
7492
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7493
        virDispatchError(NULL);
7494
        return -1;
7495 7496
    }
    if (uuid == NULL) {
7497
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7498
        goto error;
7499 7500 7501 7502
    }

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

7503
    return 0;
7504 7505

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

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

7526 7527
    virResetLastError();

7528
    if (!VIR_IS_NETWORK(network)) {
7529
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7530
        virDispatchError(NULL);
7531
        return -1;
7532 7533
    }
    if (buf == NULL) {
7534
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7535
        goto error;
7536 7537 7538
    }

    if (virNetworkGetUUID(network, &uuid[0]))
7539
        goto error;
7540

7541
    virUUIDFormat(uuid, buf);
7542
    return 0;
7543 7544

error:
7545
    virDispatchError(network->conn);
7546
    return -1;
7547 7548 7549 7550 7551
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
7552
 * @flags: an OR'ed set of extraction flags, not used yet
7553 7554 7555 7556 7557 7558 7559 7560 7561 7562
 *
 * 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)
{
7563
    virConnectPtr conn;
7564
    VIR_DEBUG("network=%p, flags=%d", network, flags);
7565

7566 7567 7568
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7569
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7570
        virDispatchError(NULL);
7571
        return NULL;
7572 7573
    }
    if (flags != 0) {
7574
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7575
        goto error;
7576 7577
    }

7578 7579
    conn = network->conn;

7580
    if (conn->networkDriver && conn->networkDriver->networkGetXMLDesc) {
7581
        char *ret;
7582
        ret = conn->networkDriver->networkGetXMLDesc(network, flags);
7583 7584 7585 7586
        if (!ret)
            goto error;
        return ret;
    }
7587

7588
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7589 7590

error:
7591
    virDispatchError(network->conn);
7592
    return NULL;
7593
}
7594 7595 7596 7597 7598

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
7599
 * Provides a bridge interface name to which a domain may connect
7600 7601 7602 7603 7604 7605 7606 7607
 * 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)
{
7608
    virConnectPtr conn;
7609
    VIR_DEBUG("network=%p", network);
7610

7611 7612 7613
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7614
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7615
        virDispatchError(NULL);
7616
        return NULL;
7617 7618
    }

7619 7620
    conn = network->conn;

7621 7622 7623 7624 7625 7626 7627
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
7628

7629
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7630 7631

error:
7632
    virDispatchError(network->conn);
7633
    return NULL;
7634
}
7635 7636 7637 7638

/**
 * virNetworkGetAutostart:
 * @network: a network object
7639
 * @autostart: the value returned
7640
 *
7641
 * Provides a boolean value indicating whether the network
7642 7643 7644 7645 7646 7647 7648
 * 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,
7649 7650 7651
                       int *autostart)
{
    virConnectPtr conn;
7652
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
7653

7654 7655 7656
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7657
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7658
        virDispatchError(NULL);
7659
        return -1;
7660 7661
    }
    if (!autostart) {
7662
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7663
        goto error;
7664 7665
    }

7666 7667
    conn = network->conn;

7668 7669 7670 7671 7672 7673 7674
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7675

7676
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7677 7678

error:
7679
    virDispatchError(network->conn);
7680
    return -1;
7681 7682 7683 7684 7685
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
7686
 * @autostart: whether the network should be automatically started 0 or 1
7687 7688 7689 7690 7691 7692 7693 7694
 *
 * 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,
7695 7696 7697
                       int autostart)
{
    virConnectPtr conn;
7698
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
7699

7700 7701 7702
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
7703
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7704
        virDispatchError(NULL);
7705
        return -1;
7706 7707
    }

7708
    if (network->conn->flags & VIR_CONNECT_RO) {
7709
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7710
        goto error;
7711 7712
    }

7713 7714
    conn = network->conn;

7715 7716 7717 7718 7719 7720 7721
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7722

7723
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7724 7725

error:
7726
    virDispatchError(network->conn);
7727
    return -1;
7728
}
7729

D
Daniel Veillard 已提交
7730 7731
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
7732
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744
 *
 * 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
7745
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
7746
{
7747
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7748 7749 7750

    virResetLastError();

7751
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
7752
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7753
        virDispatchError(NULL);
D
Daniel Veillard 已提交
7754 7755
        return NULL;
    }
7756
    return iface->conn;
D
Daniel Veillard 已提交
7757 7758 7759 7760 7761 7762
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
7763
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
7764
 *
7765
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
7766 7767 7768 7769
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
7770
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
7771 7772 7773 7774

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7775
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7776
        virDispatchError(NULL);
7777
        return -1;
D
Daniel Veillard 已提交
7778 7779 7780 7781 7782 7783 7784 7785 7786 7787
    }

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

7788
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7789 7790

error:
7791
    virDispatchError(conn);
D
Daniel Veillard 已提交
7792 7793 7794 7795 7796 7797 7798 7799 7800
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
7801 7802
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
7803 7804 7805 7806 7807 7808
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
7809
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
7810 7811 7812 7813

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7814
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7815
        virDispatchError(NULL);
7816
        return -1;
D
Daniel Veillard 已提交
7817 7818 7819
    }

    if ((names == NULL) || (maxnames < 0)) {
7820
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831
        goto error;
    }

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

7832
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7833 7834

error:
7835
    virDispatchError(conn);
D
Daniel Veillard 已提交
7836 7837 7838
    return -1;
}

7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849
/**
 * 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)
{
7850
    VIR_DEBUG("conn=%p", conn);
7851 7852 7853 7854

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7855
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7856
        virDispatchError(NULL);
7857
        return -1;
7858 7859 7860 7861 7862 7863 7864 7865 7866 7867
    }

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

7868
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7869 7870

error:
7871
    virDispatchError(conn);
7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890
    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)
{
7891
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7892 7893 7894 7895

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7896
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7897
        virDispatchError(NULL);
7898
        return -1;
7899 7900 7901
    }

    if ((names == NULL) || (maxnames < 0)) {
7902
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913
        goto error;
    }

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

7914
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7915 7916

error:
7917
    virDispatchError(conn);
7918 7919 7920
    return -1;
}

D
Daniel Veillard 已提交
7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933
/**
 * 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)
{
7934
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
7935 7936 7937 7938

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7939
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7940
        virDispatchError(NULL);
7941
        return NULL;
D
Daniel Veillard 已提交
7942 7943
    }
    if (name == NULL) {
7944
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955
        goto  error;
    }

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

7956
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7957 7958

error:
7959
    virDispatchError(conn);
D
Daniel Veillard 已提交
7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975
    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)
{
7976
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
7977 7978 7979 7980

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7981
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7982
        virDispatchError(NULL);
7983
        return NULL;
D
Daniel Veillard 已提交
7984 7985
    }
    if (macstr == NULL) {
7986
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997
        goto  error;
    }

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

7998
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7999 8000

error:
8001
    virDispatchError(conn);
D
Daniel Veillard 已提交
8002 8003 8004 8005 8006
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
8007
 * @iface: an interface object
D
Daniel Veillard 已提交
8008 8009 8010 8011 8012 8013 8014
 *
 * 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 *
8015
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
8016
{
8017
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8018 8019 8020

    virResetLastError();

8021
    if (!VIR_IS_INTERFACE(iface)) {
8022
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8023
        virDispatchError(NULL);
8024
        return NULL;
D
Daniel Veillard 已提交
8025
    }
8026
    return iface->name;
D
Daniel Veillard 已提交
8027 8028 8029 8030
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
8031
 * @iface: an interface object
D
Daniel Veillard 已提交
8032
 *
L
Laine Stump 已提交
8033
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
8034 8035 8036 8037 8038 8039 8040
 * 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 *
8041
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
8042
{
8043
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8044 8045 8046

    virResetLastError();

8047
    if (!VIR_IS_INTERFACE(iface)) {
8048
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8049
        virDispatchError(NULL);
8050
        return NULL;
D
Daniel Veillard 已提交
8051
    }
8052
    return iface->mac;
D
Daniel Veillard 已提交
8053 8054 8055 8056
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
8057
 * @iface: an interface object
8058 8059 8060 8061 8062
 * @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 已提交
8063
 *
8064 8065 8066 8067 8068
 * 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 已提交
8069 8070 8071 8072 8073
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
8074
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
8075 8076
{
    virConnectPtr conn;
8077
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
8078 8079 8080

    virResetLastError();

8081
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8082
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8083
        virDispatchError(NULL);
8084
        return NULL;
D
Daniel Veillard 已提交
8085
    }
8086
    if ((flags & ~VIR_INTERFACE_XML_INACTIVE) != 0) {
8087
        virLibInterfaceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
8088 8089 8090
        goto error;
    }

8091
    conn = iface->conn;
D
Daniel Veillard 已提交
8092 8093 8094

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
8095
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
8096 8097 8098 8099 8100
        if (!ret)
            goto error;
        return ret;
    }

8101
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8102 8103

error:
8104
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120
    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)
{
8121
    VIR_DEBUG("conn=%p, xml=%s, flags=%d", conn, xml, flags);
D
Daniel Veillard 已提交
8122 8123 8124 8125

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
8126
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8127
        virDispatchError(NULL);
8128
        return NULL;
D
Daniel Veillard 已提交
8129 8130
    }
    if (conn->flags & VIR_CONNECT_RO) {
8131
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8132 8133 8134
        goto error;
    }
    if (xml == NULL) {
8135
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146
        goto error;
    }

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

8147
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8148 8149

error:
8150
    virDispatchError(conn);
D
Daniel Veillard 已提交
8151 8152 8153 8154 8155
    return NULL;
}

/**
 * virInterfaceUndefine:
8156
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
8157 8158 8159 8160 8161 8162 8163
 *
 * 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
8164
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
8165
    virConnectPtr conn;
8166
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8167 8168 8169

    virResetLastError();

8170
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8171
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8172
        virDispatchError(NULL);
8173
        return -1;
D
Daniel Veillard 已提交
8174
    }
8175
    conn = iface->conn;
D
Daniel Veillard 已提交
8176
    if (conn->flags & VIR_CONNECT_RO) {
8177
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8178 8179 8180 8181 8182
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
8183
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
8184 8185 8186 8187 8188
        if (ret < 0)
            goto error;
        return ret;
    }

8189
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8190 8191

error:
8192
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8193 8194 8195 8196 8197
    return -1;
}

/**
 * virInterfaceCreate:
8198
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
8199 8200 8201 8202 8203 8204 8205
 * @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
8206
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
8207 8208
{
    virConnectPtr conn;
8209
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
8210 8211 8212

    virResetLastError();

8213
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8214
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8215
        virDispatchError(NULL);
8216
        return -1;
D
Daniel Veillard 已提交
8217
    }
8218
    conn = iface->conn;
D
Daniel Veillard 已提交
8219
    if (conn->flags & VIR_CONNECT_RO) {
8220
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8221 8222 8223 8224 8225
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
8226
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
8227 8228 8229 8230 8231
        if (ret < 0)
            goto error;
        return ret;
    }

8232
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8233 8234

error:
8235
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8236 8237 8238 8239 8240
    return -1;
}

/**
 * virInterfaceDestroy:
8241
 * @iface: an interface object
D
Daniel Veillard 已提交
8242 8243 8244 8245 8246 8247 8248 8249 8250
 * @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
8251
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
8252 8253
{
    virConnectPtr conn;
8254
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
8255 8256 8257

    virResetLastError();

8258
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8259
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8260
        virDispatchError(NULL);
8261
        return -1;
D
Daniel Veillard 已提交
8262 8263
    }

8264
    conn = iface->conn;
D
Daniel Veillard 已提交
8265
    if (conn->flags & VIR_CONNECT_RO) {
8266
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
8267 8268 8269 8270 8271
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
8272
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
8273 8274 8275 8276 8277
        if (ret < 0)
            goto error;
        return ret;
    }

8278
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
8279 8280

error:
8281
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
8282 8283 8284 8285 8286
    return -1;
}

/**
 * virInterfaceRef:
8287
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
8288 8289 8290 8291 8292 8293 8294 8295 8296
 *
 * 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 已提交
8297
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
8298 8299 8300 8301 8302
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
8303
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
8304
{
8305
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
8306
        virLibConnError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8307
        virDispatchError(NULL);
8308
        return -1;
D
Daniel Veillard 已提交
8309
    }
8310
    virMutexLock(&iface->conn->lock);
8311
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
8312 8313
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
8314 8315 8316 8317 8318
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
8319
 * @iface: an interface object
D
Daniel Veillard 已提交
8320 8321 8322 8323 8324 8325 8326
 *
 * 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
8327
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
8328
{
8329
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
8330 8331 8332

    virResetLastError();

8333
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
8334
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
8335
        virDispatchError(NULL);
8336
        return -1;
D
Daniel Veillard 已提交
8337
    }
8338 8339
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
8340
        return -1;
8341
    }
8342
    return 0;
D
Daniel Veillard 已提交
8343 8344
}

8345 8346 8347

/**
 * virStoragePoolGetConnect:
8348
 * @pool: pointer to a pool
8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362
 *
 * 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)
{
8363
    VIR_DEBUG("pool=%p", pool);
8364

8365 8366 8367
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
8368
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8369
        virDispatchError(NULL);
8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385
        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)
{
8386
    VIR_DEBUG("conn=%p", conn);
8387

8388 8389
    virResetLastError();

8390
    if (!VIR_IS_CONNECT(conn)) {
8391
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8392
        virDispatchError(NULL);
8393
        return -1;
8394 8395
    }

8396 8397 8398 8399 8400 8401 8402
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8403

8404
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8405 8406

error:
8407
    virDispatchError(conn);
8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427
    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)
{
8428
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8429

8430 8431
    virResetLastError();

8432
    if (!VIR_IS_CONNECT(conn)) {
8433
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8434
        virDispatchError(NULL);
8435
        return -1;
8436 8437 8438
    }

    if ((names == NULL) || (maxnames < 0)) {
8439
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8440
        goto error;
8441 8442
    }

8443 8444 8445 8446 8447 8448 8449
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8450

8451
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8452

8453
error:
8454
    virDispatchError(conn);
8455
    return -1;
8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469
}


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

8472 8473
    virResetLastError();

8474
    if (!VIR_IS_CONNECT(conn)) {
8475
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8476
        virDispatchError(NULL);
8477
        return -1;
8478 8479
    }

8480 8481 8482 8483 8484 8485 8486
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
8487

8488
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8489 8490

error:
8491
    virDispatchError(conn);
8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512
    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)
{
8513
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
8514

8515 8516
    virResetLastError();

8517
    if (!VIR_IS_CONNECT(conn)) {
8518
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8519
        virDispatchError(NULL);
8520
        return -1;
8521 8522 8523
    }

    if ((names == NULL) || (maxnames < 0)) {
8524
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8525
        goto error;
8526 8527
    }

8528 8529 8530 8531 8532 8533 8534
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
8535

8536
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8537 8538

error:
8539
    virDispatchError(conn);
8540 8541 8542 8543
    return -1;
}


8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570
/**
 * 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)
{
8571
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);
8572 8573 8574

    virResetLastError();

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

8585
    if (conn->flags & VIR_CONNECT_RO) {
8586
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8587
        goto error;
8588 8589
    }

8590 8591 8592 8593 8594 8595 8596
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
8597

8598
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8599 8600

error:
8601
    virDispatchError(conn);
8602 8603 8604 8605
    return NULL;
}


8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618
/**
 * 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)
{
8619
    VIR_DEBUG("conn=%p, name=%s", conn, name);
8620

8621 8622
    virResetLastError();

8623
    if (!VIR_IS_CONNECT(conn)) {
8624
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8625
        virDispatchError(NULL);
8626
        return NULL;
8627 8628
    }
    if (name == NULL) {
8629
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8630
        goto error;
8631 8632
    }

8633 8634 8635 8636 8637 8638 8639
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8640

8641
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8642 8643

error:
8644
    virDispatchError(conn);
8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661
    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)
{
8662
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
8663

8664 8665
    virResetLastError();

8666
    if (!VIR_IS_CONNECT(conn)) {
8667
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8668
        virDispatchError(NULL);
8669
        return NULL;
8670 8671
    }
    if (uuid == NULL) {
8672
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8673
        goto error;
8674 8675
    }

8676 8677 8678 8679 8680 8681 8682
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
8683

8684
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8685

8686
error:
8687
    virDispatchError(conn);
8688
    return NULL;
8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702
}


/**
 * 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,
8703
                                 const char *uuidstr)
8704 8705
{
    unsigned char uuid[VIR_UUID_BUFLEN];
8706
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
8707

8708 8709
    virResetLastError();

8710
    if (!VIR_IS_CONNECT(conn)) {
8711
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8712
        virDispatchError(NULL);
8713
        return NULL;
8714 8715
    }
    if (uuidstr == NULL) {
8716
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8717
        goto error;
8718 8719 8720
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
8721
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8722
        goto error;
8723 8724 8725
    }

    return virStoragePoolLookupByUUID(conn, uuid);
8726 8727

error:
8728
    virDispatchError(conn);
8729
    return NULL;
8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743
}


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

8746 8747 8748
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
8749
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8750
        virDispatchError(NULL);
8751
        return NULL;
8752 8753
    }

8754 8755 8756 8757 8758 8759 8760
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
8761

8762
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8763

8764
error:
8765
    virDispatchError(vol->conn);
8766
    return NULL;
8767 8768 8769 8770 8771 8772
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
8773
 * @flags: future flags, use 0 for now
8774 8775
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
8776
 * pool is not persistent, so its definition will disappear
8777 8778 8779 8780 8781 8782 8783 8784 8785
 * 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)
{
8786
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
8787

8788 8789
    virResetLastError();

8790
    if (!VIR_IS_CONNECT(conn)) {
8791
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8792
        virDispatchError(NULL);
8793
        return NULL;
8794 8795
    }
    if (xmlDesc == NULL) {
8796
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8797
        goto error;
8798 8799
    }
    if (conn->flags & VIR_CONNECT_RO) {
8800
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8801
        goto error;
8802 8803
    }

8804 8805 8806 8807 8808 8809 8810
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
8811

8812
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8813 8814

error:
8815
    virDispatchError(conn);
8816 8817 8818 8819 8820 8821 8822
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
8823
 * @flags: future flags, use 0 for now
8824 8825
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
8826
 * pool is persistent, until explicitly undefined.
8827 8828 8829 8830 8831 8832 8833 8834
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
8835
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
8836

8837 8838
    virResetLastError();

8839
    if (!VIR_IS_CONNECT(conn)) {
8840
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8841
        virDispatchError(NULL);
8842
        return NULL;
8843 8844
    }
    if (conn->flags & VIR_CONNECT_RO) {
8845
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8846
        goto error;
8847 8848
    }
    if (xml == NULL) {
8849
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8850
        goto error;
8851 8852
    }

8853 8854 8855 8856 8857 8858 8859
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
8860

8861
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8862

8863
error:
8864
    virDispatchError(conn);
8865
    return NULL;
8866 8867 8868 8869 8870
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
8871
 * @flags: future flags, use 0 for now
8872 8873 8874 8875 8876 8877 8878 8879 8880 8881
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
8882
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8883

8884 8885
    virResetLastError();

8886
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8887
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8888
        virDispatchError(NULL);
8889
        return -1;
8890 8891 8892
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8893
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8894
        goto error;
8895 8896
    }

8897 8898 8899 8900 8901 8902 8903
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8904

8905
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8906

8907
error:
8908
    virDispatchError(pool->conn);
8909
    return -1;
8910 8911 8912 8913 8914 8915 8916 8917 8918
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
8919
 * Returns 0 on success, -1 on failure
8920 8921 8922 8923 8924
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
8925
    VIR_DEBUG("pool=%p", pool);
8926

8927 8928
    virResetLastError();

8929
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8930
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8931
        virDispatchError(NULL);
8932
        return -1;
8933 8934 8935
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8936
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8937
        goto error;
8938 8939
    }

8940 8941 8942 8943 8944 8945 8946
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8947

8948
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8949

8950
error:
8951
    virDispatchError(pool->conn);
8952
    return -1;
8953 8954 8955 8956 8957 8958
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
8959
 * @flags: future flags, use 0 for now
8960 8961 8962 8963 8964 8965 8966 8967 8968 8969
 *
 * 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;
8970
    VIR_DEBUG("pool=%p", pool);
8971

8972 8973
    virResetLastError();

8974
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8975
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8976
        virDispatchError(NULL);
8977
        return -1;
8978 8979 8980
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8981
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8982
        goto error;
8983 8984
    }

8985 8986 8987 8988 8989 8990 8991
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8992

8993
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8994

8995
error:
8996
    virDispatchError(pool->conn);
8997
    return -1;
8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016
}


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

9019 9020
    virResetLastError();

9021
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9022
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9023
        virDispatchError(NULL);
9024
        return -1;
9025 9026 9027 9028
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9029
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9030
        goto error;
9031 9032
    }

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

9041
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9042 9043

error:
9044
    virDispatchError(pool->conn);
9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063
    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;
9064
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
9065

9066 9067
    virResetLastError();

9068
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9069
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9070
        virDispatchError(NULL);
9071
        return -1;
9072 9073 9074 9075
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9076
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9077
        goto error;
9078 9079
    }

9080 9081 9082 9083 9084 9085 9086
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9087

9088
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9089 9090

error:
9091
    virDispatchError(pool->conn);
9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107
    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)
{
9108
    VIR_DEBUG("pool=%p", pool);
9109

9110 9111 9112
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9113
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9114
        virDispatchError(NULL);
9115
        return -1;
9116
    }
9117 9118
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
9119
        return -1;
9120
    }
9121
    return 0;
9122 9123 9124 9125

}


9126 9127
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
9128
 * @pool: the pool to hold a reference on
9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139
 *
 * 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 已提交
9140 9141
 *
 * Returns 0 in case of success, -1 in case of failure.
9142 9143 9144 9145 9146
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
9147
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9148
        virDispatchError(NULL);
9149
        return -1;
9150 9151
    }
    virMutexLock(&pool->conn->lock);
9152
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
9153 9154 9155 9156 9157
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

9158 9159 9160 9161 9162 9163 9164 9165 9166
/**
 * 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
 *
9167
 * Returns 0 if the volume list was refreshed, -1 on failure
9168 9169 9170 9171 9172 9173
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
9174
    VIR_DEBUG("pool=%p flags=%u", pool, flags);
9175

9176 9177
    virResetLastError();

9178
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9179
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9180
        virDispatchError(NULL);
9181
        return -1;
9182 9183 9184 9185
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9186
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9187
        goto error;
9188 9189
    }

9190 9191 9192 9193 9194 9195 9196
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9197

9198
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9199 9200

error:
9201
    virDispatchError(pool->conn);
9202 9203 9204 9205 9206 9207 9208 9209 9210 9211
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
9212
 * Returns the name of the pool, or NULL on error
9213 9214 9215 9216
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
9217
    VIR_DEBUG("pool=%p", pool);
9218

9219 9220
    virResetLastError();

9221
    if (!VIR_IS_STORAGE_POOL(pool)) {
9222
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9223
        virDispatchError(NULL);
9224
        return NULL;
9225
    }
9226
    return pool->name;
9227 9228 9229 9230 9231 9232 9233 9234 9235 9236
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
9237
 * Returns 0 on success, or -1 on error;
9238 9239 9240 9241 9242
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
9243
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
9244

9245 9246
    virResetLastError();

9247
    if (!VIR_IS_STORAGE_POOL(pool)) {
9248
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9249
        virDispatchError(NULL);
9250
        return -1;
9251 9252
    }
    if (uuid == NULL) {
9253
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9254
        goto error;
9255 9256 9257 9258
    }

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

9259
    return 0;
9260

9261
error:
9262
    virDispatchError(pool->conn);
9263
    return -1;
9264 9265 9266 9267 9268 9269 9270 9271 9272
}

/**
 * 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
 *
9273
 * Returns 0 on success, or -1 on error;
9274 9275 9276 9277 9278 9279
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
9280
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
9281

9282 9283
    virResetLastError();

9284
    if (!VIR_IS_STORAGE_POOL(pool)) {
9285
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9286
        virDispatchError(NULL);
9287
        return -1;
9288 9289
    }
    if (buf == NULL) {
9290
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9291
        goto error;
9292 9293 9294
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
9295
        goto error;
9296 9297

    virUUIDFormat(uuid, buf);
9298
    return 0;
9299

9300
error:
9301
    virDispatchError(pool->conn);
9302
    return -1;
9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313
}


/**
 * 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
 *
9314
 * Returns 0 on success, or -1 on failure.
9315 9316 9317 9318 9319 9320
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
9321
    VIR_DEBUG("pool=%p, info=%p", pool, info);
9322

9323 9324
    virResetLastError();

9325
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9326
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9327
        virDispatchError(NULL);
9328
        return -1;
9329 9330
    }
    if (info == NULL) {
9331
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9332
        goto error;
9333 9334 9335 9336 9337 9338
    }

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

    conn = pool->conn;

9339 9340 9341 9342 9343 9344 9345
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
9346

9347
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9348

9349
error:
9350
    virDispatchError(pool->conn);
9351
    return -1;
9352 9353 9354 9355 9356 9357
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
9358
 * @flags: flags for XML format options (set of virDomainXMLFlags)
9359 9360 9361 9362 9363
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
9364
 * Returns a XML document, or NULL on error
9365 9366 9367 9368 9369 9370
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
9371
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
9372

9373 9374 9375
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9376
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9377
        virDispatchError(NULL);
9378
        return NULL;
9379 9380
    }
    if (flags != 0) {
9381
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9382
        goto error;
9383 9384 9385 9386
    }

    conn = pool->conn;

9387 9388 9389 9390 9391 9392 9393
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
9394

9395
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9396

9397
error:
9398
    virDispatchError(pool->conn);
9399
    return NULL;
9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410
}


/**
 * 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
 *
9411
 * Returns 0 on success, -1 on failure
9412 9413 9414 9415 9416 9417
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
9418
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
9419

9420 9421 9422
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9423
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9424
        virDispatchError(NULL);
9425
        return -1;
9426 9427
    }
    if (!autostart) {
9428
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9429
        goto error;
9430 9431 9432 9433
    }

    conn = pool->conn;

9434 9435 9436 9437 9438 9439 9440
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9441

9442
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9443 9444

error:
9445
    virDispatchError(pool->conn);
9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
9457
 * Returns 0 on success, -1 on failure
9458 9459 9460 9461 9462 9463
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
9464
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
9465

9466 9467 9468
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
9469
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9470
        virDispatchError(NULL);
9471
        return -1;
9472 9473
    }

9474
    if (pool->conn->flags & VIR_CONNECT_RO) {
9475
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9476
        goto error;
9477 9478
    }

9479 9480
    conn = pool->conn;

9481 9482 9483 9484 9485 9486 9487
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
9488

9489
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9490 9491

error:
9492
    virDispatchError(pool->conn);
9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507
    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)
{
9508
    VIR_DEBUG("pool=%p", pool);
9509

9510 9511
    virResetLastError();

9512
    if (!VIR_IS_STORAGE_POOL(pool)) {
9513
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9514
        virDispatchError(NULL);
9515
        return -1;
9516 9517
    }

9518 9519 9520 9521 9522 9523 9524
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
9525

9526
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9527 9528

error:
9529
    virDispatchError(pool->conn);
9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549
    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)
{
9550
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
9551

9552 9553
    virResetLastError();

9554
    if (!VIR_IS_STORAGE_POOL(pool)) {
9555
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9556
        virDispatchError(NULL);
9557
        return -1;
9558 9559 9560
    }

    if ((names == NULL) || (maxnames < 0)) {
9561
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9562
        goto error;
9563 9564
    }

9565 9566 9567 9568 9569 9570 9571
    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;
    }
9572

9573
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9574 9575

error:
9576
    virDispatchError(pool->conn);
9577 9578 9579 9580 9581 9582
    return -1;
}


/**
 * virStorageVolGetConnect:
9583
 * @vol: pointer to a pool
9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597
 *
 * 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)
{
9598
    VIR_DEBUG("vol=%p", vol);
9599

9600 9601
    virResetLastError();

9602
    if (!VIR_IS_STORAGE_VOL (vol)) {
9603
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9604
        virDispatchError(NULL);
9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618
        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
 *
9619
 * Returns a storage volume, or NULL if not found / error
9620 9621 9622 9623 9624
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
9625
    VIR_DEBUG("pool=%p, name=%s", pool, name);
9626

9627 9628
    virResetLastError();

9629
    if (!VIR_IS_STORAGE_POOL(pool)) {
9630
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9631
        virDispatchError(NULL);
9632
        return NULL;
9633 9634
    }
    if (name == NULL) {
9635
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9636
        goto error;
9637 9638
    }

9639 9640 9641 9642 9643 9644 9645
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
9646

9647
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9648 9649

error:
9650
    virDispatchError(pool->conn);
9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663
    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
 *
9664
 * Returns a storage volume, or NULL if not found / error
9665 9666 9667 9668 9669
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
9670
    VIR_DEBUG("conn=%p, key=%s", conn, key);
9671

9672 9673
    virResetLastError();

9674
    if (!VIR_IS_CONNECT(conn)) {
9675
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9676
        virDispatchError(NULL);
9677
        return NULL;
9678 9679
    }
    if (key == NULL) {
9680
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9681
        goto error;
9682 9683
    }

9684 9685 9686 9687 9688 9689 9690
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
9691

9692
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9693 9694

error:
9695
    virDispatchError(conn);
9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706
    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
 *
9707
 * Returns a storage volume, or NULL if not found / error
9708 9709 9710 9711 9712
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
9713
    VIR_DEBUG("conn=%p, path=%s", conn, path);
9714

9715 9716
    virResetLastError();

9717
    if (!VIR_IS_CONNECT(conn)) {
9718
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9719
        virDispatchError(NULL);
9720
        return NULL;
9721 9722
    }
    if (path == NULL) {
9723
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9724
        goto error;
9725 9726
    }

9727 9728 9729 9730 9731 9732 9733
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
9734

9735
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9736 9737

error:
9738
    virDispatchError(conn);
9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
9750
 * Returns the volume name, or NULL on error
9751 9752 9753 9754
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
9755
    VIR_DEBUG("vol=%p", vol);
9756

9757 9758
    virResetLastError();

9759
    if (!VIR_IS_STORAGE_VOL(vol)) {
9760
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9761
        virDispatchError(NULL);
9762
        return NULL;
9763
    }
9764
    return vol->name;
9765 9766 9767 9768 9769 9770 9771 9772
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
9773
 * unique, so the same volume will have the same
9774 9775
 * key no matter what host it is accessed from
 *
9776
 * Returns the volume key, or NULL on error
9777 9778 9779 9780
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
9781
    VIR_DEBUG("vol=%p", vol);
9782

9783 9784
    virResetLastError();

9785
    if (!VIR_IS_STORAGE_VOL(vol)) {
9786
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9787
        virDispatchError(NULL);
9788
        return NULL;
9789
    }
9790
    return vol->key;
9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803
}


/**
 * 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
 *
9804
 * Returns the storage volume, or NULL on error
9805 9806 9807 9808 9809 9810
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
9811
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
9812

9813 9814
    virResetLastError();

9815
    if (!VIR_IS_STORAGE_POOL(pool)) {
9816
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9817
        virDispatchError(NULL);
9818
        return NULL;
9819 9820
    }

9821 9822 9823 9824 9825
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

9826
    if (pool->conn->flags & VIR_CONNECT_RO) {
9827
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9828
        goto error;
9829 9830
    }

9831 9832 9833 9834 9835 9836 9837
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
9838

9839
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9840 9841

error:
9842
    virDispatchError(pool->conn);
9843 9844 9845 9846
    return NULL;
}


9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858
/**
 * 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.
 *
9859
 * Returns the storage volume, or NULL on error
9860 9861 9862 9863 9864 9865 9866
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
9867
    VIR_DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);
9868 9869 9870 9871

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
9872
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9873
        virDispatchError(NULL);
9874
        return NULL;
9875 9876 9877
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
9878
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9879
        goto error;
9880 9881
    }

9882 9883 9884 9885 9886
    if (xmldesc == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

9887 9888
    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
9889
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902
        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;
    }

9903
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9904 9905

error:
9906
    virDispatchError(pool->conn);
9907 9908 9909 9910
    return NULL;
}


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 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050
/**
 * 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;
}


10051 10052 10053
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
10054
 * @flags: future flags, use 0 for now
10055 10056 10057
 *
 * Delete the storage volume from the pool
 *
10058
 * Returns 0 on success, or -1 on error
10059 10060 10061 10062 10063 10064
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
10065
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
10066

10067 10068
    virResetLastError();

10069
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10070
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10071
        virDispatchError(NULL);
10072
        return -1;
10073 10074 10075 10076
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10077
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10078
        goto error;
10079 10080
    }

10081 10082 10083 10084 10085 10086 10087
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10088

10089
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10090 10091

error:
10092
    virDispatchError(vol->conn);
10093 10094 10095 10096
    return -1;
}


10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115
/**
 * 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)) {
10116
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10117
        virDispatchError(NULL);
10118
        return -1;
10119 10120 10121 10122
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10123
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135
        goto error;
    }

    if (conn->storageDriver && conn->storageDriver->volWipe) {
        int ret;
        ret = conn->storageDriver->volWipe(vol, flags);
        if (ret < 0) {
            goto error;
        }
        return ret;
    }

10136
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10137 10138 10139 10140 10141 10142 10143

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


10144 10145 10146 10147 10148
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
10149
 * storage volume continues to exist.
10150
 *
10151
 * Returns 0 on success, or -1 on error
10152 10153 10154 10155
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
10156
    VIR_DEBUG("vol=%p", vol);
10157

10158 10159
    virResetLastError();

10160
    if (!VIR_IS_STORAGE_VOL(vol)) {
10161
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10162
        virDispatchError(NULL);
10163
        return -1;
10164
    }
10165 10166
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
10167
        return -1;
10168
    }
10169
    return 0;
10170 10171 10172
}


10173 10174
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
10175
 * @vol: the vol to hold a reference on
10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186
 *
 * 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 已提交
10187 10188
 *
 * Returns 0 in case of success, -1 in case of failure.
10189 10190 10191 10192 10193
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
10194
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10195
        virDispatchError(NULL);
10196
        return -1;
10197 10198
    }
    virMutexLock(&vol->conn->lock);
10199
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
10200 10201 10202 10203 10204
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

10205 10206 10207 10208 10209 10210 10211 10212
/**
 * 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
 *
10213
 * Returns 0 on success, or -1 on failure
10214 10215 10216 10217 10218 10219
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
10220
    VIR_DEBUG("vol=%p, info=%p", vol, info);
10221

10222 10223
    virResetLastError();

10224
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
10225
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10226
        virDispatchError(NULL);
10227
        return -1;
10228 10229
    }
    if (info == NULL) {
10230
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10231
        goto error;
10232 10233 10234 10235 10236 10237
    }

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

    conn = vol->conn;

10238 10239 10240 10241 10242 10243 10244
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
10245

10246
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10247 10248

error:
10249
    virDispatchError(vol->conn);
10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261
    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
 *
10262
 * Returns the XML document, or NULL on error
10263 10264 10265 10266 10267 10268
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
10269
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
10270

10271 10272
    virResetLastError();

10273
    if (!VIR_IS_STORAGE_VOL(vol)) {
10274
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10275
        virDispatchError(NULL);
10276
        return NULL;
10277 10278
    }
    if (flags != 0) {
10279
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10280
        goto error;
10281 10282 10283 10284
    }

    conn = vol->conn;

10285 10286 10287 10288 10289 10290 10291
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
10292

10293
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10294

10295
error:
10296
    virDispatchError(vol->conn);
10297
    return NULL;
10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316
}


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

10319 10320
    virResetLastError();

10321
    if (!VIR_IS_STORAGE_VOL(vol)) {
10322
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
10323
        virDispatchError(NULL);
10324
        return NULL;
10325 10326 10327 10328
    }

    conn = vol->conn;

10329 10330 10331 10332 10333 10334 10335
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
10336

10337
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10338 10339

error:
10340
    virDispatchError(vol->conn);
10341 10342
    return NULL;
}
10343 10344


10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360
/**
 * 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)
{
10361
    VIR_DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
10362

10363 10364
    virResetLastError();

10365
    if (!VIR_IS_CONNECT(conn)) {
10366
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10367
        virDispatchError(NULL);
10368
        return -1;
10369 10370
    }
    if (flags != 0) {
10371
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10372
        goto error;
10373 10374
    }

10375 10376 10377 10378 10379 10380 10381
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10382

10383
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10384 10385

error:
10386
    virDispatchError(conn);
10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411
    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)
{
10412
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%d",
10413 10414
          conn, cap, names, maxnames, flags);

10415 10416
    virResetLastError();

10417
    if (!VIR_IS_CONNECT(conn)) {
10418
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10419
        virDispatchError(NULL);
10420
        return -1;
10421 10422
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
10423
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10424
        goto error;
10425 10426
    }

10427 10428 10429 10430 10431 10432 10433
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
10434

10435
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10436 10437

error:
10438
    virDispatchError(conn);
10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453
    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)
{
10454
    VIR_DEBUG("conn=%p, name=%p", conn, name);
10455

10456 10457
    virResetLastError();

10458
    if (!VIR_IS_CONNECT(conn)) {
10459
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10460
        virDispatchError(NULL);
10461 10462 10463 10464
        return NULL;
    }

    if (name == NULL) {
10465
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10466
        goto error;
10467 10468
    }

10469 10470 10471 10472 10473 10474 10475
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
10476

10477
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10478 10479

error:
10480
    virDispatchError(conn);
10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492
    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.
 *
10493
 * Returns the XML document, or NULL on error
10494 10495 10496
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
10497
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10498

10499 10500
    virResetLastError();

10501
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10502
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10503
        virDispatchError(NULL);
10504 10505 10506
        return NULL;
    }

10507
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetXMLDesc) {
10508
        char *ret;
10509
        ret = dev->conn->deviceMonitor->deviceGetXMLDesc(dev, flags);
10510 10511 10512 10513
        if (!ret)
            goto error;
        return ret;
    }
10514

10515
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10516 10517

error:
10518
    virDispatchError(dev->conn);
10519 10520 10521 10522 10523 10524 10525 10526
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
10527 10528 10529
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
10530 10531 10532
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
10533
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10534 10535

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10536
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10537
        virDispatchError(NULL);
10538 10539 10540 10541 10542 10543 10544 10545 10546 10547
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
10548 10549
 * Accessor for the parent of the device
 *
10550 10551 10552 10553 10554
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
10555
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10556

10557 10558
    virResetLastError();

10559
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10560
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10561
        virDispatchError(NULL);
10562 10563 10564
        return NULL;
    }

10565 10566 10567 10568
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
10569
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10570
            virDispatchError(dev->conn);
10571 10572 10573 10574
            return NULL;
        }
    }
    return dev->parent;
10575 10576 10577 10578 10579 10580
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
10581 10582
 * Accessor for the number of capabilities supported by the device.
 *
10583 10584 10585 10586
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
10587
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10588

10589 10590
    virResetLastError();

10591
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10592
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10593
        virDispatchError(NULL);
10594 10595 10596
        return -1;
    }

10597 10598 10599 10600 10601 10602 10603
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
10604

10605
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10606 10607

error:
10608
    virDispatchError(dev->conn);
10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625
    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)
{
10626
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
10627 10628
          dev, dev ? dev->conn : NULL, names, maxnames);

10629 10630
    virResetLastError();

10631
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10632
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10633
        virDispatchError(NULL);
10634 10635 10636
        return -1;
    }

10637 10638 10639 10640 10641
    if (names == NULL || maxnames < 0) {
        virLibNodeDeviceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

10642 10643 10644 10645 10646 10647 10648
    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;
    }
10649

10650
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10651 10652

error:
10653
    virDispatchError(dev->conn);
10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668
    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)
{
10669
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10670

10671 10672
    virResetLastError();

10673
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10674
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10675
        virDispatchError(NULL);
10676
        return -1;
10677
    }
10678 10679
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
10680
        return -1;
10681
    }
10682
    return 0;
10683 10684 10685
}


10686 10687
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
10688
 * @dev: the dev to hold a reference on
10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699
 *
 * 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 已提交
10700 10701
 *
 * Returns 0 in case of success, -1 in case of failure.
10702 10703 10704 10705 10706
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
10707
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10708
        virDispatchError(NULL);
10709
        return -1;
10710 10711
    }
    virMutexLock(&dev->conn->lock);
10712
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
10713 10714 10715 10716 10717
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

10718
/**
D
Daniel Veillard 已提交
10719
 * virNodeDeviceDettach:
10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733
 * @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 已提交
10734 10735
 *
 * Returns 0 in case of success, -1 in case of failure.
10736 10737 10738 10739
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
10740
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10741 10742 10743 10744

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10745
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10746
        virDispatchError(NULL);
10747
        return -1;
10748 10749
    }

10750 10751 10752 10753 10754
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10755 10756 10757 10758 10759 10760 10761 10762
    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10763
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10764 10765

error:
10766
    virDispatchError(dev->conn);
10767
    return -1;
10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781
}

/**
 * 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 已提交
10782 10783
 *
 * Returns 0 in case of success, -1 in case of failure.
10784 10785 10786 10787
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
10788
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10789 10790 10791 10792

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10793
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10794
        virDispatchError(NULL);
10795
        return -1;
10796 10797
    }

10798 10799 10800 10801 10802
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10803 10804 10805 10806 10807 10808 10809 10810
    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10811
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10812 10813

error:
10814
    virDispatchError(dev->conn);
10815
    return -1;
10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831
}

/**
 * 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 已提交
10832 10833
 *
 * Returns 0 in case of success, -1 in case of failure.
10834 10835 10836 10837
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
10838
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10839 10840 10841 10842

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10843
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10844
        virDispatchError(NULL);
10845
        return -1;
10846 10847
    }

10848 10849 10850 10851 10852
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10853 10854 10855 10856 10857 10858 10859 10860
    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10861
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10862 10863

error:
10864
    virDispatchError(dev->conn);
10865
    return -1;
10866 10867
}

10868

10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889
/**
 * 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)) {
10890
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10891
        virDispatchError(NULL);
10892 10893 10894 10895
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
10896
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10897 10898 10899 10900
        goto error;
    }

    if (xmlDesc == NULL) {
10901
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

10913
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10914 10915

error:
10916
    virDispatchError(conn);
10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932
    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)
{
10933
    VIR_DEBUG("dev=%p", dev);
10934 10935 10936 10937

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10938
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10939
        virDispatchError(NULL);
10940
        return -1;
10941 10942 10943
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
10944
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

10958
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10959 10960

error:
10961
    virDispatchError(dev->conn);
10962 10963 10964 10965
    return -1;
}


10966 10967 10968 10969 10970 10971 10972 10973 10974
/*
 * 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 已提交
10975
 * @freecb: optional function to deallocate opaque when not used anymore
10976
 *
10977 10978 10979 10980 10981 10982
 * 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
10983
 *
10984 10985
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
10986 10987
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
10988 10989 10990
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
10991 10992 10993 10994 10995
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
10996 10997
                              void *opaque,
                              virFreeCallback freecb)
10998
{
10999
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
11000
    virResetLastError();
11001 11002

    if (!VIR_IS_CONNECT(conn)) {
11003
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11004
        virDispatchError(NULL);
11005
        return -1;
11006 11007
    }
    if (cb == NULL) {
11008
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11009
        goto error;
11010 11011
    }

11012 11013 11014 11015 11016 11017 11018 11019
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

11020
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11021
error:
11022
    virDispatchError(conn);
11023 11024 11025 11026 11027 11028 11029 11030
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
11031 11032 11033 11034 11035 11036
 * 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
11037 11038 11039 11040 11041 11042 11043
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
11044
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
11045 11046

    virResetLastError();
11047 11048

    if (!VIR_IS_CONNECT(conn)) {
11049
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11050
        virDispatchError(NULL);
11051
        return -1;
11052 11053
    }
    if (cb == NULL) {
11054
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11055 11056 11057 11058 11059 11060 11061 11062
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
11063 11064
    }

11065
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11066
error:
11067
    virDispatchError(conn);
11068 11069
    return -1;
}
11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085

/**
 * 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)
{
11086
    VIR_DEBUG("secret=%p", secret);
11087 11088 11089 11090

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
11091
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11092
        virDispatchError(NULL);
11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113
        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)) {
11114
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11115
        virDispatchError(NULL);
11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128
        return -1;
    }

    if (conn->secretDriver != NULL &&
        conn->secretDriver->numOfSecrets != NULL) {
        int ret;

        ret = conn->secretDriver->numOfSecrets(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

11129
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11130 11131

error:
11132
    virDispatchError(conn);
11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153
    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)) {
11154
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11155
        virDispatchError(NULL);
11156 11157 11158
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
11159
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171
        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;
    }

11172
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11173 11174

error:
11175
    virDispatchError(conn);
11176 11177 11178 11179
    return -1;
}

/**
11180 11181 11182
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
11183
 *
11184 11185
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
11186
 *
11187 11188
 * 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.
11189 11190
 */
virSecretPtr
11191
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
11192
{
11193
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
11194 11195 11196 11197

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11198
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11199
        virDispatchError(NULL);
11200
        return NULL;
11201 11202
    }
    if (uuid == NULL) {
11203
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11204 11205 11206
        goto error;
    }

11207 11208
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
11209
        virSecretPtr ret;
11210 11211
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
11212 11213 11214 11215
            goto error;
        return ret;
    }

11216
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11217 11218

error:
11219
    virDispatchError(conn);
11220 11221 11222
    return NULL;
}

11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237
/**
 * 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];
11238
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
11239 11240 11241 11242

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11243
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11244
        virDispatchError(NULL);
11245
        return NULL;
11246 11247
    }
    if (uuidstr == NULL) {
11248
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11249 11250
        goto error;
    }
11251 11252

    if (virUUIDParse(uuidstr, uuid) < 0) {
11253
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11254 11255 11256 11257 11258 11259
        goto error;
    }

    return virSecretLookupByUUID(conn, &uuid[0]);

error:
11260
    virDispatchError(conn);
11261 11262 11263 11264
    return NULL;
}


11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282
/**
 * 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)
{
11283
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
11284 11285 11286 11287

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11288
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11289
        virDispatchError(NULL);
11290
        return NULL;
11291 11292
    }
    if (usageID == NULL) {
11293
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305
        goto error;
    }

    if (conn->secretDriver &&
        conn->secretDriver->lookupByUsage) {
        virSecretPtr ret;
        ret = conn->secretDriver->lookupByUsage (conn, usageType, usageID);
        if (!ret)
            goto error;
        return ret;
    }

11306
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11307 11308

error:
11309
    virDispatchError(conn);
11310 11311 11312 11313
    return NULL;
}


11314 11315 11316 11317 11318 11319
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
11320
 * If XML specifies a UUID, locates the specified secret and replaces all
11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336
 * 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)) {
11337
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11338
        virDispatchError(NULL);
11339 11340 11341
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
11342
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11343 11344 11345
        goto error;
    }
    if (xml == NULL) {
11346
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358
        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;
    }

11359
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11360 11361

error:
11362
    virDispatchError(conn);
11363 11364 11365 11366
    return NULL;
}

/**
11367
 * virSecretGetUUID:
11368
 * @secret: A virSecret secret
11369
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
11370 11371 11372
 *
 * Fetches the UUID of the secret.
 *
11373 11374
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
11375
 */
11376 11377
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
11378 11379 11380 11381 11382 11383
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11384
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11385
        virDispatchError(NULL);
11386 11387 11388
        return -1;
    }
    if (uuid == NULL) {
11389
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
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 11410 11411 11412
    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];
11413
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
11414 11415

    virResetLastError();
11416

11417
    if (!VIR_IS_SECRET(secret)) {
11418
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11419
        virDispatchError(NULL);
11420
        return -1;
11421 11422
    }
    if (buf == NULL) {
11423
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11424 11425 11426 11427 11428 11429 11430
        goto error;
    }

    if (virSecretGetUUID(secret, &uuid[0]))
        goto error;

    virUUIDFormat(uuid, buf);
11431
    return 0;
11432 11433

error:
11434
    virDispatchError(secret->conn);
11435
    return -1;
11436 11437
}

11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453
/**
 * 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)
{
11454
    VIR_DEBUG("secret=%p", secret);
11455 11456 11457 11458

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
11459
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11460
        virDispatchError(NULL);
11461
        return -1;
11462
    }
11463
    return secret->usageType;
11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484
}

/**
 * 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)
{
11485
    VIR_DEBUG("secret=%p", secret);
11486 11487 11488 11489

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
11490
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11491
        virDispatchError(NULL);
11492
        return NULL;
11493
    }
11494
    return secret->usageID;
11495 11496
}

11497

11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517
/**
 * 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)) {
11518
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11519
        virDispatchError(NULL);
11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532
        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;
    }

11533
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11534 11535

error:
11536
    virDispatchError(conn);
11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562
    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)) {
11563
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11564
        virDispatchError(NULL);
11565 11566 11567 11568
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11569
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11570 11571 11572
        goto error;
    }
    if (value == NULL) {
11573
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585
        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;
    }

11586
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11587 11588

error:
11589
    virDispatchError(conn);
11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613
    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)) {
11614
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11615
        virDispatchError(NULL);
11616 11617 11618 11619
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11620
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11621 11622 11623
        goto error;
    }
    if (value_size == NULL) {
11624
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11625 11626 11627
        goto error;
    }

11628 11629
    flags &= VIR_SECRET_GET_VALUE_FLAGS_MASK;

11630 11631 11632 11633 11634 11635 11636 11637 11638
    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;
    }

11639
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11640 11641

error:
11642
    virDispatchError(conn);
11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664
    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)) {
11665
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11666
        virDispatchError(NULL);
11667 11668 11669 11670
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11671
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683
        goto error;
    }

    if (conn->secretDriver != NULL && conn->secretDriver->undefine != NULL) {
        int ret;

        ret = conn->secretDriver->undefine(secret);
        if (ret < 0)
            goto error;
        return ret;
    }

11684
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11685 11686

error:
11687
    virDispatchError(conn);
11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710
    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)) {
11711
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11712
        virDispatchError(NULL);
11713 11714 11715
        return -1;
    }
    virMutexLock(&secret->conn->lock);
11716
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
11728
 * Returns 0 on success, or -1 on error
11729 11730 11731 11732
 */
int
virSecretFree(virSecretPtr secret)
{
11733
    VIR_DEBUG("secret=%p", secret);
11734 11735 11736 11737

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
11738
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
11739
        virDispatchError(NULL);
11740 11741
        return -1;
    }
11742 11743
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
11744
        return -1;
11745
    }
11746 11747
    return 0;
}
11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774


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

11775
    VIR_DEBUG("conn=%p, flags=%u", conn, flags);
11776 11777 11778 11779

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11780
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11781
        virDispatchError(NULL);
11782
        return NULL;
11783 11784 11785 11786 11787
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;
11788 11789
    else
        virDispatchError(conn);
11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809

    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))) {
11810
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
11811
        virDispatchError(NULL);
11812
        return -1;
11813 11814
    }
    virMutexLock(&stream->conn->lock);
11815
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830
    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
11831
 * it should call virStreamFinish to wait for successful
11832 11833 11834 11835 11836 11837 11838 11839 11840
 * 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 已提交
11841
 * An example using this with a hypothetical file upload
11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889
 * 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)
{
11890
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
11891 11892 11893 11894

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11895
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11896
        virDispatchError(NULL);
11897
        return -1;
11898 11899
    }

11900 11901 11902 11903 11904
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915
    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;
    }

11916
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11917 11918

error:
11919
    virDispatchError(stream->conn);
11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937
    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 已提交
11938
 * An example using this with a hypothetical file download
11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989
 * 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)
{
11990
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
11991 11992 11993 11994

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11995
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11996
        virDispatchError(NULL);
11997
        return -1;
11998 11999
    }

12000 12001 12002 12003 12004
    if (data == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015
    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;
    }

12016
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12017 12018

error:
12019
    virDispatchError(stream->conn);
12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033
    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 已提交
12034
 * An example using this with a hypothetical file upload
12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055
 * 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);
 *
12056
 * Returns 0 if all the data was successfully sent. The caller
12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070
 * 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;
12071
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
12072 12073 12074 12075

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12076
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12077
        virDispatchError(NULL);
12078
        return -1;
12079 12080
    }

12081 12082 12083 12084 12085
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

12086
    if (stream->flags & VIR_STREAM_NONBLOCK) {
12087
        virLibConnError(VIR_ERR_OPERATION_INVALID,
12088 12089 12090 12091 12092
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
12093
        virReportOOMError();
12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119
        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)
12120
        virDispatchError(stream->conn);
12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135

    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 已提交
12136
 * An example using this with a hypothetical file download
12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157
 * 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);
 *
12158
 * Returns 0 if all the data was successfully received. The caller
12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172
 * 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;
12173
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
12174 12175 12176 12177

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12178
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12179
        virDispatchError(NULL);
12180
        return -1;
12181 12182
    }

12183 12184 12185 12186 12187
    if (handler == NULL) {
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto cleanup;
    }

12188
    if (stream->flags & VIR_STREAM_NONBLOCK) {
12189
        virLibConnError(VIR_ERR_OPERATION_INVALID,
12190 12191 12192 12193 12194 12195
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
12196
        virReportOOMError();
12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222
        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)
12223
        virDispatchError(stream->conn);
12224 12225 12226 12227 12228 12229

    return ret;
}


/**
M
Matthias Bolte 已提交
12230
 * virStreamEventAddCallback:
12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249
 * @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)
{
12250
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
12251 12252 12253 12254

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12255
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12256
        virDispatchError(NULL);
12257
        return -1;
12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268
    }

    if (stream->driver &&
        stream->driver->streamAddCallback) {
        int ret;
        ret = (stream->driver->streamAddCallback)(stream, events, cb, opaque, ff);
        if (ret < 0)
            goto error;
        return ret;
    }

12269
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12270 12271

error:
12272
    virDispatchError(stream->conn);
12273 12274 12275 12276 12277
    return -1;
}


/**
M
Matthias Bolte 已提交
12278
 * virStreamEventUpdateCallback:
12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291
 * @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)
{
12292
    VIR_DEBUG("stream=%p, events=%d", stream, events);
12293 12294 12295 12296

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12297
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12298
        virDispatchError(NULL);
12299
        return -1;
12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310
    }

    if (stream->driver &&
        stream->driver->streamUpdateCallback) {
        int ret;
        ret = (stream->driver->streamUpdateCallback)(stream, events);
        if (ret < 0)
            goto error;
        return ret;
    }

12311
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12312 12313

error:
12314
    virDispatchError(stream->conn);
12315 12316 12317 12318
    return -1;
}

/**
M
Matthias Bolte 已提交
12319
 * virStreamEventRemoveCallback:
12320 12321
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
12322
 * Remove an event callback from the stream
12323 12324 12325 12326 12327
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
12328
    VIR_DEBUG("stream=%p", stream);
12329 12330 12331 12332

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12333
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12334
        virDispatchError(NULL);
12335
        return -1;
12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346
    }

    if (stream->driver &&
        stream->driver->streamRemoveCallback) {
        int ret;
        ret = (stream->driver->streamRemoveCallback)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

12347
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12348 12349

error:
12350
    virDispatchError(stream->conn);
12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370
    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)
{
12371
    VIR_DEBUG("stream=%p", stream);
12372 12373 12374 12375

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12376
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12377
        virDispatchError(NULL);
12378
        return -1;
12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389
    }

    if (stream->driver &&
        stream->driver->streamFinish) {
        int ret;
        ret = (stream->driver->streamFinish)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

12390
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12391 12392

error:
12393
    virDispatchError(stream->conn);
12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411
    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)
{
12412
    VIR_DEBUG("stream=%p", stream);
12413 12414 12415 12416

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12417
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12418
        virDispatchError(NULL);
12419
        return -1;
12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430
    }

    if (stream->driver &&
        stream->driver->streamAbort) {
        int ret;
        ret = (stream->driver->streamAbort)(stream);
        if (ret < 0)
            goto error;
        return ret;
    }

12431
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12432 12433

error:
12434
    virDispatchError(stream->conn);
12435 12436 12437 12438 12439 12440 12441 12442 12443 12444
    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 已提交
12445
 * There must not be an active data transfer in progress
12446 12447 12448 12449 12450 12451 12452 12453
 * 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)
{
12454
    VIR_DEBUG("stream=%p", stream);
12455 12456 12457 12458

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
12459
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12460
        virDispatchError(NULL);
12461
        return -1;
12462 12463 12464 12465
    }

    /* XXX Enforce shutdown before free'ing resources ? */

12466 12467
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
12468
        return -1;
12469
    }
12470
    return 0;
12471
}
12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483


/**
 * 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)
{
12484
    VIR_DEBUG("dom=%p", dom);
12485 12486 12487 12488

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12489
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12490
        virDispatchError(NULL);
12491
        return -1;
12492 12493 12494 12495 12496 12497 12498 12499 12500
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

12501
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12502
error:
12503
    virDispatchError(dom->conn);
12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517
    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)
{
12518
    VIR_DOMAIN_DEBUG(dom);
12519 12520 12521 12522

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12523
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12524
        virDispatchError(NULL);
12525
        return -1;
12526 12527 12528 12529 12530 12531 12532 12533 12534
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

12535
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12536
error:
12537
    virDispatchError(dom->conn);
12538 12539 12540
    return -1;
}

12541 12542 12543 12544 12545 12546 12547 12548 12549 12550
/**
 * 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)
{
12551
    VIR_DOMAIN_DEBUG(dom);
12552 12553 12554 12555

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12556
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12557
        virDispatchError(NULL);
12558
        return -1;
12559 12560 12561 12562 12563 12564 12565 12566 12567
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

12568
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12569 12570 12571 12572 12573
error:
    virDispatchError(dom->conn);
    return -1;
}

12574 12575 12576 12577 12578 12579 12580 12581 12582 12583
/**
 * 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)
{
12584
    VIR_DEBUG("net=%p", net);
12585 12586 12587 12588

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
12589
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12590
        virDispatchError(NULL);
12591
        return -1;
12592 12593 12594 12595 12596 12597 12598 12599 12600
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

12601
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12602
error:
12603
    virDispatchError(net->conn);
12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618
    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)
{
12619
    VIR_DEBUG("net=%p", net);
12620 12621 12622 12623

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
12624
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12625
        virDispatchError(NULL);
12626
        return -1;
12627 12628 12629 12630 12631 12632 12633 12634 12635
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

12636
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12637
error:
12638
    virDispatchError(net->conn);
12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652
    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)
{
12653
    VIR_DEBUG("pool=%p", pool);
12654 12655 12656 12657

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
12658
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12659
        virDispatchError(NULL);
12660
        return -1;
12661 12662 12663 12664 12665 12666 12667 12668 12669
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

12670
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12671
error:
12672
    virDispatchError(pool->conn);
12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687
    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)
{
12688
    VIR_DEBUG("pool=%p", pool);
12689 12690 12691 12692

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
12693
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12694
        virDispatchError(NULL);
12695
        return -1;
12696 12697 12698 12699 12700 12701 12702 12703 12704
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

12705
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12706
error:
12707
    virDispatchError(pool->conn);
12708 12709 12710 12711
    return -1;
}


S
Stefan Berger 已提交
12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723

/**
 * 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)
{
12724
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
12725 12726 12727 12728

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12729
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741
        virDispatchError(NULL);
        return -1;
    }

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

12742
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762

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)
{
12763
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
12764 12765 12766 12767

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12768
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12769 12770 12771 12772 12773
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
12774
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785
        goto error;
    }

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

12786
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806

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)
{
12807
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
12808 12809 12810 12811

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12812
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12813
        virDispatchError(NULL);
12814
        return NULL;
S
Stefan Berger 已提交
12815 12816
    }
    if (name == NULL) {
12817
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828
        goto  error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByName) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

12829
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848

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)
{
12849
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
S
Stefan Berger 已提交
12850 12851 12852 12853

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12854
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12855
        virDispatchError(NULL);
12856
        return NULL;
S
Stefan Berger 已提交
12857 12858
    }
    if (uuid == NULL) {
12859
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->nwfilterLookupByUUID){
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->nwfilterLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }

12871
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12872 12873 12874 12875 12876 12877 12878

error:
    virDispatchError(conn);
    return NULL;
}

/**
12879
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891
 * @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];
12892
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
S
Stefan Berger 已提交
12893 12894 12895 12896

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12897
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12898
        virDispatchError(NULL);
12899
        return NULL;
S
Stefan Berger 已提交
12900 12901
    }
    if (uuidstr == NULL) {
12902
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12903 12904 12905 12906
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
12907
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929
        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)
{
12930
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12931 12932 12933 12934

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
12935
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957
        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)
{
12958
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12959 12960 12961 12962

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12963
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12964
        virDispatchError(NULL);
12965
        return NULL;
S
Stefan Berger 已提交
12966
    }
12967
    return nwfilter->name;
S
Stefan Berger 已提交
12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981
}

/**
 * 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)
{
12982
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
12983 12984 12985 12986

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12987
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12988 12989 12990 12991
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
12992
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018
        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];
13019
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
13020 13021 13022 13023

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
13024
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
13025 13026 13027 13028
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
13029
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057
        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)
{
13058
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
13059 13060 13061 13062

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13063
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
13064
        virDispatchError(NULL);
13065
        return NULL;
S
Stefan Berger 已提交
13066 13067
    }
    if (xmlDesc == NULL) {
13068
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13069 13070 13071
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
13072
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
13073 13074 13075 13076 13077
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
E
Eric Blake 已提交
13078
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc);
S
Stefan Berger 已提交
13079 13080 13081 13082 13083
        if (!ret)
            goto error;
        return ret;
    }

13084
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105

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;
13106
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
13107 13108 13109 13110

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
13111
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
13112 13113 13114 13115 13116 13117
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13118
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->undefine) {
        int ret;
        ret = conn->nwfilterDriver->undefine (nwfilter);
        if (ret < 0)
            goto error;
        return ret;
    }

13130
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152

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;
13153
    VIR_DEBUG("nwfilter=%p, flags=%d", nwfilter, flags);
S
Stefan Berger 已提交
13154 13155 13156 13157

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
13158
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
13159
        virDispatchError(NULL);
13160
        return NULL;
S
Stefan Berger 已提交
13161 13162
    }
    if (flags != 0) {
13163
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176
        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;
    }

13177
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205

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))) {
13206
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
13207 13208 13209 13210
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
13211
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
13212 13213 13214 13215 13216 13217
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


13218 13219 13220 13221 13222 13223 13224 13225 13226 13227
/**
 * 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)
{
13228
    VIR_DEBUG("iface=%p", iface);
13229 13230 13231 13232

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
13233
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13234
        virDispatchError(NULL);
13235
        return -1;
13236 13237 13238 13239 13240 13241 13242 13243 13244
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

13245
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13246
error:
13247
    virDispatchError(iface->conn);
13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261
    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)
{
13262
    VIR_DEBUG("conn=%p", conn);
13263 13264 13265 13266

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13267
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13268
        virDispatchError(NULL);
13269
        return -1;
13270 13271 13272 13273 13274 13275 13276 13277 13278
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

13279
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13280
error:
13281
    virDispatchError(conn);
13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298
    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)
{
13299
    VIR_DEBUG("conn=%p", conn);
13300 13301 13302 13303

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13304
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13305
        virDispatchError(NULL);
13306
        return -1;
13307 13308 13309 13310 13311 13312 13313 13314 13315
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

13316
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13317
error:
13318
    virDispatchError(conn);
13319 13320
    return -1;
}
J
Jiri Denemark 已提交
13321 13322 13323 13324 13325


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
13326 13327 13328 13329
 * @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 已提交
13330 13331 13332 13333 13334 13335 13336 13337
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
13338
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%u", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
13339 13340 13341 13342

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13343
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13344
        virDispatchError(NULL);
J
Jiri Denemark 已提交
13345 13346 13347
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
13348
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360
        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;
    }

13361
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
13362 13363

error:
13364
    virDispatchError(conn);
J
Jiri Denemark 已提交
13365 13366
    return VIR_CPU_COMPARE_ERROR;
}
13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399


/**
 * 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)) {
13400
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13401 13402 13403 13404
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
13405
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417
        goto error;
    }

    if (conn->driver->cpuBaseline) {
        char *cpu;

        cpu = conn->driver->cpuBaseline(conn, xmlCPUs, ncpus, flags);
        if (!cpu)
            goto error;
        return cpu;
    }

13418
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13419 13420 13421 13422 13423

error:
    virDispatchError(conn);
    return NULL;
}
13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439


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

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
13442 13443 13444 13445

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13446
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13447
        virDispatchError(NULL);
13448
        return -1;
13449 13450
    }
    if (info == NULL) {
13451
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466
        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;
    }

13467
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13468 13469 13470 13471 13472

error:
    virDispatchError(domain->conn);
    return -1;
}
13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489


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

13490
    VIR_DOMAIN_DEBUG(domain);
13491 13492 13493 13494

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13495
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13496
        virDispatchError(NULL);
13497
        return -1;
13498 13499 13500 13501
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13502
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513
        goto error;
    }

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

13514
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13515 13516 13517 13518 13519

error:
    virDispatchError(conn);
    return -1;
}
13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540


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

13541
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%u", downtime, flags);
13542 13543 13544 13545

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13546
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13547 13548 13549 13550 13551 13552
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13553
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13554 13555 13556 13557 13558 13559 13560 13561 13562
        goto error;
    }

    if (conn->driver->domainMigrateSetMaxDowntime) {
        if (conn->driver->domainMigrateSetMaxDowntime(domain, downtime, flags) < 0)
            goto error;
        return 0;
    }

13563
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13564 13565 13566 13567 13568
error:
    virDispatchError(conn);
    return -1;
}

13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615
/**
 * 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;
}

13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637
/**
 * 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.
13638 13639
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656
 * 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)
{
13657 13658 13659
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

13660 13661 13662
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13663
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13664
        virDispatchError(NULL);
13665
        return -1;
13666 13667 13668
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
13669
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13670
        virDispatchError(conn);
13671
        return -1;
13672 13673
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
13674
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685
        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;
    }

13686
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13687 13688 13689 13690
error:
    virDispatchError(conn);
    return -1;
}
13691

13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705
/**
 * 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)
{
13706
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
13707 13708 13709 13710

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
13711
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
13712
        virDispatchError(NULL);
13713
        return -1;
13714 13715
    }
    if (callbackID < 0) {
13716
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
13717 13718 13719 13720 13721 13722 13723 13724 13725 13726
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

13727
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13728 13729 13730 13731
error:
    virDispatchError(conn);
    return -1;
}
13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751

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

13752
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
13753 13754 13755 13756

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
13757
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13758 13759 13760 13761 13762 13763
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13764
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776
        goto error;
    }

    if (conn->driver->domainManagedSave) {
        int ret;

        ret = conn->driver->domainManagedSave(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

13777
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799

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;

13800
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
13801 13802 13803 13804

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
13805
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820
        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;
    }

13821
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
13833
 * Remove any managed save image for this domain.
13834 13835 13836 13837 13838 13839 13840
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

13841
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
13842 13843 13844 13845

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
13846
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13847 13848 13849 13850 13851 13852
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13853
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865
        goto error;
    }

    if (conn->driver->domainManagedSaveRemove) {
        int ret;

        ret = conn->driver->domainManagedSaveRemove(dom, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

13866
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13867 13868 13869 13870 13871

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890

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

13891
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%u", xmlDesc, flags);
C
Chris Lalancette 已提交
13892 13893 13894 13895

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13896
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13897 13898 13899 13900 13901
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
13902 13903 13904 13905 13906 13907

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

C
Chris Lalancette 已提交
13908
    if (conn->flags & VIR_CONNECT_RO) {
13909
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920
        goto error;
    }

    if (conn->driver->domainSnapshotCreateXML) {
        virDomainSnapshotPtr ret;
        ret = conn->driver->domainSnapshotCreateXML(domain, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }

13921
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941
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;
13942
    VIR_DEBUG("snapshot=%p, flags=%d", snapshot, flags);
C
Chris Lalancette 已提交
13943 13944 13945 13946

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13947
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13948 13949
                                  __FUNCTION__);
        virDispatchError(NULL);
13950
        return NULL;
C
Chris Lalancette 已提交
13951 13952 13953 13954 13955
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
13956
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
13957 13958 13959 13960
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

13961
    if (conn->driver->domainSnapshotGetXMLDesc) {
C
Chris Lalancette 已提交
13962
        char *ret;
13963
        ret = conn->driver->domainSnapshotGetXMLDesc(snapshot, flags);
C
Chris Lalancette 已提交
13964 13965 13966 13967 13968
        if (!ret)
            goto error;
        return ret;
    }

13969
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987
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;
13988

13989
    VIR_DOMAIN_DEBUG(domain);
C
Chris Lalancette 已提交
13990 13991 13992 13993

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13994
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006
        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;
    }

14007
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031
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;

14032 14033
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%u",
                     names, nameslen, flags);
C
Chris Lalancette 已提交
14034 14035 14036 14037

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14038
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14039 14040 14041 14042 14043 14044 14045
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
14046
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057
        goto error;
    }

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

14058
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081
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;
14082 14083

    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%u", name, flags);
C
Chris Lalancette 已提交
14084 14085 14086 14087

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14088
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14089
        virDispatchError(NULL);
14090
        return NULL;
C
Chris Lalancette 已提交
14091 14092 14093 14094 14095
    }

    conn = domain->conn;

    if (name == NULL) {
14096
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107
        goto error;
    }

    if (conn->driver->domainSnapshotLookupByName) {
        virDomainSnapshotPtr dom;
        dom = conn->driver->domainSnapshotLookupByName(domain, name, flags);
        if (!dom)
            goto error;
        return dom;
    }

14108
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126
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;
14127 14128

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
14129 14130 14131 14132

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14133
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146
        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;
    }

14147
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168
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;
14169 14170

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
14171 14172 14173 14174

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
14175
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
14176
        virDispatchError(NULL);
14177
        return NULL;
C
Chris Lalancette 已提交
14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

14190
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14191 14192 14193 14194 14195 14196
error:
    virDispatchError(conn);
    return NULL;
}

/**
14197
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210
 * @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;

14211
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
14212 14213 14214 14215

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
14216
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
14217 14218 14219 14220 14221 14222
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
14223 14224 14225 14226
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
14227 14228 14229 14230 14231 14232 14233 14234

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

14235
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14236 14237 14238 14239 14240 14241
error:
    virDispatchError(conn);
    return -1;
}

/**
14242
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260
 * @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;

14261
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
14262 14263 14264 14265

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
14266
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
14267 14268 14269 14270 14271 14272
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
14273 14274 14275 14276
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
14277 14278 14279 14280 14281 14282 14283 14284

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

14285
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302
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)
{
14303
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
14304 14305 14306 14307

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
14308
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
14309 14310 14311 14312 14313 14314 14315 14316 14317 14318
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341

/**
 * 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;
14342 14343 14344

    VIR_DOMAIN_DEBUG(dom, "devname=%s, st=%p, flags=%u",
                     NULLSTR(devname), st, flags);
14345 14346 14347 14348

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
14349
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
14350 14351 14352 14353 14354 14355
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
14356
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
        ret = conn->driver->domainOpenConsole(dom, devname, st, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

14368
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
14369 14370 14371 14372 14373

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