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

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

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

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

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

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

74 75
#define VIR_FROM_THIS VIR_FROM_NONE

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

82
#define MAX_DRIVERS 20
83

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

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 136
#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

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

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

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

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

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

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

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

        default:
            return -1;
200 201
        }

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

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

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;

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

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

315 316 317 318 319 320 321 322 323 324 325 326 327 328
/* Helper macro to print debugging information about a domain DOM,
 * followed by a literal string FMT and any other printf arguments.
 */
#define VIR_DOMAIN_DEBUG(dom, fmt, ...)                   \
    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;                           \
    }                                                     \
                                                          \
329
    VIR_DEBUG("dom=%p, (VM: name=%s, uuid=%s), " fmt,         \
330 331 332
          dom, NULLSTR(_domname), _uuidstr, __VA_ARGS__)

#define VIR_DOMAIN_DEBUG0(dom) VIR_DOMAIN_DEBUG(dom, "%s", "")
D
Daniel P. Berrange 已提交
333

334 335 336 337 338 339 340 341 342 343 344 345 346
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
    if (initialized)
347
        return 0;
348

349
    initialized = 1;
350

351
    if (virThreadInitialize() < 0 ||
352 353
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
354 355
        return -1;

D
Daniel P. Berrange 已提交
356 357 358
    gcry_control(GCRYCTL_SET_THREAD_CBS, &virTLSThreadImpl);
    gcry_check_version(NULL);

359
    virLogSetFromEnv();
360

361
    VIR_DEBUG0("register drivers");
362

363 364 365 366
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

367
    if (!bindtextdomain(PACKAGE, LOCALEDIR))
368
        return -1;
369

370
    /*
371 372
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
373
     */
374 375 376
#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 已提交
377
     * If they try to open a connection for a module that
378 379
     * is not loaded they'll get a suitable error at that point
     */
380
# ifdef WITH_TEST
381
    virDriverLoadModule("test");
382 383
# endif
# ifdef WITH_XEN
384
    virDriverLoadModule("xen");
385 386
# endif
# ifdef WITH_OPENVZ
387
    virDriverLoadModule("openvz");
388
# endif
389 390 391
# ifdef WITH_VMWARE
    virDriverLoadModule("vmware");
# endif
392
# ifdef WITH_VBOX
393
    virDriverLoadModule("vbox");
394 395
# endif
# ifdef WITH_ESX
396
    virDriverLoadModule("esx");
397 398
# endif
# ifdef WITH_XENAPI
399
    virDriverLoadModule("xenapi");
400 401
# endif
# ifdef WITH_REMOTE
402
    virDriverLoadModule("remote");
403
# endif
404
#else
405
# ifdef WITH_TEST
406
    if (testRegister() == -1) return -1;
407 408
# endif
# ifdef WITH_XEN
409
    if (xenRegister () == -1) return -1;
410 411
# endif
# ifdef WITH_OPENVZ
412
    if (openvzRegister() == -1) return -1;
413
# endif
414 415 416
# ifdef WITH_VMWARE
    if (vmwareRegister() == -1) return -1;
# endif
417
# ifdef WITH_PHYP
418
    if (phypRegister() == -1) return -1;
419 420
# endif
# ifdef WITH_VBOX
421
    if (vboxRegister() == -1) return -1;
422 423
# endif
# ifdef WITH_ESX
424
    if (esxRegister() == -1) return -1;
425
# endif
426 427 428
# ifdef WITH_XENAPI
    if (xenapiRegister() == -1) return -1;
# endif
429
# ifdef WITH_REMOTE
430
    if (remoteRegister () == -1) return -1;
431
# endif
432
#endif
D
Daniel P. Berrange 已提交
433

434
    return 0;
435 436
}

437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
#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
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
#define virLibConnError(code, ...)                                \
    virReportErrorHelper(NULL, VIR_FROM_NONE, code, __FILE__,     \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibDomainError(code, ...)                              \
    virReportErrorHelper(NULL, VIR_FROM_DOM, code, __FILE__,      \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNetworkError(code, ...)                             \
    virReportErrorHelper(NULL, VIR_FROM_NETWORK, code, __FILE__,  \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStoragePoolError(code, ...)                         \
    virReportErrorHelper(NULL, VIR_FROM_STORAGE, code, __FILE__,  \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStorageVolError(code, ...)                          \
    virReportErrorHelper(NULL, VIR_FROM_STORAGE, code, __FILE__,  \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibInterfaceError(code, ...)                           \
    virReportErrorHelper(NULL, VIR_FROM_INTERFACE, code, __FILE__,\
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNodeDeviceError(code, ...)                          \
    virReportErrorHelper(NULL, VIR_FROM_NODEDEV, code, __FILE__,  \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibSecretError(code, ...)                              \
    virReportErrorHelper(NULL, VIR_FROM_SECRET, code, __FILE__,   \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStreamError(code, ...)                              \
    virReportErrorHelper(NULL, VIR_FROM_STREAMS, code, __FILE__,  \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNWFilterError(code, ...)                            \
    virReportErrorHelper(NULL, VIR_FROM_NWFILTER, code, __FILE__, \
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibDomainSnapshotError(code, ...)                            \
    virReportErrorHelper(NULL, VIR_FROM_DOMAIN_SNAPSHOT, code, __FILE__, \
503
                         __FUNCTION__, __LINE__, __VA_ARGS__)
504

C
Chris Lalancette 已提交
505

506 507 508 509 510 511 512 513 514 515 516
/**
 * 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)
{
517 518 519 520
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
521
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
522
        return -1;
523 524 525
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
526 527 528
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
529
        return -1;
530 531
    }

532
    VIR_DEBUG ("registering %s as network driver %d",
533 534
           driver->name, virNetworkDriverTabCount);

535 536
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
537 538
}

D
Daniel Veillard 已提交
539 540
/**
 * virRegisterInterfaceDriver:
L
Laine Stump 已提交
541
 * @driver: pointer to an interface driver block
D
Daniel Veillard 已提交
542
 *
L
Laine Stump 已提交
543
 * Register an interface virtualization driver
D
Daniel Veillard 已提交
544 545 546 547 548 549 550 551 552 553
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterInterfaceDriver(virInterfaceDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
554
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
555
        return -1;
D
Daniel Veillard 已提交
556 557 558
    }

    if (virInterfaceDriverTabCount >= MAX_DRIVERS) {
559 560 561
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
562
        return -1;
D
Daniel Veillard 已提交
563 564
    }

565
    VIR_DEBUG ("registering %s as interface driver %d",
D
Daniel Veillard 已提交
566 567 568 569 570 571
           driver->name, virInterfaceDriverTabCount);

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

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
/**
 * 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) {
587
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
588
        return -1;
589 590 591
    }

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

598
    VIR_DEBUG ("registering %s as storage driver %d",
599 600
           driver->name, virStorageDriverTabCount);

601 602 603 604
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

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

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

631
    VIR_DEBUG ("registering %s as device driver %d",
632 633
           driver->name, virDeviceMonitorTabCount);

634 635 636 637
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

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

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

664
    VIR_DEBUG ("registering %s as secret driver %d",
665 666 667 668 669 670
           driver->name, virSecretDriverTabCount);

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

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

    if (virNWFilterDriverTabCount >= MAX_DRIVERS) {
691 692 693
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
S
Stefan Berger 已提交
694 695 696
        return -1;
    }

697
    VIR_DEBUG ("registering %s as network filter driver %d",
S
Stefan Berger 已提交
698 699 700 701 702 703 704
           driver->name, virNWFilterDriverTabCount);

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


705 706 707 708 709 710 711 712 713 714 715
/**
 * 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)
{
716
    VIR_DEBUG("driver=%p name=%s", driver, driver ? NULLSTR(driver->name) : "(null)");
717

718
    if (virInitialize() < 0)
719
        return -1;
720 721

    if (driver == NULL) {
722
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
723
        return -1;
724 725 726
    }

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

733
    if (driver->no < 0) {
734 735
        virLibConnError(VIR_ERR_INVALID_ARG,
                        _("Tried to register an internal Xen driver"));
736 737 738
        return -1;
    }

739
    VIR_DEBUG ("registering %s as driver %d",
740 741
           driver->name, virDriverTabCount);

742 743
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
744 745
}

A
Atsushi SAKAI 已提交
746
#ifdef WITH_LIBVIRTD
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
/**
 * 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) {
762
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
763
        return -1;
764 765 766
    }

    if (virStateDriverTabCount >= MAX_DRIVERS) {
767 768 769
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
                        _("Too many drivers, cannot register %s"),
                        driver->name);
770
        return -1;
771 772 773 774 775 776
    }

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

777 778
/**
 * virStateInitialize:
E
Eric Blake 已提交
779
 * @privileged: set to 1 if running with root privilege, 0 otherwise
780 781 782
 *
 * Initialize all virtualization drivers.
 *
783
 * Returns 0 if all succeed, -1 upon any failure.
784
 */
785
int virStateInitialize(int privileged) {
786 787 788 789 790 791
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
792
        if (virStateDriverTab[i]->initialize &&
793
            virStateDriverTab[i]->initialize(privileged) < 0) {
794
            VIR_ERROR(_("Initialization of %s state driver failed"),
795
                      virStateDriverTab[i]->name);
796
            ret = -1;
797
        }
798 799 800 801
    }
    return ret;
}

802 803 804 805 806
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
807
 * Returns 0 if all succeed, -1 upon any failure.
808
 */
D
Daniel P. Berrange 已提交
809
int virStateCleanup(void) {
810 811 812
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
813 814
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
815 816 817 818 819
            ret = -1;
    }
    return ret;
}

820 821 822 823 824
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
825
 * Returns 0 if all succeed, -1 upon any failure.
826
 */
D
Daniel P. Berrange 已提交
827
int virStateReload(void) {
828 829 830
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
831 832
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
833 834 835 836 837
            ret = -1;
    }
    return ret;
}

838 839 840 841 842
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
843
 * Returns 0 if none are active, 1 if at least one is.
844
 */
D
Daniel P. Berrange 已提交
845
int virStateActive(void) {
846 847 848
    int i, ret = 0;

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

A
Atsushi SAKAI 已提交
856
#endif
857

858 859


860 861 862
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
863
 * @type: the type of connection/driver looked at
864 865 866 867 868
 * @typeVer: return value for the version of the hypervisor (OUT)
 *
 * Provides two information back, @libVer is the version of the library
 * while @typeVer will be the version of the hypervisor type @type against
 * which the library was compiled. If @type is NULL, "Xen" is assumed, if
D
Daniel Veillard 已提交
869
 * @type is unknown or not available, an error code will be returned and
870 871 872 873 874 875
 * @typeVer will be 0.
 *
 * 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
876 877 878
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
879
    VIR_DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
880

881
    if (!initialized)
882
        if (virInitialize() < 0)
883
            goto error;
884

885
    if (libVer == NULL)
886
        goto error;
887 888 889
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
890
        if (type == NULL)
891
            type = "Xen";
892 893 894 895 896

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

899
# if WITH_XEN
900 901
        if (STRCASEEQ(type, "Xen"))
            *typeVer = xenUnifiedVersion();
902 903
# endif
# if WITH_TEST
904 905
        if (STRCASEEQ(type, "Test"))
            *typeVer = LIBVIR_VERSION_NUMBER;
906 907
# endif
# if WITH_QEMU
908 909
        if (STRCASEEQ(type, "QEMU"))
            *typeVer = LIBVIR_VERSION_NUMBER;
910 911
# endif
# if WITH_LXC
912 913
        if (STRCASEEQ(type, "LXC"))
            *typeVer = LIBVIR_VERSION_NUMBER;
914 915
# endif
# if WITH_PHYP
916 917
        if (STRCASEEQ(type, "phyp"))
            *typeVer = LIBVIR_VERSION_NUMBER;
918 919
# endif
# if WITH_OPENVZ
920 921
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
922
# endif
923 924 925 926
# if WITH_VMWARE
        if (STRCASEEQ(type, "VMware"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
927
# if WITH_VBOX
928 929
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
930 931
# endif
# if WITH_UML
932 933
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
934 935
# endif
# if WITH_ONE
D
Daniel Veillard 已提交
936 937
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
938 939
# endif
# if WITH_ESX
940 941
        if (STRCASEEQ(type, "ESX"))
            *typeVer = LIBVIR_VERSION_NUMBER;
942
# endif
943 944 945 946
# if WITH_XENAPI
        if (STRCASEEQ(type, "XenAPI"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
947
# if WITH_REMOTE
948 949
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
950
# endif
951
        if (*typeVer == 0) {
952
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
953
            goto error;
954
        }
955
#endif /* WITH_DRIVER_MODULES */
956
    }
957
    return 0;
958 959 960 961

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

964
static virConnectPtr
965 966 967
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
968
{
969
    int i, res;
970 971
    virConnectPtr ret;

972 973
    virResetLastError();

974 975 976
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
977

978 979 980 981 982 983 984 985
    /*
     *  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) {
986
            VIR_DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
987 988
            name = defname;
        } else {
989
            name = NULL;
990
        }
991
    }
992

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    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) {
1006 1007
            virLibConnError(VIR_ERR_INVALID_ARG,
                            _("could not parse connection URI"));
1008 1009
            goto failed;
        }
1010

1011
        VIR_DEBUG("name \"%s\" to URI components:\n"
1012 1013 1014 1015 1016 1017 1018 1019
              "  scheme %s\n"
              "  opaque %s\n"
              "  authority %s\n"
              "  server %s\n"
              "  user %s\n"
              "  port %d\n"
              "  path %s\n",
              name,
1020 1021 1022 1023
              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));
1024
    } else {
1025
        VIR_DEBUG0("no name, allowing driver auto-select");
1026 1027
    }

1028 1029 1030
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1031
    for (i = 0; i < virDriverTabCount; i++) {
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
        /* 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
1046
             STRCASEEQ(ret->uri->scheme, "vpx") ||
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
             STRCASEEQ(ret->uri->scheme, "esx") ||
             STRCASEEQ(ret->uri->scheme, "gsx") ||
#endif
#ifndef WITH_XENAPI
             STRCASEEQ(ret->uri->scheme, "xenapi") ||
#endif
             false)) {
            virReportErrorHelper(NULL, VIR_FROM_NONE, VIR_ERR_INVALID_ARG,
                                 __FILE__, __FUNCTION__, __LINE__,
                                 _("libvirt was built without the '%s' driver"),
                                 ret->uri->scheme);
            goto failed;
        }

1061
        VIR_DEBUG("trying driver %d (%s) ...",
1062
              i, virDriverTab[i]->name);
1063
        res = virDriverTab[i]->open (ret, auth, flags);
1064
        VIR_DEBUG("driver %d %s returned %s",
1065 1066 1067 1068
              i, virDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1069 1070 1071 1072 1073
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1074 1075
    }

1076
    if (!ret->driver) {
1077
        /* If we reach here, then all drivers declined the connection. */
1078 1079 1080
        virLibConnError(VIR_ERR_NO_CONNECT,
                        _("No connection for URI %s"),
                        NULLSTR(name));
1081
        goto failed;
1082 1083
    }

1084
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1085
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1086
        VIR_DEBUG("network driver %d %s returned %s",
1087 1088 1089 1090
              i, virNetworkDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
1091 1092 1093
        if (res == VIR_DRV_OPEN_ERROR) {
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1094 1095 1096
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1097
    }
1098

D
Daniel Veillard 已提交
1099 1100
    for (i = 0; i < virInterfaceDriverTabCount; i++) {
        res = virInterfaceDriverTab[i]->open (ret, auth, flags);
1101
        VIR_DEBUG("interface driver %d %s returned %s",
D
Daniel Veillard 已提交
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
              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;
        }
    }
1113 1114 1115

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1116
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1117
        VIR_DEBUG("storage driver %d %s returned %s",
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
              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;
        }
    }

1130 1131 1132
    /* Node driver (optional) */
    for (i = 0; i < virDeviceMonitorTabCount; i++) {
        res = virDeviceMonitorTab[i]->open (ret, auth, flags);
1133
        VIR_DEBUG("node driver %d %s returned %s",
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
              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;
        }
    }

1146 1147 1148
    /* Secret manipulation driver. Optional */
    for (i = 0; i < virSecretDriverTabCount; i++) {
        res = virSecretDriverTab[i]->open (ret, auth, flags);
1149
        VIR_DEBUG("secret driver %d %s returned %s",
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
              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 已提交
1162 1163 1164
    /* Network filter driver. Optional */
    for (i = 0; i < virNWFilterDriverTabCount; i++) {
        res = virNWFilterDriverTab[i]->open (ret, auth, flags);
1165
        VIR_DEBUG("nwfilter driver %d %s returned %s",
S
Stefan Berger 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
              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;
        }
    }

1178
    return ret;
1179 1180

failed:
1181 1182
    virUnrefConnect(ret);

1183
    return NULL;
1184 1185
}

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

1216
    VIR_DEBUG("name=%s", name);
1217 1218 1219 1220 1221 1222 1223 1224
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1225 1226
}

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

1250
    VIR_DEBUG("name=%s", name);
1251 1252 1253 1254 1255 1256 1257 1258
    ret = do_open (name, NULL, VIR_CONNECT_RO);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1259 1260 1261 1262 1263 1264 1265 1266
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1267
 * This function should be called first to get a connection to the
1268
 * Hypervisor. If necessary, authentication will be performed fetching
1269 1270
 * credentials via the callback
 *
1271 1272 1273
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1274 1275 1276 1277 1278 1279 1280 1281 1282
 * 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)
{
1283
    virConnectPtr ret = NULL;
1284 1285
    if (!initialized)
        if (virInitialize() < 0)
1286
            goto error;
1287

1288
    VIR_DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1289 1290 1291 1292 1293 1294 1295 1296
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1297 1298 1299
}

/**
1300
 * virConnectClose:
D
Daniel Veillard 已提交
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
 * @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
1311 1312
virConnectClose(virConnectPtr conn)
{
1313
    int ret = -1;
1314
    VIR_DEBUG("conn=%p", conn);
1315

1316 1317 1318
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1319
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1320
        goto error;
1321
    }
1322

1323 1324 1325 1326 1327 1328 1329 1330
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

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

1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
/**
 * 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 已提交
1347 1348
 *
 * Returns 0 in case of success, -1 in case of failure
1349 1350 1351 1352 1353
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
1354
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1355
        virDispatchError(NULL);
1356
        return -1;
1357 1358
    }
    virMutexLock(&conn->lock);
1359
    VIR_DEBUG("conn=%p refs=%d", conn, conn->refs);
1360 1361 1362 1363 1364
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1365 1366
/*
 * Not for public use.  This function is part of the internal
1367 1368 1369
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1370
virDrvSupportsFeature (virConnectPtr conn, int feature)
1371
{
1372
    int ret;
1373
    VIR_DEBUG("conn=%p, feature=%d", conn, feature);
1374

1375 1376 1377
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1378
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1379
        virDispatchError(NULL);
1380
        return -1;
1381
    }
1382

1383 1384 1385 1386
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1387 1388

    if (ret < 0)
1389
        virDispatchError(conn);
1390

1391
    return ret;
1392 1393
}

1394 1395 1396 1397 1398 1399 1400
/**
 * 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.
1401 1402 1403
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1404 1405
 */
const char *
1406 1407
virConnectGetType(virConnectPtr conn)
{
1408
    const char *ret;
1409
    VIR_DEBUG("conn=%p", conn);
1410

1411 1412
    virResetLastError();

D
Daniel Veillard 已提交
1413
    if (!VIR_IS_CONNECT(conn)) {
1414
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1415
        virDispatchError(NULL);
1416
        return NULL;
D
Daniel Veillard 已提交
1417
    }
1418 1419 1420 1421

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1422
    }
1423
    return conn->driver->name;
1424 1425
}

D
Daniel Veillard 已提交
1426
/**
1427
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1428
 * @conn: pointer to the hypervisor connection
1429
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1430
 *
1431
 * Get the version level of the Hypervisor running. This may work only with
1432
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1433
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1434
 *
1435 1436 1437
 * 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 已提交
1438
 */
1439
int
1440 1441
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1442
    VIR_DEBUG("conn=%p, hvVer=%p", conn, hvVer);
1443

1444 1445
    virResetLastError();

D
Daniel Veillard 已提交
1446
    if (!VIR_IS_CONNECT(conn)) {
1447
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1448
        virDispatchError(NULL);
1449
        return -1;
D
Daniel Veillard 已提交
1450
    }
1451

D
Daniel Veillard 已提交
1452
    if (hvVer == NULL) {
1453
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1454
        goto error;
D
Daniel Veillard 已提交
1455
    }
1456

1457 1458 1459 1460 1461 1462
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1463

1464
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1465 1466

error:
1467
    virDispatchError(conn);
1468
    return -1;
1469 1470
}

1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
/**
 * 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;
1486
    VIR_DEBUG("conn=%p, libVir=%p", conn, libVer);
1487 1488 1489 1490

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1491
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1492
        virDispatchError(NULL);
1493 1494 1495 1496
        return -1;
    }

    if (libVer == NULL) {
1497
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507
        goto error;
    }

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

1508 1509 1510
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1511
error:
1512
    virDispatchError(conn);
1513 1514 1515
    return ret;
}

1516 1517 1518 1519 1520
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
1521
 * running (the result of the gethostname system call).  If
1522 1523 1524 1525 1526 1527 1528 1529 1530
 * 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)
{
1531
    VIR_DEBUG("conn=%p", conn);
1532

1533 1534
    virResetLastError();

1535
    if (!VIR_IS_CONNECT(conn)) {
1536
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1537
        virDispatchError(NULL);
1538 1539 1540
        return NULL;
    }

1541 1542 1543 1544 1545 1546
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1547

1548
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1549 1550

error:
1551
    virDispatchError(conn);
1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
    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)
{
1573
    char *name;
1574
    VIR_DEBUG("conn=%p", conn);
1575

1576 1577
    virResetLastError();

1578
    if (!VIR_IS_CONNECT(conn)) {
1579
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1580
        virDispatchError(NULL);
1581 1582 1583
        return NULL;
    }

1584
    name = (char *)xmlSaveUri(conn->uri);
1585
    if (!name) {
1586
        virReportOOMError();
1587
        goto error;
1588 1589
    }
    return name;
1590 1591

error:
1592
    virDispatchError(conn);
1593
    return NULL;
1594 1595
}

E
Eric Blake 已提交
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
/**
 * 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)
{
1612
    VIR_DEBUG("conn=%p", conn);
E
Eric Blake 已提交
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635

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

1636 1637 1638 1639 1640
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1641
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1642 1643 1644 1645 1646 1647 1648 1649 1650
 * 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)
{
1651
    VIR_DEBUG("conn=%p, type=%s", conn, type);
1652

1653 1654
    virResetLastError();

1655
    if (!VIR_IS_CONNECT(conn)) {
1656
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1657
        virDispatchError(NULL);
1658
        return -1;
1659 1660
    }

1661 1662 1663 1664 1665 1666
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1667

1668
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1669
error:
1670
    virDispatchError(conn);
1671
    return -1;
1672 1673
}

1674
/**
1675
 * virConnectListDomains:
1676 1677 1678 1679 1680 1681 1682 1683 1684
 * @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
1685 1686
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1687
    VIR_DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);
1688

1689 1690
    virResetLastError();

D
Daniel Veillard 已提交
1691
    if (!VIR_IS_CONNECT(conn)) {
1692
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1693
        virDispatchError(NULL);
1694
        return -1;
D
Daniel Veillard 已提交
1695
    }
1696

1697
    if ((ids == NULL) || (maxids < 0)) {
1698
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1699
        goto error;
D
Daniel Veillard 已提交
1700
    }
1701

1702 1703 1704 1705 1706 1707
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1708

1709
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1710
error:
1711
    virDispatchError(conn);
1712
    return -1;
D
Daniel Veillard 已提交
1713 1714
}

K
 
Karel Zak 已提交
1715 1716 1717 1718
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1719 1720
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1721 1722 1723
 * Returns the number of domain found or -1 in case of error
 */
int
1724 1725
virConnectNumOfDomains(virConnectPtr conn)
{
1726
    VIR_DEBUG("conn=%p", conn);
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
    }
K
Karel Zak 已提交
1735

1736 1737 1738 1739 1740 1741
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1742

1743
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1744
error:
1745
    virDispatchError(conn);
1746
    return -1;
K
 
Karel Zak 已提交
1747 1748
}

1749 1750 1751 1752
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1753
 * Provides the connection pointer associated with a domain.  The
1754 1755 1756
 * reference counter on the connection is not increased by this
 * call.
 *
1757 1758 1759 1760
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1761 1762 1763 1764 1765
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1766
    VIR_DOMAIN_DEBUG0(dom);
1767

1768 1769 1770
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1771
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1772
        virDispatchError(NULL);
1773 1774 1775 1776 1777
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1778
/**
1779
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1780
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1781
 * @xmlDesc: string containing an XML description of the domain
1782
 * @flags: bitwise-or of supported virDomainCreateFlags
D
Daniel Veillard 已提交
1783
 *
1784
 * Launch a new guest domain, based on an XML description similar
1785
 * to the one returned by virDomainGetXMLDesc()
1786
 * This function may requires privileged access to the hypervisor.
1787 1788 1789
 * 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).
1790
 *
D
Daniel Veillard 已提交
1791 1792
 * Returns a new domain object or NULL in case of failure
 */
1793
virDomainPtr
1794 1795
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1796
{
1797
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);
1798

1799 1800
    virResetLastError();

D
Daniel Veillard 已提交
1801
    if (!VIR_IS_CONNECT(conn)) {
1802
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1803
        virDispatchError(NULL);
1804
        return NULL;
D
Daniel Veillard 已提交
1805 1806
    }
    if (xmlDesc == NULL) {
1807
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1808
        goto error;
D
Daniel Veillard 已提交
1809
    }
1810
    if (conn->flags & VIR_CONNECT_RO) {
1811
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1812
        goto error;
1813
    }
D
Daniel Veillard 已提交
1814

1815 1816 1817 1818 1819 1820 1821
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1822

1823
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1824
error:
1825
    virDispatchError(conn);
1826
    return NULL;
D
Daniel Veillard 已提交
1827 1828
}

1829 1830 1831 1832 1833 1834 1835 1836
/**
 * 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.
1837
 * This existing name will left indefinitely for API compatibility.
1838 1839 1840 1841 1842 1843 1844
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
{
1845
    return virDomainCreateXML(conn, xmlDesc, flags);
1846
}
1847

1848
/**
1849
 * virDomainLookupByID:
1850 1851 1852 1853
 * @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 已提交
1854 1855
 * 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.
1856
 *
1857 1858
 * 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.
1859
 */
1860
virDomainPtr
1861 1862
virDomainLookupByID(virConnectPtr conn, int id)
{
1863
    VIR_DEBUG("conn=%p, id=%d", conn, id);
1864

1865 1866
    virResetLastError();

D
Daniel Veillard 已提交
1867
    if (!VIR_IS_CONNECT(conn)) {
1868
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1869
        virDispatchError(NULL);
1870
        return NULL;
D
Daniel Veillard 已提交
1871 1872
    }
    if (id < 0) {
1873
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1874
        goto error;
D
Daniel Veillard 已提交
1875
    }
1876

1877 1878 1879 1880 1881 1882 1883
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1884

1885
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1886 1887

error:
1888
    virDispatchError(conn);
1889
    return NULL;
1890 1891 1892 1893 1894
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1895
 * @uuid: the raw UUID for the domain
1896 1897 1898
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1899 1900
 * 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.
1901 1902
 */
virDomainPtr
1903 1904
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1905 1906 1907
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    virUUIDFormat(uuid, uuidstr);

1908
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
1909

1910 1911
    virResetLastError();

D
Daniel Veillard 已提交
1912
    if (!VIR_IS_CONNECT(conn)) {
1913
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1914
        virDispatchError(NULL);
1915
        return NULL;
D
Daniel Veillard 已提交
1916 1917
    }
    if (uuid == NULL) {
1918
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1919
        goto error;
D
Daniel Veillard 已提交
1920
    }
1921

1922 1923 1924 1925 1926 1927 1928
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1929

1930
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1931 1932

error:
1933
    virDispatchError(conn);
1934
    return NULL;
1935 1936
}

K
Karel Zak 已提交
1937 1938 1939 1940 1941 1942 1943
/**
 * 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.
 *
1944 1945
 * 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 已提交
1946 1947 1948 1949
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1950
    unsigned char uuid[VIR_UUID_BUFLEN];
1951
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
1952

1953 1954
    virResetLastError();

K
Karel Zak 已提交
1955
    if (!VIR_IS_CONNECT(conn)) {
1956
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1957
        virDispatchError(NULL);
1958
        return NULL;
K
Karel Zak 已提交
1959 1960
    }
    if (uuidstr == NULL) {
1961
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1962
        goto error;
K
Karel Zak 已提交
1963
    }
1964 1965

    if (virUUIDParse(uuidstr, uuid) < 0) {
1966
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1967
        goto error;
K
Karel Zak 已提交
1968
    }
1969

K
Karel Zak 已提交
1970
    return virDomainLookupByUUID(conn, &uuid[0]);
1971 1972

error:
1973
    virDispatchError(conn);
1974
    return NULL;
K
Karel Zak 已提交
1975 1976
}

1977 1978 1979 1980 1981
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1982
 * Try to lookup a domain on the given hypervisor based on its name.
1983
 *
1984 1985
 * 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.
1986 1987
 */
virDomainPtr
1988 1989
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1990
    VIR_DEBUG("conn=%p, name=%s", conn, name);
1991

1992 1993
    virResetLastError();

D
Daniel Veillard 已提交
1994
    if (!VIR_IS_CONNECT(conn)) {
1995
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1996
        virDispatchError(NULL);
1997
        return NULL;
D
Daniel Veillard 已提交
1998 1999
    }
    if (name == NULL) {
2000
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2001
        goto error;
D
Daniel Veillard 已提交
2002
    }
2003

2004 2005 2006 2007 2008 2009 2010
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2011

2012
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2013 2014

error:
2015
    virDispatchError(conn);
2016
    return NULL;
2017 2018
}

D
Daniel Veillard 已提交
2019
/**
2020
 * virDomainDestroy:
D
Daniel Veillard 已提交
2021 2022 2023
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
2024 2025 2026
 * 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 已提交
2027 2028
 *
 * Returns 0 in case of success and -1 in case of failure.
2029
 */
D
Daniel Veillard 已提交
2030
int
2031 2032
virDomainDestroy(virDomainPtr domain)
{
2033
    virConnectPtr conn;
2034

2035
    VIR_DOMAIN_DEBUG0(domain);
2036

2037 2038
    virResetLastError();

D
Daniel Veillard 已提交
2039
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2040
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2041
        virDispatchError(NULL);
2042
        return -1;
D
Daniel Veillard 已提交
2043
    }
2044

2045
    conn = domain->conn;
2046
    if (conn->flags & VIR_CONNECT_RO) {
2047
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2048
        goto error;
2049
    }
2050

2051 2052 2053 2054 2055 2056 2057
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2058

2059
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2060 2061

error:
2062
    virDispatchError(conn);
2063
    return -1;
2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
}

/**
 * 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
2076 2077
virDomainFree(virDomainPtr domain)
{
2078
    VIR_DOMAIN_DEBUG0(domain);
2079

2080 2081 2082
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2083
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2084
        virDispatchError(NULL);
2085
        return -1;
D
Daniel Veillard 已提交
2086
    }
2087 2088
    if (virUnrefDomain(domain) < 0) {
        virDispatchError(NULL);
2089
        return -1;
2090
    }
2091
    return 0;
D
Daniel Veillard 已提交
2092 2093
}

2094 2095
/**
 * virDomainRef:
D
Daniel Veillard 已提交
2096
 * @domain: the domain to hold a reference on
2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
 *
 * 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 已提交
2108 2109
 *
 * Returns 0 in case of success and -1 in case of failure.
2110 2111 2112 2113 2114
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
2115
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2116
        virDispatchError(NULL);
2117
        return -1;
2118 2119
    }
    virMutexLock(&domain->conn->lock);
2120
    VIR_DOMAIN_DEBUG(domain, "refs=%d", domain->refs);
2121 2122 2123 2124 2125 2126
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
2127
/**
2128
 * virDomainSuspend:
D
Daniel Veillard 已提交
2129 2130 2131
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
2132
 * to CPU resources and I/O but the memory used by the domain at the
2133
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
2134
 * the domain.
2135
 * This function may requires privileged access.
D
Daniel Veillard 已提交
2136 2137 2138 2139
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2140 2141
virDomainSuspend(virDomainPtr domain)
{
2142
    virConnectPtr conn;
2143 2144

    VIR_DOMAIN_DEBUG0(domain);
2145

2146 2147
    virResetLastError();

D
Daniel Veillard 已提交
2148
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2149
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2150
        virDispatchError(NULL);
2151
        return -1;
D
Daniel Veillard 已提交
2152
    }
2153
    if (domain->conn->flags & VIR_CONNECT_RO) {
2154
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2155
        goto error;
2156
    }
D
Daniel Veillard 已提交
2157

2158 2159
    conn = domain->conn;

2160 2161 2162 2163 2164 2165 2166
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2167

2168
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2169 2170

error:
2171
    virDispatchError(domain->conn);
2172
    return -1;
D
Daniel Veillard 已提交
2173 2174 2175
}

/**
2176
 * virDomainResume:
D
Daniel Veillard 已提交
2177 2178
 * @domain: a domain object
 *
D
Dan Kenigsberg 已提交
2179
 * Resume a suspended domain, the process is restarted from the state where
2180
 * it was frozen by calling virSuspendDomain().
2181
 * This function may requires privileged access
D
Daniel Veillard 已提交
2182 2183 2184 2185
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2186 2187
virDomainResume(virDomainPtr domain)
{
2188
    virConnectPtr conn;
2189 2190

    VIR_DOMAIN_DEBUG0(domain);
2191

2192 2193
    virResetLastError();

D
Daniel Veillard 已提交
2194
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2195
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2196
        virDispatchError(NULL);
2197
        return -1;
D
Daniel Veillard 已提交
2198
    }
2199
    if (domain->conn->flags & VIR_CONNECT_RO) {
2200
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2201
        goto error;
2202
    }
D
Daniel Veillard 已提交
2203

2204 2205
    conn = domain->conn;

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

2214
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2215 2216

error:
2217
    virDispatchError(domain->conn);
2218
    return -1;
D
Daniel Veillard 已提交
2219 2220
}

2221 2222 2223 2224 2225 2226
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2227 2228 2229
 * 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.
2230 2231 2232 2233
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2234 2235
virDomainSave(virDomainPtr domain, const char *to)
{
2236
    char filepath[4096];
2237
    virConnectPtr conn;
2238 2239

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

2241 2242
    virResetLastError();

D
Daniel Veillard 已提交
2243
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2244
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2245
        virDispatchError(NULL);
2246
        return -1;
D
Daniel Veillard 已提交
2247
    }
2248
    if (domain->conn->flags & VIR_CONNECT_RO) {
2249
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2250
        goto error;
2251
    }
2252
    conn = domain->conn;
D
Daniel Veillard 已提交
2253
    if (to == NULL) {
2254
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2255
        goto error;
D
Daniel Veillard 已提交
2256
    }
2257

2258 2259 2260 2261 2262
    /*
     * We must absolutize the file path as the save is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (to[0] != '/') {
2263
        unsigned int len, t;
2264

2265 2266
        t = strlen(to);
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL)
2267
            return -1;
2268 2269 2270
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
        if (len > sizeof(filepath) - (t + 3))
2271
            return -1;
2272 2273 2274
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];
2275 2276 2277

    }

2278 2279 2280 2281 2282 2283 2284
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2285

2286
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2287 2288

error:
2289
    virDispatchError(domain->conn);
2290
    return -1;
2291 2292 2293 2294
}

/**
 * virDomainRestore:
2295
 * @conn: pointer to the hypervisor connection
2296
 * @from: path to the
2297 2298 2299 2300 2301 2302
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2303 2304
virDomainRestore(virConnectPtr conn, const char *from)
{
2305
    char filepath[4096];
2306
    VIR_DEBUG("conn=%p, from=%s", conn, from);
2307

2308 2309
    virResetLastError();

D
Daniel Veillard 已提交
2310
    if (!VIR_IS_CONNECT(conn)) {
2311
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2312
        virDispatchError(NULL);
2313
        return -1;
D
Daniel Veillard 已提交
2314
    }
2315
    if (conn->flags & VIR_CONNECT_RO) {
2316
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2317
        goto error;
2318
    }
D
Daniel Veillard 已提交
2319
    if (from == NULL) {
2320
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2321
        goto error;
D
Daniel Veillard 已提交
2322 2323
    }

2324 2325 2326 2327 2328
    /*
     * We must absolutize the file path as the restore is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (from[0] != '/') {
2329 2330 2331
        unsigned int len, t;

        t = strlen(from);
2332
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
2333
            virLibConnError(VIR_ERR_SYSTEM_ERROR,
2334 2335 2336
                            _("cannot get working directory"));
            goto error;
        }
2337 2338
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2339
        if (len > sizeof(filepath) - (t + 3)) {
2340
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
2341 2342 2343
                            _("path too long"));
            goto error;
        }
2344 2345 2346 2347 2348
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2349 2350 2351 2352 2353 2354 2355
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2356

2357
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2358 2359

error:
2360
    virDispatchError(conn);
2361
    return -1;
D
Daniel Veillard 已提交
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
}

/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
 * @flags: extra flags, currently unused
 *
 * 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)
{
    char filepath[4096];
    virConnectPtr conn;
2381 2382

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

2384 2385
    virResetLastError();

D
Daniel Veillard 已提交
2386
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2387
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2388
        virDispatchError(NULL);
2389
        return -1;
D
Daniel Veillard 已提交
2390 2391
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
2392
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2393
        goto error;
D
Daniel Veillard 已提交
2394 2395 2396
    }
    conn = domain->conn;
    if (to == NULL) {
2397
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2398
        goto error;
D
Daniel Veillard 已提交
2399 2400 2401 2402 2403 2404 2405 2406 2407 2408
    }

    /*
     * We must absolutize the file path as the save is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (to[0] != '/') {
        unsigned int len, t;

        t = strlen(to);
2409
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
2410
            virLibDomainError(VIR_ERR_SYSTEM_ERROR,
2411 2412 2413
                              _("cannot get current directory"));
            goto error;
        }
D
Daniel Veillard 已提交
2414 2415
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2416
        if (len > sizeof(filepath) - (t + 3)) {
2417
            virLibDomainError(VIR_ERR_INTERNAL_ERROR,
2418 2419 2420
                              _("path too long"));
            goto error;
        }
D
Daniel Veillard 已提交
2421 2422 2423 2424 2425 2426
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

2427 2428 2429 2430 2431 2432 2433
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2434

2435
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2436 2437

error:
2438
    virDispatchError(domain->conn);
2439
    return -1;
2440 2441
}

2442 2443 2444 2445 2446
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2447 2448
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2449 2450 2451 2452 2453 2454 2455
 *
 * 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
2456 2457
virDomainShutdown(virDomainPtr domain)
{
2458
    virConnectPtr conn;
2459 2460

    VIR_DOMAIN_DEBUG0(domain);
2461

2462 2463
    virResetLastError();

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

2474 2475
    conn = domain->conn;

2476 2477 2478 2479 2480 2481 2482
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2483

2484
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2485 2486

error:
2487
    virDispatchError(domain->conn);
2488
    return -1;
2489 2490
}

2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504
/**
 * 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)
{
2505
    virConnectPtr conn;
2506 2507

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

2509 2510
    virResetLastError();

2511
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2512
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2513
        virDispatchError(NULL);
2514
        return -1;
2515
    }
2516
    if (domain->conn->flags & VIR_CONNECT_RO) {
2517
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2518
        goto error;
2519
    }
2520

2521 2522
    conn = domain->conn;

2523 2524 2525 2526 2527 2528 2529
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2530

2531
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2532 2533

error:
2534
    virDispatchError(domain->conn);
2535
    return -1;
2536 2537
}

2538
/**
2539
 * virDomainGetName:
2540 2541 2542 2543 2544 2545 2546 2547
 * @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 *
2548 2549
virDomainGetName(virDomainPtr domain)
{
2550
    VIR_DEBUG("domain=%p", domain);
2551

2552 2553
    virResetLastError();

D
Daniel Veillard 已提交
2554
    if (!VIR_IS_DOMAIN(domain)) {
2555
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2556
        virDispatchError(NULL);
2557
        return NULL;
D
Daniel Veillard 已提交
2558
    }
2559
    return domain->name;
2560 2561
}

2562 2563 2564
/**
 * virDomainGetUUID:
 * @domain: a domain object
2565
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2566 2567 2568 2569 2570 2571
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2572 2573
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2574
    VIR_DOMAIN_DEBUG(domain, "uuid=%p", uuid);
2575

2576 2577
    virResetLastError();

D
Daniel Veillard 已提交
2578
    if (!VIR_IS_DOMAIN(domain)) {
2579
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2580
        virDispatchError(NULL);
2581
        return -1;
D
Daniel Veillard 已提交
2582 2583
    }
    if (uuid == NULL) {
2584
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2585
        virDispatchError(domain->conn);
2586
        return -1;
D
Daniel Veillard 已提交
2587 2588
    }

2589 2590
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2591
    return 0;
2592 2593
}

K
Karel Zak 已提交
2594 2595 2596
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2597
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2598
 *
2599
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2600 2601 2602 2603 2604 2605 2606
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2607
    unsigned char uuid[VIR_UUID_BUFLEN];
2608 2609

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

2611 2612
    virResetLastError();

K
Karel Zak 已提交
2613
    if (!VIR_IS_DOMAIN(domain)) {
2614
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2615
        virDispatchError(NULL);
2616
        return -1;
K
Karel Zak 已提交
2617 2618
    }
    if (buf == NULL) {
2619
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2620
        goto error;
K
Karel Zak 已提交
2621
    }
2622

K
Karel Zak 已提交
2623
    if (virDomainGetUUID(domain, &uuid[0]))
2624
        goto error;
K
Karel Zak 已提交
2625

2626
    virUUIDFormat(uuid, buf);
2627
    return 0;
2628 2629

error:
2630
    virDispatchError(domain->conn);
2631
    return -1;
K
Karel Zak 已提交
2632 2633
}

2634
/**
2635
 * virDomainGetID:
2636 2637 2638 2639 2640 2641 2642
 * @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
2643 2644
virDomainGetID(virDomainPtr domain)
{
2645
    VIR_DOMAIN_DEBUG0(domain);
2646

2647 2648
    virResetLastError();

D
Daniel Veillard 已提交
2649
    if (!VIR_IS_DOMAIN(domain)) {
2650
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2651
        virDispatchError(NULL);
2652
        return (unsigned int)-1;
D
Daniel Veillard 已提交
2653
    }
2654
    return domain->id;
2655 2656
}

2657 2658 2659 2660 2661 2662
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2663 2664
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2665 2666
 */
char *
2667 2668
virDomainGetOSType(virDomainPtr domain)
{
2669
    virConnectPtr conn;
2670 2671

    VIR_DOMAIN_DEBUG0(domain);
2672

2673 2674 2675
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2676
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2677
        virDispatchError(NULL);
2678
        return NULL;
D
Daniel Veillard 已提交
2679
    }
2680

2681 2682
    conn = domain->conn;

2683 2684 2685 2686 2687 2688 2689
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2690

2691
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2692 2693

error:
2694
    virDispatchError(domain->conn);
2695
    return NULL;
2696 2697
}

2698
/**
2699
 * virDomainGetMaxMemory:
2700
 * @domain: a domain object or NULL
2701
 *
2702 2703 2704 2705 2706 2707 2708
 * 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
2709 2710
virDomainGetMaxMemory(virDomainPtr domain)
{
2711
    virConnectPtr conn;
2712 2713

    VIR_DOMAIN_DEBUG0(domain);
2714

2715 2716
    virResetLastError();

D
Daniel Veillard 已提交
2717
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2718
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2719
        virDispatchError(NULL);
2720
        return 0;
D
Daniel Veillard 已提交
2721
    }
2722

2723 2724
    conn = domain->conn;

2725 2726 2727 2728 2729 2730 2731
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2732

2733
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2734 2735

error:
2736
    virDispatchError(domain->conn);
2737
    return 0;
2738 2739
}

D
Daniel Veillard 已提交
2740
/**
2741
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2742 2743
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2744
 *
D
Daniel Veillard 已提交
2745 2746 2747
 * 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.
2748
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2749
 *
2750 2751 2752
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
D
Daniel Veillard 已提交
2753 2754 2755
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2756 2757
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2758
    virConnectPtr conn;
2759 2760

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

2762 2763
    virResetLastError();

2764
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2765
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2766
        virDispatchError(NULL);
2767
        return -1;
2768
    }
2769
    if (domain->conn->flags & VIR_CONNECT_RO) {
2770
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2771
        goto error;
2772 2773
    }
    if (memory < 4096) {
2774
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2775
        goto error;
2776
    }
2777
    conn = domain->conn;
2778

2779 2780 2781 2782 2783 2784 2785
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2786

2787
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2788 2789

error:
2790
    virDispatchError(domain->conn);
2791
    return -1;
2792
}
2793

2794 2795 2796 2797
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2798
 *
2799 2800 2801
 * 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.
2802
 * This function may requires privileged access to the hypervisor.
2803
 *
2804 2805 2806
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
2807 2808 2809 2810 2811 2812
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2813 2814

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

2816 2817
    virResetLastError();

2818
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2819
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2820
        virDispatchError(NULL);
2821
        return -1;
2822
    }
2823
    if (domain->conn->flags & VIR_CONNECT_RO) {
2824
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2825
        goto error;
2826 2827
    }
    if (memory < 4096) {
2828
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2829
        goto error;
2830 2831 2832
    }

    conn = domain->conn;
2833

2834 2835 2836 2837 2838 2839 2840
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2841

2842
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2843 2844

error:
2845
    virDispatchError(domain->conn);
2846
    return -1;
D
Daniel Veillard 已提交
2847 2848
}

2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910
/*
 * virDomainSetMemoryFlags
 * @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.
 * This funcation may requires privileged access to the hypervisor.
 *
 * @flags must include VIR_DOMAIN_MEM_LIVE to affect a running
 * domain (which may fail if domain is not active), or
 * VIR_DOMAIN_MEM_CONFIG to affect the next boot via the XML
 * description of the domain. Both flags may be set.
 *
 * 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;
    }

    if (memory < 4096 ||
        (flags & (VIR_DOMAIN_MEM_LIVE | VIR_DOMAIN_MEM_CONFIG)) == 0) {
        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;
    }

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


2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929
/**
 * virDomainSetMemoryParameters:
 * @domain: pointer to domain object
 * @params: pointer to memory parameter objects
 * @nparams: number of memory parameter (this value should be same or
 *          less than the number of parameters supported)
 * @flags: currently unused, for future extension
 *
 * Change the memory tunables
 * 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;
2930 2931 2932

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%u",
                     params, nparams, flags);
2933 2934 2935 2936

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2937
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2938 2939 2940 2941
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
2942
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2943 2944 2945
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
2946
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958
        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;
    }

2959
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976

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
 *
 * Get the memory parameters, the @params array will be filled with the values
 * equal to the number of parameters suggested by @nparams
 *
2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993
 * 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;
 *     }
 * }
2994 2995
 *
 * This function requires privileged access to the hypervisor. This function
2996
 * expects the caller to allocate the @params.
2997 2998 2999 3000 3001 3002 3003 3004 3005
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
                             virMemoryParameterPtr params,
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
3006 3007 3008

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

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3013
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3014 3015 3016 3017
        virDispatchError(NULL);
        return -1;
    }
    if ((nparams == NULL) || (*nparams < 0)) {
3018
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
        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;
    }
3030
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3031 3032 3033 3034 3035 3036

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

3037 3038
/**
 * virDomainGetInfo:
3039
 * @domain: a domain object
3040
 * @info: pointer to a virDomainInfo structure allocated by the user
3041
 *
3042
 * Extract information about a domain. Note that if the connection
3043
 * used to get the domain is limited only a partial set of the information
3044 3045 3046 3047 3048
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3049 3050
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3051
    virConnectPtr conn;
3052 3053

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

3055 3056
    virResetLastError();

D
Daniel Veillard 已提交
3057
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3058
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3059
        virDispatchError(NULL);
3060
        return -1;
D
Daniel Veillard 已提交
3061 3062
    }
    if (info == NULL) {
3063
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3064
        goto error;
D
Daniel Veillard 已提交
3065
    }
3066

3067
    memset(info, 0, sizeof(virDomainInfo));
3068

3069 3070
    conn = domain->conn;

3071 3072 3073 3074 3075 3076 3077
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3078

3079
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3080 3081

error:
3082
    virDispatchError(domain->conn);
3083
    return -1;
3084
}
3085

3086 3087 3088
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3089
 * @flags: an OR'ed set of virDomainXMLFlags
3090 3091
 *
 * Provide an XML description of the domain. The description may be reused
3092
 * later to relaunch the domain with virDomainCreateXML().
3093 3094 3095 3096 3097
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3098 3099
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
3100
    virConnectPtr conn;
3101 3102

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

3104 3105 3106
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3107
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3108
        virDispatchError(NULL);
3109
        return NULL;
D
Daniel Veillard 已提交
3110
    }
3111

3112 3113
    conn = domain->conn;

3114
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
3115
        virLibConnError(VIR_ERR_OPERATION_DENIED,
3116 3117 3118 3119
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

3120 3121
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

3122 3123 3124 3125 3126 3127 3128
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
3129

3130
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3131 3132

error:
3133
    virDispatchError(domain->conn);
3134
    return NULL;
3135
}
3136

3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155
/**
 * 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)
{
3156
    VIR_DEBUG("conn=%p, format=%s config=%s flags=%u", conn, nativeFormat, nativeConfig, flags);
3157 3158 3159 3160

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3161
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3162
        virDispatchError(NULL);
3163
        return NULL;
3164 3165 3166
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
3167
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3168
        goto error;
3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181
    }

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

3182
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3183 3184

error:
3185
    virDispatchError(conn);
3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196
    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 已提交
3197
 * a native configuration file describing the domain.
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207
 * 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)
{
3208
    VIR_DEBUG("conn=%p, format=%s xml=%s flags=%u", conn, nativeFormat, domainXml, flags);
3209 3210 3211 3212

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3213
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3214
        virDispatchError(NULL);
3215
        return NULL;
3216 3217 3218
    }

    if (nativeFormat == NULL || domainXml == NULL) {
3219
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3220
        goto error;
3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233
    }

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

3234
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3235 3236

error:
3237
    virDispatchError(conn);
3238 3239 3240 3241
    return NULL;
}


3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252
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;
3253 3254 3255 3256 3257 3258 3259
    int cookielen = 0, ret;
    virDomainInfo info;

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277

    /* 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) {
3278
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
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
                         _("domainMigratePrepare did not set uri"));
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare change URI? */
    assert (uri != NULL);

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

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;
3324
    virDomainInfo info;
3325
    virErrorPtr orig_err = NULL;
3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343

    /* 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.
     */
    if (!domain->conn->driver->domainDumpXML) {
3344
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
3345
        virDispatchError(domain->conn);
3346 3347 3348
        return NULL;
    }
    dom_xml = domain->conn->driver->domainDumpXML (domain,
3349 3350
                                                   VIR_DOMAIN_XML_SECURE |
                                                   VIR_DOMAIN_XML_UPDATE_CPU);
3351 3352 3353
    if (!dom_xml)
        return NULL;

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

3359 3360 3361 3362 3363 3364 3365 3366
    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) {
3367
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
3368
                         _("domainMigratePrepare2 did not set uri"));
3369
        virDispatchError(domain->conn);
3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare2 change URI? */
    assert (uri != NULL);

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

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

3386 3387 3388 3389 3390 3391 3392 3393 3394
    /* 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;
    ddomain = dconn->driver->domainMigrateFinish2
        (dconn, dname, cookie, cookielen, uri, flags, ret);

 done:
3395 3396 3397 3398
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
3399 3400 3401 3402 3403
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419

 /*
  * This is sort of a migration v3
  *
  * In this version, the client does not talk to the destination
  * libvirtd. The source libvirtd will still try to talk to the
  * destination libvirtd though, and will do the prepare/perform/finish
  * steps.
  */
static int
virDomainMigratePeer2Peer (virDomainPtr domain,
                           unsigned long flags,
                           const char *dname,
                           const char *uri,
                           unsigned long bandwidth)
{
3420 3421
    xmlURIPtr tempuri = NULL;

3422
    if (!domain->conn->driver->domainMigratePerform) {
3423
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3424
        virDispatchError(domain->conn);
3425 3426 3427
        return -1;
    }

3428 3429
    tempuri = xmlParseURI(uri);
    if (!tempuri) {
3430
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3431 3432 3433 3434 3435
        virDispatchError(domain->conn);
        return -1;
    }

    if (!tempuri->server || STRPREFIX(tempuri->server, "localhost")) {
3436
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3437 3438 3439 3440 3441 3442
        virDispatchError(domain->conn);
        xmlFreeURI(tempuri);
        return -1;
    }
    xmlFreeURI(tempuri);

3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455
    /* 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 已提交
3456
/*
3457
 * This is a variation on v1 & 2  migration
C
Chris Lalancette 已提交
3458
 *
3459 3460 3461 3462 3463 3464
 * This is for hypervisors which can directly handshake
 * without any libvirtd involvement on destination either
 * from client, or source libvirt.
 *
 * 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 已提交
3465
 */
3466 3467 3468 3469 3470 3471 3472 3473
static int
virDomainMigrateDirect (virDomainPtr domain,
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
3474
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3475
        virDispatchError(domain->conn);
3476 3477 3478
        return -1;
    }

C
Chris Lalancette 已提交
3479 3480 3481
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
3482 3483 3484 3485 3486 3487 3488
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
C
Chris Lalancette 已提交
3489 3490
}

3491

3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504
/**
 * 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:
3505 3506 3507
 *   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 已提交
3508 3509 3510 3511
 *   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.
3512
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
3513 3514 3515 3516 3517
 *
 * 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.
3518 3519 3520 3521 3522 3523
 *
 * 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.
 *
3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534
 * 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.
 *
3535
 * In either case it is typically only necessary to specify a
3536 3537
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565
 *
 * 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;
3566 3567 3568

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

3570 3571
    virResetLastError();

3572
    /* First checkout the source */
3573
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3574
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3575
        virDispatchError(NULL);
3576 3577
        return NULL;
    }
3578
    if (domain->conn->flags & VIR_CONNECT_RO) {
3579
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3580
        goto error;
3581 3582
    }

3583 3584
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
3585
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3586 3587 3588 3589
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
3590
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3591 3592 3593
        goto error;
    }

3594 3595 3596 3597 3598 3599
    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);
3600
                if (!dstURI)
3601 3602
                    return NULL;
            }
3603

3604 3605 3606 3607 3608
            if (virDomainMigratePeer2Peer(domain, flags, dname, uri ? uri : dstURI, bandwidth) < 0) {
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
3609

3610 3611 3612
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
3613
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3614 3615
            goto error;
        }
3616
    } else {
3617
        if (flags & VIR_MIGRATE_TUNNELLED) {
3618
            virLibConnError(VIR_ERR_OPERATION_INVALID,
3619 3620 3621 3622
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634
        /* Check that migration is supported by both drivers. */
        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))
            ddomain = virDomainMigrateVersion1(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))
            ddomain = virDomainMigrateVersion2(domain, dconn, flags, dname, uri, bandwidth);
        else {
3635
            /* This driver does not support any migration method */
3636
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
3637 3638
            goto error;
        }
3639 3640
    }

3641 3642
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
3643

3644
    return ddomain;
3645 3646

error:
3647
    virDispatchError(domain->conn);
3648
    return NULL;
3649 3650
}

3651 3652 3653 3654 3655 3656 3657 3658 3659 3660

/**
 * 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 已提交
3661
 * host given by duri.
3662 3663 3664 3665 3666
 *
 * 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
3667 3668 3669 3670
 *   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.
3671
 *
3672 3673 3674 3675 3676 3677 3678 3679 3680 3681
 * 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
3682
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
3683
 * libvirt driver can connect to the destination libvirt.
3684
 *
3685 3686 3687 3688 3689 3690 3691
 * 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.
3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715
 *
 * 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)
{
3716 3717
    VIR_DOMAIN_DEBUG(domain, "duri=%p, flags=%lu, dname=%s, bandwidth=%lu",
                     NULLSTR(duri), flags, NULLSTR(dname), bandwidth);
3718 3719 3720 3721 3722

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3723
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3724
        virDispatchError(NULL);
3725 3726 3727
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
3728
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3729 3730 3731 3732
        goto error;
    }

    if (duri == NULL) {
3733
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3734 3735 3736 3737 3738 3739 3740 3741 3742 3743
        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 */
3744
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3745 3746 3747 3748 3749 3750 3751 3752 3753
            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 */
3754
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3755 3756 3757 3758 3759 3760 3761
            goto error;
        }
    }

    return 0;

error:
3762
    virDispatchError(domain->conn);
3763 3764 3765 3766
    return -1;
}


D
Daniel Veillard 已提交
3767 3768
/*
 * Not for public use.  This function is part of the internal
3769 3770 3771
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3772
virDomainMigratePrepare (virConnectPtr dconn,
3773 3774 3775 3776 3777 3778 3779
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
3780
{
J
John Levon 已提交
3781 3782 3783
    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);
3784

3785 3786
    virResetLastError();

3787
    if (!VIR_IS_CONNECT (dconn)) {
3788
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3789
        virDispatchError(NULL);
3790 3791 3792
        return -1;
    }

3793
    if (dconn->flags & VIR_CONNECT_RO) {
3794
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3795
        goto error;
3796 3797
    }

3798 3799 3800 3801 3802 3803 3804 3805 3806
    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;
    }
3807

3808
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3809 3810

error:
3811
    virDispatchError(dconn);
3812 3813 3814
    return -1;
}

D
Daniel Veillard 已提交
3815 3816
/*
 * Not for public use.  This function is part of the internal
3817 3818 3819
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3820
virDomainMigratePerform (virDomainPtr domain,
3821 3822 3823 3824 3825 3826 3827 3828
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
3829 3830 3831 3832

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

3834 3835 3836
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3837
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3838
        virDispatchError(NULL);
3839 3840 3841 3842
        return -1;
    }
    conn = domain->conn;

3843
    if (domain->conn->flags & VIR_CONNECT_RO) {
3844
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3845
        goto error;
3846 3847
    }

3848 3849 3850 3851 3852 3853 3854 3855 3856
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3857

3858
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3859 3860

error:
3861
    virDispatchError(domain->conn);
3862 3863 3864
    return -1;
}

D
Daniel Veillard 已提交
3865 3866
/*
 * Not for public use.  This function is part of the internal
3867 3868 3869
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3870
virDomainMigrateFinish (virConnectPtr dconn,
3871 3872 3873 3874 3875 3876
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3877 3878 3879
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3880

3881 3882
    virResetLastError();

3883
    if (!VIR_IS_CONNECT (dconn)) {
3884
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3885
        virDispatchError(NULL);
3886 3887 3888
        return NULL;
    }

3889
    if (dconn->flags & VIR_CONNECT_RO) {
3890
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3891
        goto error;
3892 3893
    }

3894 3895 3896 3897 3898 3899 3900 3901 3902
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3903

3904
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3905 3906

error:
3907
    virDispatchError(dconn);
3908
    return NULL;
D
Daniel Veillard 已提交
3909 3910 3911
}


D
Daniel Veillard 已提交
3912 3913
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3914 3915 3916
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3917 3918 3919 3920 3921 3922 3923 3924 3925
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 已提交
3926
{
J
John Levon 已提交
3927 3928 3929 3930
    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 已提交
3931

3932 3933
    virResetLastError();

D
Daniel Veillard 已提交
3934
    if (!VIR_IS_CONNECT (dconn)) {
3935
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3936
        virDispatchError(NULL);
D
Daniel Veillard 已提交
3937 3938 3939
        return -1;
    }

3940
    if (dconn->flags & VIR_CONNECT_RO) {
3941
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3942
        goto error;
3943 3944
    }

3945 3946 3947 3948 3949 3950 3951 3952 3953 3954
    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 已提交
3955

3956
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3957 3958

error:
3959
    virDispatchError(dconn);
D
Daniel Veillard 已提交
3960 3961 3962
    return -1;
}

D
Daniel Veillard 已提交
3963 3964
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3965 3966 3967
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3968 3969 3970 3971 3972 3973 3974
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3975
{
J
John Levon 已提交
3976 3977 3978
    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 已提交
3979

3980 3981
    virResetLastError();

D
Daniel Veillard 已提交
3982
    if (!VIR_IS_CONNECT (dconn)) {
3983
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3984
        virDispatchError(NULL);
D
Daniel Veillard 已提交
3985 3986 3987
        return NULL;
    }

3988
    if (dconn->flags & VIR_CONNECT_RO) {
3989
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3990
        goto error;
3991 3992
    }

3993 3994 3995 3996 3997 3998 3999 4000 4001 4002
    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 已提交
4003

4004
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4005 4006

error:
4007
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4008
    return NULL;
4009 4010 4011
}


C
Chris Lalancette 已提交
4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024
/*
 * 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)

{
4025 4026
    VIR_DEBUG("conn=%p, stream=%p, flags=%lu, dname=%s, "
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
4027 4028 4029 4030 4031
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4032
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4033
        virDispatchError(NULL);
C
Chris Lalancette 已提交
4034 4035 4036 4037
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
4038
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
4039 4040 4041 4042
        goto error;
    }

    if (conn != st->conn) {
4043
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
4044 4045 4046 4047
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
4048
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
4049 4050 4051 4052 4053 4054 4055
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

4056
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
4057 4058

error:
4059
    virDispatchError(conn);
C
Chris Lalancette 已提交
4060 4061 4062 4063
    return -1;
}


4064 4065 4066 4067
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
4068
 *
4069 4070 4071 4072 4073
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
4074 4075
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
4076
    VIR_DEBUG("conn=%p, info=%p", conn, info);
4077

4078 4079
    virResetLastError();

4080
    if (!VIR_IS_CONNECT(conn)) {
4081
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4082
        virDispatchError(NULL);
4083
        return -1;
4084 4085
    }
    if (info == NULL) {
4086
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4087
        goto error;
4088 4089
    }

4090 4091 4092 4093 4094 4095 4096
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
4097

4098
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4099 4100

error:
4101
    virDispatchError(conn);
4102
    return -1;
4103
}
4104

4105 4106 4107 4108 4109 4110
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
4111 4112
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
4113 4114 4115 4116 4117
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
4118
    VIR_DEBUG("conn=%p", conn);
4119

4120 4121
    virResetLastError();

4122
    if (!VIR_IS_CONNECT (conn)) {
4123
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4124
        virDispatchError(NULL);
4125 4126 4127
        return NULL;
    }

4128 4129 4130 4131 4132
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
4133
        VIR_DEBUG("conn=%p ret=%s", conn, ret);
4134 4135
        return ret;
    }
4136

4137
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4138 4139

error:
4140
    virDispatchError(conn);
4141 4142 4143
    return NULL;
}

4144 4145 4146
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
4147
 *
D
Daniel Veillard 已提交
4148
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
4149 4150
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
4151
 *
D
Daniel Veillard 已提交
4152
 * Returns the available free memory in bytes or 0 in case of error
4153 4154 4155 4156
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
4157
    VIR_DEBUG("conn=%p", conn);
4158

4159 4160
    virResetLastError();

4161
    if (!VIR_IS_CONNECT (conn)) {
4162
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4163
        virDispatchError(NULL);
4164 4165 4166
        return 0;
    }

4167 4168 4169 4170 4171 4172 4173
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
4174

4175
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4176 4177

error:
4178
    virDispatchError(conn);
4179 4180 4181
    return 0;
}

4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195
/**
 * virDomainGetSchedulerType:
 * @domain: pointer to domain object
 * @nparams: number of scheduler parameters(return value)
 *
 * Get the scheduler type.
 *
 * Returns NULL in case of error. The caller must free the returned string.
 */
char *
virDomainGetSchedulerType(virDomainPtr domain, int *nparams)
{
    virConnectPtr conn;
    char *schedtype;
4196 4197

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

4199 4200
    virResetLastError();

4201
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4202
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4203
        virDispatchError(NULL);
4204 4205 4206 4207 4208 4209
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
4210 4211
        if (!schedtype)
            goto error;
4212 4213 4214
        return schedtype;
    }

4215
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4216 4217

error:
4218
    virDispatchError(domain->conn);
4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238
    return NULL;
}


/**
 * virDomainGetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter object
 *          (return value)
 * @nparams: pointer to number of scheduler parameter
 *          (this value should be same than the returned value
 *           nparams of virDomainGetSchedulerType)
 *
 * Get the scheduler parameters, the @params array will be filled with the
 * values.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetSchedulerParameters(virDomainPtr domain,
4239
                                virSchedParameterPtr params, int *nparams)
4240 4241
{
    virConnectPtr conn;
4242 4243

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

4245 4246
    virResetLastError();

4247
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4248
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4249
        virDispatchError(NULL);
4250 4251 4252 4253
        return -1;
    }
    conn = domain->conn;

4254 4255 4256 4257 4258 4259 4260
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4261

4262
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4263 4264

error:
4265
    virDispatchError(domain->conn);
4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281
    return -1;
}

/**
 * virDomainSetSchedulerParameters:
 * @domain: pointer to domain object
 * @params: pointer to scheduler parameter objects
 * @nparams: number of scheduler parameter
 *          (this value should be same or less than the returned value
 *           nparams of virDomainGetSchedulerType)
 *
 * Change the scheduler parameters
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
4282
virDomainSetSchedulerParameters(virDomainPtr domain,
4283
                                virSchedParameterPtr params, int nparams)
4284 4285
{
    virConnectPtr conn;
4286 4287

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

4289 4290
    virResetLastError();

4291
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4292
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4293
        virDispatchError(NULL);
4294 4295
        return -1;
    }
4296
    if (domain->conn->flags & VIR_CONNECT_RO) {
4297
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4298
        goto error;
4299
    }
4300 4301
    conn = domain->conn;

4302 4303 4304 4305 4306 4307 4308
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4309

4310
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4311 4312

error:
4313
    virDispatchError(domain->conn);
4314 4315 4316 4317
    return -1;
}


4318
/**
4319
 * virDomainBlockStats:
4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346
 * @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 };
4347 4348

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

4350 4351
    virResetLastError();

4352
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4353
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4354
        virDispatchError(NULL);
4355 4356
        return -1;
    }
4357
    if (!path || !stats || size > sizeof stats2) {
4358
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4359 4360
        goto error;
    }
4361 4362 4363 4364
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
4365
            goto error;
4366 4367 4368 4369 4370

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

4371
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4372 4373

error:
4374
    virDispatchError(dom->conn);
4375 4376 4377 4378
    return -1;
}

/**
4379
 * virDomainInterfaceStats:
4380 4381 4382 4383 4384 4385 4386 4387 4388 4389
 * @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 已提交
4390
 * Domains may have more than one network interface.  To get stats for
4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405
 * 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 };
4406 4407 4408

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

4410 4411
    virResetLastError();

4412
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4413
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4414
        virDispatchError(NULL);
4415 4416
        return -1;
    }
4417
    if (!path || !stats || size > sizeof stats2) {
4418
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4419 4420
        goto error;
    }
4421 4422 4423 4424
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
4425
            goto error;
4426 4427 4428 4429 4430

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

4431
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4432 4433

error:
4434
    virDispatchError(dom->conn);
4435 4436 4437
    return -1;
}

4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472
/**
 * 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;
4473 4474

    VIR_DOMAIN_DEBUG(dom, "stats=%p, nr_stats=%u", stats, nr_stats);
4475 4476 4477 4478

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4479
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4480
        virDispatchError(NULL);
4481 4482
        return -1;
    }
4483 4484 4485 4486 4487 4488
    if (flags != 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
        goto error;
    }

4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502
    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;
    }

4503
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4504 4505

error:
4506
    virDispatchError(dom->conn);
4507 4508 4509
    return -1;
}

R
Richard W.M. Jones 已提交
4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542
/**
 * 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 已提交
4543 4544 4545 4546
 * 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 已提交
4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557
 * 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;
4558 4559 4560

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

4562 4563
    virResetLastError();

R
Richard W.M. Jones 已提交
4564
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4565
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4566
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4567 4568 4569
        return -1;
    }
    conn = dom->conn;
4570

4571
    if (dom->conn->flags & VIR_CONNECT_RO) {
4572
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4573
        goto error;
4574 4575
    }

R
Richard W.M. Jones 已提交
4576
    if (!path) {
4577
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
4578
                           _("path is NULL"));
4579
        goto error;
R
Richard W.M. Jones 已提交
4580 4581 4582
    }

    if (flags != 0) {
4583
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
4584
                           _("flags must be zero"));
4585
        goto error;
R
Richard W.M. Jones 已提交
4586 4587 4588 4589
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
4590
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
4591
                           _("buffer is NULL"));
4592
        goto error;
R
Richard W.M. Jones 已提交
4593 4594
    }

4595 4596 4597 4598 4599 4600 4601 4602
    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 已提交
4603

4604
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4605 4606

error:
4607
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4608 4609
    return -1;
}
4610

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

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

4654 4655
    virResetLastError();

R
Richard W.M. Jones 已提交
4656
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4657
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4658
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4659 4660 4661 4662
        return -1;
    }
    conn = dom->conn;

4663
    if (dom->conn->flags & VIR_CONNECT_RO) {
4664
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4665
        goto error;
4666 4667
    }

4668
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
4669 4670 4671 4672 4673 4674
     * 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.
     *
4675
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
4676 4677 4678
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
4679 4680 4681
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
4682 4683 4684 4685 4686 4687 4688 4689
     * 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.
     */
4690 4691

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
4692
        virLibDomainError(VIR_ERR_INVALID_ARG,
4693
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
4694
        goto error;
R
Richard W.M. Jones 已提交
4695 4696 4697 4698
    }

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

4704 4705 4706 4707 4708 4709 4710 4711
    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 已提交
4712

4713
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4714 4715

error:
4716
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4717 4718 4719
    return -1;
}

4720

4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735
/**
 * 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;
4736 4737

    VIR_DOMAIN_DEBUG(domain, "info=%p flags=%u", info, flags);
4738 4739 4740 4741

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4742
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4743
        virDispatchError(NULL);
4744
        return -1;
4745 4746
    }
    if (info == NULL) {
4747
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762
        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;
    }

4763
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4764 4765 4766 4767 4768 4769 4770

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


4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781
/************************************************************************
 *									*
 *		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
 *
4782 4783
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
4784 4785
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
4786 4787 4788 4789 4790
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
4791
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
4792

4793 4794
    virResetLastError();

4795
    if (!VIR_IS_CONNECT(conn)) {
4796
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4797
        virDispatchError(NULL);
4798
        return NULL;
4799
    }
4800
    if (conn->flags & VIR_CONNECT_RO) {
4801
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4802
        goto error;
4803
    }
4804
    if (xml == NULL) {
4805
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4806
        goto error;
4807 4808
    }

4809 4810 4811 4812 4813 4814 4815
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4816

4817
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4818 4819

error:
4820
    virDispatchError(conn);
4821
    return NULL;
4822 4823 4824 4825 4826 4827
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
4828
 * Undefine a domain but does not stop it if it is running
4829 4830 4831 4832 4833
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
4834
    virConnectPtr conn;
4835 4836

    VIR_DOMAIN_DEBUG0(domain);
4837

4838 4839
    virResetLastError();

4840
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4841
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4842
        virDispatchError(NULL);
4843
        return -1;
4844
    }
4845 4846
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4847
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4848
        goto error;
4849 4850
    }

4851 4852 4853 4854 4855 4856 4857
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4858

4859
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4860 4861

error:
4862
    virDispatchError(domain->conn);
4863
    return -1;
4864 4865 4866 4867 4868 4869
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
4870
 * Provides the number of defined but inactive domains.
4871 4872 4873 4874 4875 4876
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
4877
    VIR_DEBUG("conn=%p", conn);
4878

4879 4880
    virResetLastError();

4881
    if (!VIR_IS_CONNECT(conn)) {
4882
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4883
        virDispatchError(NULL);
4884
        return -1;
4885 4886
    }

4887 4888 4889 4890 4891 4892 4893
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4894

4895
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4896 4897

error:
4898
    virDispatchError(conn);
4899
    return -1;
4900 4901 4902 4903 4904 4905 4906 4907
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4908 4909
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
4910
 *
4911 4912 4913
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4914
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
4915
                             int maxnames) {
4916
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
4917

4918 4919
    virResetLastError();

4920
    if (!VIR_IS_CONNECT(conn)) {
4921
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4922
        virDispatchError(NULL);
4923
        return -1;
4924 4925
    }

4926
    if ((names == NULL) || (maxnames < 0)) {
4927
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4928
        goto error;
4929 4930
    }

4931 4932 4933 4934 4935 4936 4937
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4938

4939
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4940 4941

error:
4942
    virDispatchError(conn);
4943
    return -1;
4944 4945 4946 4947 4948 4949
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
4950
 * Launch a defined domain. If the call succeeds the domain moves from the
4951 4952 4953 4954 4955 4956
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
4957
    virConnectPtr conn;
4958 4959

    VIR_DOMAIN_DEBUG0(domain);
4960

4961 4962
    virResetLastError();

4963
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4964
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4965
        virDispatchError(NULL);
4966
        return -1;
4967
    }
4968 4969
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4970
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4971
        goto error;
4972
    }
4973

4974 4975 4976 4977 4978 4979 4980
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4981

4982
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4983 4984

error:
4985
    virDispatchError(domain->conn);
4986
    return -1;
4987 4988
}

4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001
/**
 * 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;
5002 5003

    VIR_DOMAIN_DEBUG(domain, "flags=%d", flags);
5004 5005 5006 5007

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5008
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5009
        virDispatchError(NULL);
5010
        return -1;
5011 5012 5013
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5014
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025
        goto error;
    }

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

5026
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5027 5028 5029 5030 5031 5032

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

5033 5034 5035
/**
 * virDomainGetAutostart:
 * @domain: a domain object
5036
 * @autostart: the value returned
5037
 *
5038
 * Provides a boolean value indicating whether the domain
5039 5040 5041 5042 5043 5044 5045
 * 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,
5046 5047 5048
                      int *autostart)
{
    virConnectPtr conn;
5049 5050

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

5052 5053 5054
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5055
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5056
        virDispatchError(NULL);
5057
        return -1;
5058 5059
    }
    if (!autostart) {
5060
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5061
        goto error;
5062 5063
    }

5064 5065
    conn = domain->conn;

5066 5067 5068 5069 5070 5071 5072
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5073

5074
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5075 5076

error:
5077
    virDispatchError(domain->conn);
5078
    return -1;
5079 5080 5081 5082 5083
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
5084
 * @autostart: whether the domain should be automatically started 0 or 1
5085 5086 5087 5088 5089 5090 5091 5092
 *
 * 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,
5093 5094 5095
                      int autostart)
{
    virConnectPtr conn;
5096 5097

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

5099 5100 5101
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5102
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5103
        virDispatchError(NULL);
5104
        return -1;
5105 5106
    }

5107 5108
    conn = domain->conn;

5109
    if (domain->conn->flags & VIR_CONNECT_RO) {
5110
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5111
        goto error;
5112 5113
    }

5114 5115 5116 5117 5118 5119 5120
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5121

5122
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5123 5124

error:
5125
    virDispatchError(domain->conn);
5126
    return -1;
5127 5128
}

5129 5130 5131 5132 5133 5134 5135 5136
/**
 * 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.
5137
 * This function requires privileged access to the hypervisor.
5138
 *
5139
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
5140 5141 5142
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
5143
 *
5144 5145 5146 5147 5148 5149
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
5150
    virConnectPtr conn;
5151 5152

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

5154 5155
    virResetLastError();

5156
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5157
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5158
        virDispatchError(NULL);
5159
        return -1;
5160
    }
5161
    if (domain->conn->flags & VIR_CONNECT_RO) {
5162
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5163
        goto error;
5164
    }
5165

5166
    if (nvcpus < 1) {
5167
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5168
        goto error;
5169
    }
5170
    conn = domain->conn;
5171

5172 5173 5174 5175 5176 5177 5178
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
5179

5180
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5181 5182

error:
5183
    virDispatchError(domain->conn);
5184
    return -1;
5185 5186
}

E
Eric Blake 已提交
5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217
/**
 * 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;
5218 5219

    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u, flags=%u", nvcpus, flags);
E
Eric Blake 已提交
5220 5221 5222 5223

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5224
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
5225
        virDispatchError(NULL);
5226
        return -1;
E
Eric Blake 已提交
5227 5228
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5229
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
5230 5231 5232 5233 5234 5235
        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) {
5236
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248
        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;
    }

5249
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281

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;
5282 5283

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
E
Eric Blake 已提交
5284 5285 5286 5287

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5288
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
5289
        virDispatchError(NULL);
5290
        return -1;
E
Eric Blake 已提交
5291 5292 5293 5294
    }

    /* Exactly one of these two flags should be set.  */
    if (!(flags & VIR_DOMAIN_VCPU_LIVE) == !(flags & VIR_DOMAIN_VCPU_CONFIG)) {
5295
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307
        goto error;
    }
    conn = domain->conn;

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

5308
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
5309 5310 5311 5312 5313 5314

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

5315 5316 5317 5318 5319
/**
 * 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 已提交
5320 5321 5322
 *      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.
5323 5324 5325 5326
 * @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.
5327
 *
5328
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
5329
 * This function requires privileged access to the hypervisor.
5330
 *
5331 5332 5333
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
5334 5335 5336 5337 5338 5339
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
5340
    virConnectPtr conn;
5341 5342 5343

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

5345 5346
    virResetLastError();

5347
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5348
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5349
        virDispatchError(NULL);
5350
        return -1;
5351
    }
5352
    if (domain->conn->flags & VIR_CONNECT_RO) {
5353
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5354
        goto error;
5355
    }
5356

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

5362 5363
    conn = domain->conn;

5364 5365 5366 5367 5368 5369 5370
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5371

5372
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5373 5374

error:
5375
    virDispatchError(domain->conn);
5376
    return -1;
5377 5378 5379 5380 5381 5382 5383
}

/**
 * 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 已提交
5384
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
5385
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
5386
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
5387 5388 5389 5390 5391 5392 5393
 *	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...).
5394
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
5395
 *
5396
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
5397
 * and also in cpumaps if this pointer isn't NULL.
5398 5399 5400 5401 5402
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
5403
                  unsigned char *cpumaps, int maplen)
5404
{
5405
    virConnectPtr conn;
5406 5407 5408

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

5410 5411
    virResetLastError();

5412
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5413
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5414
        virDispatchError(NULL);
5415
        return -1;
5416 5417
    }
    if ((info == NULL) || (maxinfo < 1)) {
5418
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5419
        goto error;
5420
    }
5421 5422 5423 5424 5425

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

5430 5431
    conn = domain->conn;

5432 5433 5434 5435 5436 5437 5438 5439
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5440

5441
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5442 5443

error:
5444
    virDispatchError(domain->conn);
5445
    return -1;
5446
}
5447

5448 5449 5450
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
5451
 *
5452 5453
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
5454
 * the same as virConnectGetMaxVcpus(). If the guest is running
5455
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
5456
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
5457 5458 5459 5460
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
5461 5462
virDomainGetMaxVcpus(virDomainPtr domain)
{
5463
    virConnectPtr conn;
5464 5465

    VIR_DOMAIN_DEBUG0(domain);
5466

5467 5468
    virResetLastError();

5469
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5470
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5471
        virDispatchError(NULL);
5472
        return -1;
5473 5474 5475 5476
    }

    conn = domain->conn;

5477 5478 5479 5480 5481 5482 5483
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5484

5485
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5486 5487

error:
5488
    virDispatchError(domain->conn);
5489
    return -1;
5490 5491
}

5492 5493 5494 5495 5496
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
5497 5498 5499
 * 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.
5500
 *
5501
 * Returns 0 in case of success, -1 in case of failure
5502 5503 5504 5505 5506 5507
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

5508 5509
    VIR_DOMAIN_DEBUG(domain, "seclabel=%p", seclabel);

5510
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5511
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5512
        virDispatchError(NULL);
5513 5514 5515 5516
        return -1;
    }

    if (seclabel == NULL) {
5517
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5518
        goto error;
5519 5520 5521 5522
    }

    conn = domain->conn;

5523 5524 5525 5526 5527 5528 5529 5530
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

5531
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5532

5533
error:
5534
    virDispatchError(domain->conn);
5535
    return -1;
5536 5537 5538 5539 5540 5541 5542
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
5543 5544 5545
 * 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.
5546
 *
5547
 * Returns 0 in case of success, -1 in case of failure
5548 5549 5550 5551
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
5552
    VIR_DEBUG("conn=%p secmodel=%p", conn, secmodel);
5553

5554
    if (!VIR_IS_CONNECT(conn)) {
5555
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5556
        virDispatchError(NULL);
5557 5558 5559 5560
        return -1;
    }

    if (secmodel == NULL) {
5561
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5562 5563 5564 5565 5566 5567 5568 5569 5570
        goto error;
    }

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

5573
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5574

5575
error:
5576
    virDispatchError(conn);
5577
    return -1;
5578
}
5579

5580 5581 5582 5583
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5584
 *
5585 5586
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
5587
 *
5588 5589 5590 5591
 * 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.
 *
5592 5593 5594
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5595
virDomainAttachDevice(virDomainPtr domain, const char *xml)
5596 5597
{
    virConnectPtr conn;
5598 5599

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

5601 5602
    virResetLastError();

5603
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5604
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5605
        virDispatchError(NULL);
5606
        return -1;
5607 5608
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5609
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5610
        goto error;
5611 5612 5613
    }
    conn = domain->conn;

5614
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
5615 5616 5617 5618 5619 5620 5621
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

5622
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646

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.
 *
5647 5648 5649 5650
 * 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 已提交
5651 5652 5653 5654 5655 5656 5657
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
5658 5659

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
5660 5661 5662 5663

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5664
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
5665
        virDispatchError(NULL);
5666
        return -1;
J
Jim Fehlig 已提交
5667 5668
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5669
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
5670 5671 5672 5673 5674
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
5675
        int ret;
J
Jim Fehlig 已提交
5676
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
5677 5678 5679 5680
        if (ret < 0)
            goto error;
        return ret;
    }
5681

5682
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5683 5684

error:
5685
    virDispatchError(domain->conn);
5686
    return -1;
5687 5688 5689 5690 5691 5692
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5693
 *
5694 5695
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
5696 5697 5698 5699
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5700
virDomainDetachDevice(virDomainPtr domain, const char *xml)
5701 5702
{
    virConnectPtr conn;
5703 5704

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

5706 5707
    virResetLastError();

5708
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5709
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5710
        virDispatchError(NULL);
5711
        return -1;
5712 5713
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5714
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5715
        goto error;
5716 5717 5718
    }
    conn = domain->conn;

5719 5720 5721
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
5722 5723 5724 5725 5726
         if (ret < 0)
             goto error;
         return ret;
     }

5727
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758

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;
5759 5760

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
5761 5762 5763 5764

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5765
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
5766
        virDispatchError(NULL);
5767
        return -1;
J
Jim Fehlig 已提交
5768 5769
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5770
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
5771 5772 5773 5774 5775 5776 5777
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
5778 5779 5780 5781 5782
        if (ret < 0)
            goto error;
        return ret;
    }

5783
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818

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;
5819 5820

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
5821 5822 5823 5824

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5825
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
5826
        virDispatchError(NULL);
5827
        return -1;
5828 5829
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5830
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5831 5832 5833 5834 5835 5836 5837
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
5838 5839 5840 5841
        if (ret < 0)
            goto error;
        return ret;
    }
5842

5843
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5844 5845

error:
5846
    virDispatchError(domain->conn);
5847
    return -1;
5848
}
5849

5850 5851 5852 5853 5854 5855 5856 5857 5858 5859
/**
 * 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
5860
 * with the amount of free memory in bytes for each cell requested,
5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871
 * 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)
{
5872
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
5873 5874
          conn, freeMems, startCell, maxCells);

5875 5876
    virResetLastError();

5877
    if (!VIR_IS_CONNECT(conn)) {
5878
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5879
        virDispatchError(NULL);
5880
        return -1;
5881 5882
    }

D
Daniel Veillard 已提交
5883
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
5884
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5885
        goto error;
5886 5887
    }

5888 5889 5890 5891 5892 5893 5894
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
5895

5896
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5897 5898

error:
5899
    virDispatchError(conn);
5900 5901 5902
    return -1;
}

5903 5904 5905 5906
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
5907
 * Provides the connection pointer associated with a network.  The
5908 5909 5910
 * reference counter on the connection is not increased by this
 * call.
 *
5911 5912 5913 5914
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
5915 5916 5917 5918 5919
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
5920
    VIR_DEBUG("net=%p", net);
5921

5922 5923 5924
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
5925
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5926
        virDispatchError(NULL);
5927 5928 5929 5930 5931
        return NULL;
    }
    return net->conn;
}

5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942
/**
 * 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)
{
5943
    VIR_DEBUG("conn=%p", conn);
5944

5945 5946
    virResetLastError();

5947
    if (!VIR_IS_CONNECT(conn)) {
5948
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5949
        virDispatchError(NULL);
5950
        return -1;
5951 5952
    }

5953 5954 5955 5956 5957 5958 5959
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5960

5961
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5962 5963

error:
5964
    virDispatchError(conn);
5965
    return -1;
5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978
}

/**
 * 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
5979
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
5980
{
5981
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
5982

5983 5984
    virResetLastError();

5985
    if (!VIR_IS_CONNECT(conn)) {
5986
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5987
        virDispatchError(NULL);
5988
        return -1;
5989 5990
    }

5991
    if ((names == NULL) || (maxnames < 0)) {
5992
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5993
        goto error;
5994 5995
    }

5996 5997 5998 5999 6000 6001 6002
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6003

6004
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6005 6006

error:
6007
    virDispatchError(conn);
6008
    return -1;
6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021
}

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

6024 6025
    virResetLastError();

6026
    if (!VIR_IS_CONNECT(conn)) {
6027
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6028
        virDispatchError(NULL);
6029
        return -1;
6030 6031
    }

6032 6033 6034 6035 6036 6037 6038
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6039

6040
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6041 6042

error:
6043
    virDispatchError(conn);
6044
    return -1;
6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057
}

/**
 * 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
6058
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
6059 6060
                              int maxnames)
{
6061
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6062

6063 6064
    virResetLastError();

6065
    if (!VIR_IS_CONNECT(conn)) {
6066
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6067
        virDispatchError(NULL);
6068
        return -1;
6069 6070
    }

6071
    if ((names == NULL) || (maxnames < 0)) {
6072
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6073
        goto error;
6074 6075
    }

6076 6077 6078 6079 6080 6081 6082 6083
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6084

6085
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6086 6087

error:
6088
    virDispatchError(conn);
6089
    return -1;
6090 6091 6092 6093 6094 6095 6096 6097 6098
}

/**
 * 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.
 *
6099 6100
 * 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.
6101 6102 6103 6104
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
6105
    VIR_DEBUG("conn=%p, name=%s", conn, name);
6106

6107 6108
    virResetLastError();

6109
    if (!VIR_IS_CONNECT(conn)) {
6110
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6111
        virDispatchError(NULL);
6112
        return NULL;
6113 6114
    }
    if (name == NULL) {
6115
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6116
        goto  error;
6117 6118
    }

6119 6120 6121 6122 6123 6124 6125
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6126

6127
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6128 6129

error:
6130
    virDispatchError(conn);
6131
    return NULL;
6132 6133 6134 6135 6136 6137 6138 6139 6140
}

/**
 * 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.
 *
6141 6142
 * 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.
6143 6144 6145 6146
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
6147 6148 6149
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    virUUIDFormat(uuid, uuidstr);

6150
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
6151

6152 6153
    virResetLastError();

6154
    if (!VIR_IS_CONNECT(conn)) {
6155
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6156
        virDispatchError(NULL);
6157
        return NULL;
6158 6159
    }
    if (uuid == NULL) {
6160
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6161
        goto error;
6162 6163
    }

6164 6165 6166 6167 6168 6169 6170
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6171

6172
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6173 6174

error:
6175
    virDispatchError(conn);
6176
    return NULL;
6177 6178 6179 6180 6181 6182 6183 6184 6185
}

/**
 * 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.
 *
6186 6187
 * 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.
6188 6189 6190 6191 6192
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
6193
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
6194

6195 6196
    virResetLastError();

6197
    if (!VIR_IS_CONNECT(conn)) {
6198
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6199
        virDispatchError(NULL);
6200
        return NULL;
6201 6202
    }
    if (uuidstr == NULL) {
6203
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6204
        goto error;
6205 6206
    }

6207
    if (virUUIDParse(uuidstr, uuid) < 0) {
6208
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6209
        goto error;
6210 6211 6212
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
6213 6214

error:
6215
    virDispatchError(conn);
6216
    return NULL;
6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231
}

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

6234 6235
    virResetLastError();

6236
    if (!VIR_IS_CONNECT(conn)) {
6237
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6238
        virDispatchError(NULL);
6239
        return NULL;
6240 6241
    }
    if (xmlDesc == NULL) {
6242
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6243
        goto error;
6244 6245
    }
    if (conn->flags & VIR_CONNECT_RO) {
6246
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6247
        goto error;
6248 6249
    }

6250 6251 6252 6253 6254 6255 6256
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
6257

6258
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6259 6260

error:
6261
    virDispatchError(conn);
6262
    return NULL;
6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274
}

/**
 * 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
6275 6276
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
6277
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
6278

6279 6280
    virResetLastError();

6281
    if (!VIR_IS_CONNECT(conn)) {
6282
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6283
        virDispatchError(NULL);
6284
        return NULL;
6285 6286
    }
    if (conn->flags & VIR_CONNECT_RO) {
6287
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6288
        goto error;
6289 6290
    }
    if (xml == NULL) {
6291
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6292
        goto error;
6293 6294
    }

6295 6296 6297 6298 6299 6300 6301
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
6302

6303
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6304 6305

error:
6306
    virDispatchError(conn);
6307
    return NULL;
6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320
}

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

6323 6324
    virResetLastError();

6325
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6326
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6327
        virDispatchError(NULL);
6328
        return -1;
6329 6330 6331
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6332
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6333
        goto error;
6334 6335
    }

6336 6337 6338 6339 6340 6341 6342
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6343

6344
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6345 6346

error:
6347
    virDispatchError(network->conn);
6348
    return -1;
6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360
}

/**
 * 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
6361 6362
virNetworkCreate(virNetworkPtr network)
{
6363
    virConnectPtr conn;
6364
    VIR_DEBUG("network=%p", network);
6365

6366 6367
    virResetLastError();

6368
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6369
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6370
        virDispatchError(NULL);
6371
        return -1;
6372 6373 6374
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6375
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6376
        goto error;
6377 6378
    }

6379 6380 6381 6382 6383 6384 6385
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6386

6387
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6388 6389

error:
6390
    virDispatchError(network->conn);
6391
    return -1;
6392 6393 6394 6395 6396 6397 6398
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
6399 6400 6401
 * 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
6402 6403 6404 6405 6406 6407 6408
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
6409
    VIR_DEBUG("network=%p", network);
6410

6411 6412
    virResetLastError();

6413
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6414
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6415
        virDispatchError(NULL);
6416
        return -1;
6417 6418 6419 6420
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6421
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6422
        goto error;
6423 6424
    }

6425 6426 6427 6428 6429 6430 6431
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6432

6433
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6434 6435

error:
6436
    virDispatchError(network->conn);
6437
    return -1;
6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451
}

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

6454 6455 6456
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6457
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6458
        virDispatchError(NULL);
6459
        return -1;
6460
    }
6461 6462
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
6463
        return -1;
6464
    }
6465
    return 0;
6466 6467
}

6468 6469
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
6470
 * @network: the network to hold a reference on
6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481
 *
 * 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 已提交
6482 6483
 *
 * Returns 0 in case of success, -1 in case of failure.
6484 6485 6486 6487 6488
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
6489
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6490
        virDispatchError(NULL);
6491
        return -1;
6492 6493
    }
    virMutexLock(&network->conn->lock);
6494
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
6495 6496 6497 6498 6499
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511
/**
 * 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)
{
6512
    VIR_DEBUG("network=%p", network);
6513

6514 6515
    virResetLastError();

6516
    if (!VIR_IS_NETWORK(network)) {
6517
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6518
        virDispatchError(NULL);
6519
        return NULL;
6520
    }
6521
    return network->name;
6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535
}

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

6538 6539
    virResetLastError();

6540
    if (!VIR_IS_NETWORK(network)) {
6541
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6542
        virDispatchError(NULL);
6543
        return -1;
6544 6545
    }
    if (uuid == NULL) {
6546
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6547
        goto error;
6548 6549 6550 6551
    }

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

6552
    return 0;
6553 6554

error:
6555
    virDispatchError(network->conn);
6556
    return -1;
6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572
}

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

6575 6576
    virResetLastError();

6577
    if (!VIR_IS_NETWORK(network)) {
6578
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6579
        virDispatchError(NULL);
6580
        return -1;
6581 6582
    }
    if (buf == NULL) {
6583
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6584
        goto error;
6585 6586 6587
    }

    if (virNetworkGetUUID(network, &uuid[0]))
6588
        goto error;
6589

6590
    virUUIDFormat(uuid, buf);
6591
    return 0;
6592 6593

error:
6594
    virDispatchError(network->conn);
6595
    return -1;
6596 6597 6598 6599 6600
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
6601
 * @flags: an OR'ed set of extraction flags, not used yet
6602 6603 6604 6605 6606 6607 6608 6609 6610 6611
 *
 * 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)
{
6612
    virConnectPtr conn;
6613
    VIR_DEBUG("network=%p, flags=%d", network, flags);
6614

6615 6616 6617
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6618
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6619
        virDispatchError(NULL);
6620
        return NULL;
6621 6622
    }
    if (flags != 0) {
6623
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6624
        goto error;
6625 6626
    }

6627 6628
    conn = network->conn;

6629 6630 6631 6632 6633 6634 6635
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
6636

6637
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6638 6639

error:
6640
    virDispatchError(network->conn);
6641
    return NULL;
6642
}
6643 6644 6645 6646 6647

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
6648
 * Provides a bridge interface name to which a domain may connect
6649 6650 6651 6652 6653 6654 6655 6656
 * 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)
{
6657
    virConnectPtr conn;
6658
    VIR_DEBUG("network=%p", network);
6659

6660 6661 6662
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6663
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6664
        virDispatchError(NULL);
6665
        return NULL;
6666 6667
    }

6668 6669
    conn = network->conn;

6670 6671 6672 6673 6674 6675 6676
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
6677

6678
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6679 6680

error:
6681
    virDispatchError(network->conn);
6682
    return NULL;
6683
}
6684 6685 6686 6687

/**
 * virNetworkGetAutostart:
 * @network: a network object
6688
 * @autostart: the value returned
6689
 *
6690
 * Provides a boolean value indicating whether the network
6691 6692 6693 6694 6695 6696 6697
 * 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,
6698 6699 6700
                       int *autostart)
{
    virConnectPtr conn;
6701
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
6702

6703 6704 6705
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6706
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6707
        virDispatchError(NULL);
6708
        return -1;
6709 6710
    }
    if (!autostart) {
6711
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6712
        goto error;
6713 6714
    }

6715 6716
    conn = network->conn;

6717 6718 6719 6720 6721 6722 6723
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6724

6725
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6726 6727

error:
6728
    virDispatchError(network->conn);
6729
    return -1;
6730 6731 6732 6733 6734
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
6735
 * @autostart: whether the network should be automatically started 0 or 1
6736 6737 6738 6739 6740 6741 6742 6743
 *
 * 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,
6744 6745 6746
                       int autostart)
{
    virConnectPtr conn;
6747
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
6748

6749 6750 6751
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6752
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6753
        virDispatchError(NULL);
6754
        return -1;
6755 6756
    }

6757
    if (network->conn->flags & VIR_CONNECT_RO) {
6758
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6759
        goto error;
6760 6761
    }

6762 6763
    conn = network->conn;

6764 6765 6766 6767 6768 6769 6770
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6771

6772
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6773 6774

error:
6775
    virDispatchError(network->conn);
6776
    return -1;
6777
}
6778

D
Daniel Veillard 已提交
6779 6780
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
6781
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793
 *
 * 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
6794
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
6795
{
6796
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6797 6798 6799

    virResetLastError();

6800
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
6801
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6802
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6803 6804
        return NULL;
    }
6805
    return iface->conn;
D
Daniel Veillard 已提交
6806 6807 6808 6809 6810 6811
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
6812
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
6813
 *
6814
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
6815 6816 6817 6818
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
6819
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
6820 6821 6822 6823

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6824
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6825
        virDispatchError(NULL);
6826
        return -1;
D
Daniel Veillard 已提交
6827 6828 6829 6830 6831 6832 6833 6834 6835 6836
    }

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

6837
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
6838 6839

error:
6840
    virDispatchError(conn);
D
Daniel Veillard 已提交
6841 6842 6843 6844 6845 6846 6847 6848 6849
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
6850 6851
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
6852 6853 6854 6855 6856 6857
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
6858
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
6859 6860 6861 6862

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6863
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6864
        virDispatchError(NULL);
6865
        return -1;
D
Daniel Veillard 已提交
6866 6867 6868
    }

    if ((names == NULL) || (maxnames < 0)) {
6869
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880
        goto error;
    }

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

6881
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
6882 6883

error:
6884
    virDispatchError(conn);
D
Daniel Veillard 已提交
6885 6886 6887
    return -1;
}

6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898
/**
 * 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)
{
6899
    VIR_DEBUG("conn=%p", conn);
6900 6901 6902 6903

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6904
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6905
        virDispatchError(NULL);
6906
        return -1;
6907 6908 6909 6910 6911 6912 6913 6914 6915 6916
    }

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

6917
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6918 6919

error:
6920
    virDispatchError(conn);
6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939
    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)
{
6940
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6941 6942 6943 6944

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6945
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6946
        virDispatchError(NULL);
6947
        return -1;
6948 6949 6950
    }

    if ((names == NULL) || (maxnames < 0)) {
6951
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962
        goto error;
    }

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

6963
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6964 6965

error:
6966
    virDispatchError(conn);
6967 6968 6969
    return -1;
}

D
Daniel Veillard 已提交
6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982
/**
 * 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)
{
6983
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
6984 6985 6986 6987

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6988
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6989
        virDispatchError(NULL);
6990
        return NULL;
D
Daniel Veillard 已提交
6991 6992
    }
    if (name == NULL) {
6993
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004
        goto  error;
    }

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

7005
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7006 7007

error:
7008
    virDispatchError(conn);
D
Daniel Veillard 已提交
7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024
    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)
{
7025
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
7026 7027 7028 7029

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7030
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7031
        virDispatchError(NULL);
7032
        return NULL;
D
Daniel Veillard 已提交
7033 7034
    }
    if (macstr == NULL) {
7035
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046
        goto  error;
    }

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

7047
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7048 7049

error:
7050
    virDispatchError(conn);
D
Daniel Veillard 已提交
7051 7052 7053 7054 7055
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
7056
 * @iface: an interface object
D
Daniel Veillard 已提交
7057 7058 7059 7060 7061 7062 7063
 *
 * 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 *
7064
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
7065
{
7066
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7067 7068 7069

    virResetLastError();

7070
    if (!VIR_IS_INTERFACE(iface)) {
7071
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7072
        virDispatchError(NULL);
7073
        return NULL;
D
Daniel Veillard 已提交
7074
    }
7075
    return iface->name;
D
Daniel Veillard 已提交
7076 7077 7078 7079
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
7080
 * @iface: an interface object
D
Daniel Veillard 已提交
7081
 *
L
Laine Stump 已提交
7082
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
7083 7084 7085 7086 7087 7088 7089
 * 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 *
7090
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
7091
{
7092
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7093 7094 7095

    virResetLastError();

7096
    if (!VIR_IS_INTERFACE(iface)) {
7097
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7098
        virDispatchError(NULL);
7099
        return NULL;
D
Daniel Veillard 已提交
7100
    }
7101
    return iface->mac;
D
Daniel Veillard 已提交
7102 7103 7104 7105
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
7106
 * @iface: an interface object
7107 7108 7109 7110 7111
 * @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 已提交
7112
 *
7113 7114 7115 7116 7117
 * 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 已提交
7118 7119 7120 7121 7122
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
7123
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7124 7125
{
    virConnectPtr conn;
7126
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7127 7128 7129

    virResetLastError();

7130
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7131
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7132
        virDispatchError(NULL);
7133
        return NULL;
D
Daniel Veillard 已提交
7134
    }
7135
    if ((flags & ~VIR_INTERFACE_XML_INACTIVE) != 0) {
7136
        virLibInterfaceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7137 7138 7139
        goto error;
    }

7140
    conn = iface->conn;
D
Daniel Veillard 已提交
7141 7142 7143

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
7144
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
7145 7146 7147 7148 7149
        if (!ret)
            goto error;
        return ret;
    }

7150
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7151 7152

error:
7153
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169
    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)
{
7170
    VIR_DEBUG("conn=%p, xml=%s, flags=%d", conn, xml, flags);
D
Daniel Veillard 已提交
7171 7172 7173 7174

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7175
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7176
        virDispatchError(NULL);
7177
        return NULL;
D
Daniel Veillard 已提交
7178 7179
    }
    if (conn->flags & VIR_CONNECT_RO) {
7180
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7181 7182 7183
        goto error;
    }
    if (xml == NULL) {
7184
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195
        goto error;
    }

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

7196
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7197 7198

error:
7199
    virDispatchError(conn);
D
Daniel Veillard 已提交
7200 7201 7202 7203 7204
    return NULL;
}

/**
 * virInterfaceUndefine:
7205
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
7206 7207 7208 7209 7210 7211 7212
 *
 * 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
7213
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
7214
    virConnectPtr conn;
7215
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7216 7217 7218

    virResetLastError();

7219
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7220
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7221
        virDispatchError(NULL);
7222
        return -1;
D
Daniel Veillard 已提交
7223
    }
7224
    conn = iface->conn;
D
Daniel Veillard 已提交
7225
    if (conn->flags & VIR_CONNECT_RO) {
7226
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7227 7228 7229 7230 7231
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
7232
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
7233 7234 7235 7236 7237
        if (ret < 0)
            goto error;
        return ret;
    }

7238
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7239 7240

error:
7241
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7242 7243 7244 7245 7246
    return -1;
}

/**
 * virInterfaceCreate:
7247
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
7248 7249 7250 7251 7252 7253 7254
 * @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
7255
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7256 7257
{
    virConnectPtr conn;
7258
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7259 7260 7261

    virResetLastError();

7262
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7263
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7264
        virDispatchError(NULL);
7265
        return -1;
D
Daniel Veillard 已提交
7266
    }
7267
    conn = iface->conn;
D
Daniel Veillard 已提交
7268
    if (conn->flags & VIR_CONNECT_RO) {
7269
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7270 7271 7272 7273 7274
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
7275
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
7276 7277 7278 7279 7280
        if (ret < 0)
            goto error;
        return ret;
    }

7281
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7282 7283

error:
7284
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7285 7286 7287 7288 7289
    return -1;
}

/**
 * virInterfaceDestroy:
7290
 * @iface: an interface object
D
Daniel Veillard 已提交
7291 7292 7293 7294 7295 7296 7297 7298 7299
 * @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
7300
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7301 7302
{
    virConnectPtr conn;
7303
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7304 7305 7306

    virResetLastError();

7307
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7308
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7309
        virDispatchError(NULL);
7310
        return -1;
D
Daniel Veillard 已提交
7311 7312
    }

7313
    conn = iface->conn;
D
Daniel Veillard 已提交
7314
    if (conn->flags & VIR_CONNECT_RO) {
7315
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7316 7317 7318 7319 7320
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
7321
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
7322 7323 7324 7325 7326
        if (ret < 0)
            goto error;
        return ret;
    }

7327
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7328 7329

error:
7330
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7331 7332 7333 7334 7335
    return -1;
}

/**
 * virInterfaceRef:
7336
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
7337 7338 7339 7340 7341 7342 7343 7344 7345
 *
 * 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 已提交
7346
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
7347 7348 7349 7350 7351
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
7352
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
7353
{
7354
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
7355
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7356
        virDispatchError(NULL);
7357
        return -1;
D
Daniel Veillard 已提交
7358
    }
7359
    virMutexLock(&iface->conn->lock);
7360
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
7361 7362
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
7363 7364 7365 7366 7367
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
7368
 * @iface: an interface object
D
Daniel Veillard 已提交
7369 7370 7371 7372 7373 7374 7375
 *
 * 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
7376
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
7377
{
7378
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7379 7380 7381

    virResetLastError();

7382
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7383
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7384
        virDispatchError(NULL);
7385
        return -1;
D
Daniel Veillard 已提交
7386
    }
7387 7388
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
7389
        return -1;
7390
    }
7391
    return 0;
D
Daniel Veillard 已提交
7392 7393
}

7394 7395 7396

/**
 * virStoragePoolGetConnect:
7397
 * @pool: pointer to a pool
7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411
 *
 * 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)
{
7412
    VIR_DEBUG("pool=%p", pool);
7413

7414 7415 7416
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
7417
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7418
        virDispatchError(NULL);
7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434
        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)
{
7435
    VIR_DEBUG("conn=%p", conn);
7436

7437 7438
    virResetLastError();

7439
    if (!VIR_IS_CONNECT(conn)) {
7440
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7441
        virDispatchError(NULL);
7442
        return -1;
7443 7444
    }

7445 7446 7447 7448 7449 7450 7451
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7452

7453
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7454 7455

error:
7456
    virDispatchError(conn);
7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476
    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)
{
7477
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7478

7479 7480
    virResetLastError();

7481
    if (!VIR_IS_CONNECT(conn)) {
7482
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7483
        virDispatchError(NULL);
7484
        return -1;
7485 7486 7487
    }

    if ((names == NULL) || (maxnames < 0)) {
7488
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7489
        goto error;
7490 7491
    }

7492 7493 7494 7495 7496 7497 7498
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7499

7500
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7501

7502
error:
7503
    virDispatchError(conn);
7504
    return -1;
7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518
}


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

7521 7522
    virResetLastError();

7523
    if (!VIR_IS_CONNECT(conn)) {
7524
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7525
        virDispatchError(NULL);
7526
        return -1;
7527 7528
    }

7529 7530 7531 7532 7533 7534 7535
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7536

7537
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7538 7539

error:
7540
    virDispatchError(conn);
7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561
    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)
{
7562
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7563

7564 7565
    virResetLastError();

7566
    if (!VIR_IS_CONNECT(conn)) {
7567
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7568
        virDispatchError(NULL);
7569
        return -1;
7570 7571 7572
    }

    if ((names == NULL) || (maxnames < 0)) {
7573
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7574
        goto error;
7575 7576
    }

7577 7578 7579 7580 7581 7582 7583
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7584

7585
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7586 7587

error:
7588
    virDispatchError(conn);
7589 7590 7591 7592
    return -1;
}


7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619
/**
 * 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)
{
7620
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);
7621 7622 7623

    virResetLastError();

7624
    if (!VIR_IS_CONNECT(conn)) {
7625
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7626
        virDispatchError(NULL);
7627
        return NULL;
7628 7629
    }
    if (type == NULL) {
7630
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7631
        goto error;
7632 7633
    }

7634
    if (conn->flags & VIR_CONNECT_RO) {
7635
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7636
        goto error;
7637 7638
    }

7639 7640 7641 7642 7643 7644 7645
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
7646

7647
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7648 7649

error:
7650
    virDispatchError(conn);
7651 7652 7653 7654
    return NULL;
}


7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667
/**
 * 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)
{
7668
    VIR_DEBUG("conn=%p, name=%s", conn, name);
7669

7670 7671
    virResetLastError();

7672
    if (!VIR_IS_CONNECT(conn)) {
7673
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7674
        virDispatchError(NULL);
7675
        return NULL;
7676 7677
    }
    if (name == NULL) {
7678
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7679
        goto error;
7680 7681
    }

7682 7683 7684 7685 7686 7687 7688
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7689

7690
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7691 7692

error:
7693
    virDispatchError(conn);
7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710
    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)
{
7711
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
7712

7713 7714
    virResetLastError();

7715
    if (!VIR_IS_CONNECT(conn)) {
7716
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7717
        virDispatchError(NULL);
7718
        return NULL;
7719 7720
    }
    if (uuid == NULL) {
7721
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7722
        goto error;
7723 7724
    }

7725 7726 7727 7728 7729 7730 7731
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
7732

7733
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7734

7735
error:
7736
    virDispatchError(conn);
7737
    return NULL;
7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751
}


/**
 * 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,
7752
                                 const char *uuidstr)
7753 7754
{
    unsigned char uuid[VIR_UUID_BUFLEN];
7755
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
7756

7757 7758
    virResetLastError();

7759
    if (!VIR_IS_CONNECT(conn)) {
7760
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7761
        virDispatchError(NULL);
7762
        return NULL;
7763 7764
    }
    if (uuidstr == NULL) {
7765
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7766
        goto error;
7767 7768 7769
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
7770
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7771
        goto error;
7772 7773 7774
    }

    return virStoragePoolLookupByUUID(conn, uuid);
7775 7776

error:
7777
    virDispatchError(conn);
7778
    return NULL;
7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792
}


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

7795 7796 7797
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
7798
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7799
        virDispatchError(NULL);
7800
        return NULL;
7801 7802
    }

7803 7804 7805 7806 7807 7808 7809
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
7810

7811
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7812

7813
error:
7814
    virDispatchError(vol->conn);
7815
    return NULL;
7816 7817 7818 7819 7820 7821
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
7822
 * @flags: future flags, use 0 for now
7823 7824
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
7825
 * pool is not persistent, so its definition will disappear
7826 7827 7828 7829 7830 7831 7832 7833 7834
 * 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)
{
7835
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
7836

7837 7838
    virResetLastError();

7839
    if (!VIR_IS_CONNECT(conn)) {
7840
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7841
        virDispatchError(NULL);
7842
        return NULL;
7843 7844
    }
    if (xmlDesc == NULL) {
7845
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7846
        goto error;
7847 7848
    }
    if (conn->flags & VIR_CONNECT_RO) {
7849
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7850
        goto error;
7851 7852
    }

7853 7854 7855 7856 7857 7858 7859
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7860

7861
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7862 7863

error:
7864
    virDispatchError(conn);
7865 7866 7867 7868 7869 7870 7871
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
7872
 * @flags: future flags, use 0 for now
7873 7874
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
7875
 * pool is persistent, until explicitly undefined.
7876 7877 7878 7879 7880 7881 7882 7883
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
7884
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
7885

7886 7887
    virResetLastError();

7888
    if (!VIR_IS_CONNECT(conn)) {
7889
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7890
        virDispatchError(NULL);
7891
        return NULL;
7892 7893
    }
    if (conn->flags & VIR_CONNECT_RO) {
7894
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7895
        goto error;
7896 7897
    }
    if (xml == NULL) {
7898
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7899
        goto error;
7900 7901
    }

7902 7903 7904 7905 7906 7907 7908
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
7909

7910
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7911

7912
error:
7913
    virDispatchError(conn);
7914
    return NULL;
7915 7916 7917 7918 7919
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
7920
 * @flags: future flags, use 0 for now
7921 7922 7923 7924 7925 7926 7927 7928 7929 7930
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
7931
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
7932

7933 7934
    virResetLastError();

7935
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7936
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7937
        virDispatchError(NULL);
7938
        return -1;
7939 7940 7941
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7942
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7943
        goto error;
7944 7945
    }

7946 7947 7948 7949 7950 7951 7952
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7953

7954
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7955

7956
error:
7957
    virDispatchError(pool->conn);
7958
    return -1;
7959 7960 7961 7962 7963 7964 7965 7966 7967
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
7968
 * Returns 0 on success, -1 on failure
7969 7970 7971 7972 7973
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
7974
    VIR_DEBUG("pool=%p", pool);
7975

7976 7977
    virResetLastError();

7978
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7979
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
7980
        virDispatchError(NULL);
7981
        return -1;
7982 7983 7984
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
7985
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7986
        goto error;
7987 7988
    }

7989 7990 7991 7992 7993 7994 7995
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7996

7997
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7998

7999
error:
8000
    virDispatchError(pool->conn);
8001
    return -1;
8002 8003 8004 8005 8006 8007
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
8008
 * @flags: future flags, use 0 for now
8009 8010 8011 8012 8013 8014 8015 8016 8017 8018
 *
 * 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;
8019
    VIR_DEBUG("pool=%p", pool);
8020

8021 8022
    virResetLastError();

8023
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8024
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8025
        virDispatchError(NULL);
8026
        return -1;
8027 8028 8029
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8030
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8031
        goto error;
8032 8033
    }

8034 8035 8036 8037 8038 8039 8040
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8041

8042
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8043

8044
error:
8045
    virDispatchError(pool->conn);
8046
    return -1;
8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065
}


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

8068 8069
    virResetLastError();

8070
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8071
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8072
        virDispatchError(NULL);
8073
        return -1;
8074 8075 8076 8077
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8078
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8079
        goto error;
8080 8081
    }

8082 8083 8084 8085 8086 8087 8088
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8089

8090
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8091 8092

error:
8093
    virDispatchError(pool->conn);
8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112
    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;
8113
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8114

8115 8116
    virResetLastError();

8117
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8118
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8119
        virDispatchError(NULL);
8120
        return -1;
8121 8122 8123 8124
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8125
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8126
        goto error;
8127 8128
    }

8129 8130 8131 8132 8133 8134 8135
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8136

8137
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8138 8139

error:
8140
    virDispatchError(pool->conn);
8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156
    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)
{
8157
    VIR_DEBUG("pool=%p", pool);
8158

8159 8160 8161
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8162
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8163
        virDispatchError(NULL);
8164
        return -1;
8165
    }
8166 8167
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
8168
        return -1;
8169
    }
8170
    return 0;
8171 8172 8173 8174

}


8175 8176
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
8177
 * @pool: the pool to hold a reference on
8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188
 *
 * 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 已提交
8189 8190
 *
 * Returns 0 in case of success, -1 in case of failure.
8191 8192 8193 8194 8195
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
8196
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8197
        virDispatchError(NULL);
8198
        return -1;
8199 8200
    }
    virMutexLock(&pool->conn->lock);
8201
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
8202 8203 8204 8205 8206
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

8207 8208 8209 8210 8211 8212 8213 8214 8215
/**
 * 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
 *
8216
 * Returns 0 if the volume list was refreshed, -1 on failure
8217 8218 8219 8220 8221 8222
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
8223
    VIR_DEBUG("pool=%p flags=%u", pool, flags);
8224

8225 8226
    virResetLastError();

8227
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8228
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8229
        virDispatchError(NULL);
8230
        return -1;
8231 8232 8233 8234
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8235
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8236
        goto error;
8237 8238
    }

8239 8240 8241 8242 8243 8244 8245
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8246

8247
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8248 8249

error:
8250
    virDispatchError(pool->conn);
8251 8252 8253 8254 8255 8256 8257 8258 8259 8260
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
8261
 * Returns the name of the pool, or NULL on error
8262 8263 8264 8265
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
8266
    VIR_DEBUG("pool=%p", pool);
8267

8268 8269
    virResetLastError();

8270
    if (!VIR_IS_STORAGE_POOL(pool)) {
8271
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8272
        virDispatchError(NULL);
8273
        return NULL;
8274
    }
8275
    return pool->name;
8276 8277 8278 8279 8280 8281 8282 8283 8284 8285
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
8286
 * Returns 0 on success, or -1 on error;
8287 8288 8289 8290 8291
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
8292
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
8293

8294 8295
    virResetLastError();

8296
    if (!VIR_IS_STORAGE_POOL(pool)) {
8297
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8298
        virDispatchError(NULL);
8299
        return -1;
8300 8301
    }
    if (uuid == NULL) {
8302
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8303
        goto error;
8304 8305 8306 8307
    }

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

8308
    return 0;
8309

8310
error:
8311
    virDispatchError(pool->conn);
8312
    return -1;
8313 8314 8315 8316 8317 8318 8319 8320 8321
}

/**
 * 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
 *
8322
 * Returns 0 on success, or -1 on error;
8323 8324 8325 8326 8327 8328
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
8329
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
8330

8331 8332
    virResetLastError();

8333
    if (!VIR_IS_STORAGE_POOL(pool)) {
8334
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8335
        virDispatchError(NULL);
8336
        return -1;
8337 8338
    }
    if (buf == NULL) {
8339
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8340
        goto error;
8341 8342 8343
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
8344
        goto error;
8345 8346

    virUUIDFormat(uuid, buf);
8347
    return 0;
8348

8349
error:
8350
    virDispatchError(pool->conn);
8351
    return -1;
8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362
}


/**
 * 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
 *
8363
 * Returns 0 on success, or -1 on failure.
8364 8365 8366 8367 8368 8369
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
8370
    VIR_DEBUG("pool=%p, info=%p", pool, info);
8371

8372 8373
    virResetLastError();

8374
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8375
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8376
        virDispatchError(NULL);
8377
        return -1;
8378 8379
    }
    if (info == NULL) {
8380
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8381
        goto error;
8382 8383 8384 8385 8386 8387
    }

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

    conn = pool->conn;

8388 8389 8390 8391 8392 8393 8394
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
8395

8396
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8397

8398
error:
8399
    virDispatchError(pool->conn);
8400
    return -1;
8401 8402 8403 8404 8405 8406
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
8407
 * @flags: flags for XML format options (set of virDomainXMLFlags)
8408 8409 8410 8411 8412
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
8413
 * Returns a XML document, or NULL on error
8414 8415 8416 8417 8418 8419
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
8420
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8421

8422 8423 8424
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8425
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8426
        virDispatchError(NULL);
8427
        return NULL;
8428 8429
    }
    if (flags != 0) {
8430
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8431
        goto error;
8432 8433 8434 8435
    }

    conn = pool->conn;

8436 8437 8438 8439 8440 8441 8442
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
8443

8444
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8445

8446
error:
8447
    virDispatchError(pool->conn);
8448
    return NULL;
8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459
}


/**
 * 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
 *
8460
 * Returns 0 on success, -1 on failure
8461 8462 8463 8464 8465 8466
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
8467
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
8468

8469 8470 8471
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8472
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8473
        virDispatchError(NULL);
8474
        return -1;
8475 8476
    }
    if (!autostart) {
8477
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8478
        goto error;
8479 8480 8481 8482
    }

    conn = pool->conn;

8483 8484 8485 8486 8487 8488 8489
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8490

8491
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8492 8493

error:
8494
    virDispatchError(pool->conn);
8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
8506
 * Returns 0 on success, -1 on failure
8507 8508 8509 8510 8511 8512
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
8513
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
8514

8515 8516 8517
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8518
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8519
        virDispatchError(NULL);
8520
        return -1;
8521 8522
    }

8523
    if (pool->conn->flags & VIR_CONNECT_RO) {
8524
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8525
        goto error;
8526 8527
    }

8528 8529
    conn = pool->conn;

8530 8531 8532 8533 8534 8535 8536
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8537

8538
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8539 8540

error:
8541
    virDispatchError(pool->conn);
8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556
    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)
{
8557
    VIR_DEBUG("pool=%p", pool);
8558

8559 8560
    virResetLastError();

8561
    if (!VIR_IS_STORAGE_POOL(pool)) {
8562
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8563
        virDispatchError(NULL);
8564
        return -1;
8565 8566
    }

8567 8568 8569 8570 8571 8572 8573
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8574

8575
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8576 8577

error:
8578
    virDispatchError(pool->conn);
8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598
    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)
{
8599
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
8600

8601 8602
    virResetLastError();

8603
    if (!VIR_IS_STORAGE_POOL(pool)) {
8604
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8605
        virDispatchError(NULL);
8606
        return -1;
8607 8608 8609
    }

    if ((names == NULL) || (maxnames < 0)) {
8610
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8611
        goto error;
8612 8613
    }

8614 8615 8616 8617 8618 8619 8620
    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;
    }
8621

8622
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8623 8624

error:
8625
    virDispatchError(pool->conn);
8626 8627 8628 8629 8630 8631
    return -1;
}


/**
 * virStorageVolGetConnect:
8632
 * @vol: pointer to a pool
8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646
 *
 * 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)
{
8647
    VIR_DEBUG("vol=%p", vol);
8648

8649 8650
    virResetLastError();

8651
    if (!VIR_IS_STORAGE_VOL (vol)) {
8652
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8653
        virDispatchError(NULL);
8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667
        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
 *
8668
 * Returns a storage volume, or NULL if not found / error
8669 8670 8671 8672 8673
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
8674
    VIR_DEBUG("pool=%p, name=%s", pool, name);
8675

8676 8677
    virResetLastError();

8678
    if (!VIR_IS_STORAGE_POOL(pool)) {
8679
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8680
        virDispatchError(NULL);
8681
        return NULL;
8682 8683
    }
    if (name == NULL) {
8684
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8685
        goto error;
8686 8687
    }

8688 8689 8690 8691 8692 8693 8694
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
8695

8696
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8697 8698

error:
8699
    virDispatchError(pool->conn);
8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712
    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
 *
8713
 * Returns a storage volume, or NULL if not found / error
8714 8715 8716 8717 8718
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
8719
    VIR_DEBUG("conn=%p, key=%s", conn, key);
8720

8721 8722
    virResetLastError();

8723
    if (!VIR_IS_CONNECT(conn)) {
8724
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8725
        virDispatchError(NULL);
8726
        return NULL;
8727 8728
    }
    if (key == NULL) {
8729
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8730
        goto error;
8731 8732
    }

8733 8734 8735 8736 8737 8738 8739
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
8740

8741
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8742 8743

error:
8744
    virDispatchError(conn);
8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755
    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
 *
8756
 * Returns a storage volume, or NULL if not found / error
8757 8758 8759 8760 8761
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
8762
    VIR_DEBUG("conn=%p, path=%s", conn, path);
8763

8764 8765
    virResetLastError();

8766
    if (!VIR_IS_CONNECT(conn)) {
8767
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8768
        virDispatchError(NULL);
8769
        return NULL;
8770 8771
    }
    if (path == NULL) {
8772
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8773
        goto error;
8774 8775
    }

8776 8777 8778 8779 8780 8781 8782
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
8783

8784
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8785 8786

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


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
8799
 * Returns the volume name, or NULL on error
8800 8801 8802 8803
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
8804
    VIR_DEBUG("vol=%p", vol);
8805

8806 8807
    virResetLastError();

8808
    if (!VIR_IS_STORAGE_VOL(vol)) {
8809
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8810
        virDispatchError(NULL);
8811
        return NULL;
8812
    }
8813
    return vol->name;
8814 8815 8816 8817 8818 8819 8820 8821
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
8822
 * unique, so the same volume will have the same
8823 8824
 * key no matter what host it is accessed from
 *
8825
 * Returns the volume key, or NULL on error
8826 8827 8828 8829
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
8830
    VIR_DEBUG("vol=%p", vol);
8831

8832 8833
    virResetLastError();

8834
    if (!VIR_IS_STORAGE_VOL(vol)) {
8835
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8836
        virDispatchError(NULL);
8837
        return NULL;
8838
    }
8839
    return vol->key;
8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852
}


/**
 * 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
 *
8853
 * Returns the storage volume, or NULL on error
8854 8855 8856 8857 8858 8859
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
8860
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8861

8862 8863
    virResetLastError();

8864
    if (!VIR_IS_STORAGE_POOL(pool)) {
8865
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8866
        virDispatchError(NULL);
8867
        return NULL;
8868 8869 8870
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
8871
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8872
        goto error;
8873 8874
    }

8875 8876 8877 8878 8879 8880 8881
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
8882

8883
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8884 8885

error:
8886
    virDispatchError(pool->conn);
8887 8888 8889 8890
    return NULL;
}


8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902
/**
 * 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.
 *
8903
 * Returns the storage volume, or NULL on error
8904 8905 8906 8907 8908 8909 8910
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
8911
    VIR_DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);
8912 8913 8914 8915

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
8916
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8917
        virDispatchError(NULL);
8918
        return NULL;
8919 8920 8921
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
8922
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8923
        goto error;
8924 8925 8926 8927
    }

    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
8928
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941
        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;
    }

8942
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8943 8944

error:
8945
    virDispatchError(pool->conn);
8946 8947 8948 8949
    return NULL;
}


8950 8951 8952
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
8953
 * @flags: future flags, use 0 for now
8954 8955 8956
 *
 * Delete the storage volume from the pool
 *
8957
 * Returns 0 on success, or -1 on error
8958 8959 8960 8961 8962 8963
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
8964
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
8965

8966 8967
    virResetLastError();

8968
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
8969
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8970
        virDispatchError(NULL);
8971
        return -1;
8972 8973 8974 8975
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8976
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8977
        goto error;
8978 8979
    }

8980 8981 8982 8983 8984 8985 8986
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8987

8988
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8989 8990

error:
8991
    virDispatchError(vol->conn);
8992 8993 8994 8995
    return -1;
}


8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014
/**
 * 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)) {
9015
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9016
        virDispatchError(NULL);
9017
        return -1;
9018 9019 9020 9021
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9022
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034
        goto error;
    }

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

9035
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9036 9037 9038 9039 9040 9041 9042

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


9043 9044 9045 9046 9047
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
9048
 * storage volume continues to exist.
9049
 *
9050
 * Returns 0 on success, or -1 on error
9051 9052 9053 9054
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
9055
    VIR_DEBUG("vol=%p", vol);
9056

9057 9058
    virResetLastError();

9059
    if (!VIR_IS_STORAGE_VOL(vol)) {
9060
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9061
        virDispatchError(NULL);
9062
        return -1;
9063
    }
9064 9065
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
9066
        return -1;
9067
    }
9068
    return 0;
9069 9070 9071
}


9072 9073
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
9074
 * @vol: the vol to hold a reference on
9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085
 *
 * 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 已提交
9086 9087
 *
 * Returns 0 in case of success, -1 in case of failure.
9088 9089 9090 9091 9092
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
9093
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9094
        virDispatchError(NULL);
9095
        return -1;
9096 9097
    }
    virMutexLock(&vol->conn->lock);
9098
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
9099 9100 9101 9102 9103
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

9104 9105 9106 9107 9108 9109 9110 9111
/**
 * 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
 *
9112
 * Returns 0 on success, or -1 on failure
9113 9114 9115 9116 9117 9118
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
9119
    VIR_DEBUG("vol=%p, info=%p", vol, info);
9120

9121 9122
    virResetLastError();

9123
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
9124
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9125
        virDispatchError(NULL);
9126
        return -1;
9127 9128
    }
    if (info == NULL) {
9129
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9130
        goto error;
9131 9132 9133 9134 9135 9136
    }

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

    conn = vol->conn;

9137 9138 9139 9140 9141 9142 9143
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
9144

9145
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9146 9147

error:
9148
    virDispatchError(vol->conn);
9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160
    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
 *
9161
 * Returns the XML document, or NULL on error
9162 9163 9164 9165 9166 9167
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
9168
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
9169

9170 9171
    virResetLastError();

9172
    if (!VIR_IS_STORAGE_VOL(vol)) {
9173
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9174
        virDispatchError(NULL);
9175
        return NULL;
9176 9177
    }
    if (flags != 0) {
9178
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9179
        goto error;
9180 9181 9182 9183
    }

    conn = vol->conn;

9184 9185 9186 9187 9188 9189 9190
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
9191

9192
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9193

9194
error:
9195
    virDispatchError(vol->conn);
9196
    return NULL;
9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215
}


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

9218 9219
    virResetLastError();

9220
    if (!VIR_IS_STORAGE_VOL(vol)) {
9221
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9222
        virDispatchError(NULL);
9223
        return NULL;
9224 9225 9226 9227
    }

    conn = vol->conn;

9228 9229 9230 9231 9232 9233 9234
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
9235

9236
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9237 9238

error:
9239
    virDispatchError(vol->conn);
9240 9241
    return NULL;
}
9242 9243


9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259
/**
 * 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)
{
9260
    VIR_DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
9261

9262 9263
    virResetLastError();

9264
    if (!VIR_IS_CONNECT(conn)) {
9265
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9266
        virDispatchError(NULL);
9267
        return -1;
9268 9269
    }
    if (flags != 0) {
9270
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9271
        goto error;
9272 9273
    }

9274 9275 9276 9277 9278 9279 9280
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9281

9282
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9283 9284

error:
9285
    virDispatchError(conn);
9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310
    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)
{
9311
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%d",
9312 9313
          conn, cap, names, maxnames, flags);

9314 9315
    virResetLastError();

9316
    if (!VIR_IS_CONNECT(conn)) {
9317
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9318
        virDispatchError(NULL);
9319
        return -1;
9320 9321
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
9322
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9323
        goto error;
9324 9325
    }

9326 9327 9328 9329 9330 9331 9332
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9333

9334
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9335 9336

error:
9337
    virDispatchError(conn);
9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352
    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)
{
9353
    VIR_DEBUG("conn=%p, name=%p", conn, name);
9354

9355 9356
    virResetLastError();

9357
    if (!VIR_IS_CONNECT(conn)) {
9358
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9359
        virDispatchError(NULL);
9360 9361 9362 9363
        return NULL;
    }

    if (name == NULL) {
9364
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9365
        goto error;
9366 9367
    }

9368 9369 9370 9371 9372 9373 9374
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
9375

9376
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9377 9378

error:
9379
    virDispatchError(conn);
9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391
    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.
 *
9392
 * Returns the XML document, or NULL on error
9393 9394 9395
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
9396
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9397

9398 9399
    virResetLastError();

9400
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9401
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9402
        virDispatchError(NULL);
9403 9404 9405
        return NULL;
    }

9406 9407 9408 9409 9410 9411 9412
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
9413

9414
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9415 9416

error:
9417
    virDispatchError(dev->conn);
9418 9419 9420 9421 9422 9423 9424 9425
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9426 9427 9428
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
9429 9430 9431
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
9432
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9433 9434

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9435
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9436
        virDispatchError(NULL);
9437 9438 9439 9440 9441 9442 9443 9444 9445 9446
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9447 9448
 * Accessor for the parent of the device
 *
9449 9450 9451 9452 9453
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
9454
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9455

9456 9457
    virResetLastError();

9458
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9459
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9460
        virDispatchError(NULL);
9461 9462 9463
        return NULL;
    }

9464 9465 9466 9467
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
9468
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9469
            virDispatchError(dev->conn);
9470 9471 9472 9473
            return NULL;
        }
    }
    return dev->parent;
9474 9475 9476 9477 9478 9479
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9480 9481
 * Accessor for the number of capabilities supported by the device.
 *
9482 9483 9484 9485
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
9486
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9487

9488 9489
    virResetLastError();

9490
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9491
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9492
        virDispatchError(NULL);
9493 9494 9495
        return -1;
    }

9496 9497 9498 9499 9500 9501 9502
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
9503

9504
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9505 9506

error:
9507
    virDispatchError(dev->conn);
9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524
    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)
{
9525
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
9526 9527
          dev, dev ? dev->conn : NULL, names, maxnames);

9528 9529
    virResetLastError();

9530
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9531
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9532
        virDispatchError(NULL);
9533 9534 9535
        return -1;
    }

9536 9537 9538 9539 9540 9541 9542
    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;
    }
9543

9544
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9545 9546

error:
9547
    virDispatchError(dev->conn);
9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562
    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)
{
9563
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9564

9565 9566
    virResetLastError();

9567
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9568
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9569
        virDispatchError(NULL);
9570
        return -1;
9571
    }
9572 9573
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
9574
        return -1;
9575
    }
9576
    return 0;
9577 9578 9579
}


9580 9581
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
9582
 * @dev: the dev to hold a reference on
9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593
 *
 * 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 已提交
9594 9595
 *
 * Returns 0 in case of success, -1 in case of failure.
9596 9597 9598 9599 9600
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
9601
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9602
        virDispatchError(NULL);
9603
        return -1;
9604 9605
    }
    virMutexLock(&dev->conn->lock);
9606
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
9607 9608 9609 9610 9611
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

9612
/**
D
Daniel Veillard 已提交
9613
 * virNodeDeviceDettach:
9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627
 * @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 已提交
9628 9629
 *
 * Returns 0 in case of success, -1 in case of failure.
9630 9631 9632 9633
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
9634
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9635 9636 9637 9638

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9639
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9640
        virDispatchError(NULL);
9641
        return -1;
9642 9643 9644 9645 9646 9647 9648 9649 9650 9651
    }

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

9652
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9653 9654

error:
9655
    virDispatchError(dev->conn);
9656
    return -1;
9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670
}

/**
 * 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 已提交
9671 9672
 *
 * Returns 0 in case of success, -1 in case of failure.
9673 9674 9675 9676
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
9677
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9678 9679 9680 9681

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9682
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9683
        virDispatchError(NULL);
9684
        return -1;
9685 9686 9687 9688 9689 9690 9691 9692 9693 9694
    }

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

9695
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9696 9697

error:
9698
    virDispatchError(dev->conn);
9699
    return -1;
9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715
}

/**
 * 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 已提交
9716 9717
 *
 * Returns 0 in case of success, -1 in case of failure.
9718 9719 9720 9721
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
9722
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9723 9724 9725 9726

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9727
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9728
        virDispatchError(NULL);
9729
        return -1;
9730 9731 9732 9733 9734 9735 9736 9737 9738 9739
    }

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

9740
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9741 9742

error:
9743
    virDispatchError(dev->conn);
9744
    return -1;
9745 9746
}

9747

9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768
/**
 * 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)) {
9769
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9770
        virDispatchError(NULL);
9771 9772 9773 9774
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
9775
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9776 9777 9778 9779
        goto error;
    }

    if (xmlDesc == NULL) {
9780
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791
        goto error;
    }

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

9792
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9793 9794

error:
9795
    virDispatchError(conn);
9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811
    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)
{
9812
    VIR_DEBUG("dev=%p", dev);
9813 9814 9815 9816

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9817
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9818
        virDispatchError(NULL);
9819
        return -1;
9820 9821 9822
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
9823
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836
        goto error;
    }

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

        return 0;
    }

9837
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9838 9839

error:
9840
    virDispatchError(dev->conn);
9841 9842 9843 9844
    return -1;
}


9845 9846 9847 9848 9849 9850 9851 9852 9853
/*
 * 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 已提交
9854
 * @freecb: optional function to deallocate opaque when not used anymore
9855
 *
9856 9857 9858 9859 9860 9861
 * 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
9862
 *
9863 9864 9865 9866 9867 9868 9869
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
 * If the callback wishes to keep the domain object after the callback
 * returns, it shall take a reference to it, by calling virDomainRef.
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
9870 9871 9872 9873 9874
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
9875 9876
                              void *opaque,
                              virFreeCallback freecb)
9877
{
9878
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
9879
    virResetLastError();
9880 9881

    if (!VIR_IS_CONNECT(conn)) {
9882
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9883
        virDispatchError(NULL);
9884
        return -1;
9885 9886
    }
    if (cb == NULL) {
9887
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9888
        goto error;
9889 9890
    }

9891 9892 9893 9894 9895 9896 9897 9898
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

9899
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9900
error:
9901
    virDispatchError(conn);
9902 9903 9904 9905 9906 9907 9908 9909
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
9910 9911 9912 9913 9914 9915
 * 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
9916 9917 9918 9919 9920 9921 9922
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
9923
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
9924 9925

    virResetLastError();
9926 9927

    if (!VIR_IS_CONNECT(conn)) {
9928
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9929
        virDispatchError(NULL);
9930
        return -1;
9931 9932
    }
    if (cb == NULL) {
9933
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9934 9935 9936 9937 9938 9939 9940 9941
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
9942 9943
    }

9944
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9945
error:
9946
    virDispatchError(conn);
9947 9948
    return -1;
}
9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964

/**
 * 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)
{
9965
    VIR_DEBUG("secret=%p", secret);
9966 9967 9968 9969

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
9970
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
9971
        virDispatchError(NULL);
9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992
        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)) {
9993
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9994
        virDispatchError(NULL);
9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007
        return -1;
    }

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

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

10008
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10009 10010

error:
10011
    virDispatchError(conn);
10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032
    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)) {
10033
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10034
        virDispatchError(NULL);
10035 10036 10037
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
10038
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050
        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;
    }

10051
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10052 10053

error:
10054
    virDispatchError(conn);
10055 10056 10057 10058
    return -1;
}

/**
10059 10060 10061
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
10062
 *
10063 10064
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
10065
 *
10066 10067
 * 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.
10068 10069
 */
virSecretPtr
10070
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
10071
{
10072
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
10073 10074 10075 10076

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10077
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10078
        virDispatchError(NULL);
10079
        return NULL;
10080 10081
    }
    if (uuid == NULL) {
10082
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10083 10084 10085
        goto error;
    }

10086 10087
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
10088
        virSecretPtr ret;
10089 10090
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
10091 10092 10093 10094
            goto error;
        return ret;
    }

10095
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10096 10097

error:
10098
    virDispatchError(conn);
10099 10100 10101
    return NULL;
}

10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116
/**
 * 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];
10117
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
10118 10119 10120 10121

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10122
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10123
        virDispatchError(NULL);
10124
        return NULL;
10125 10126
    }
    if (uuidstr == NULL) {
10127
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10128 10129
        goto error;
    }
10130 10131

    if (virUUIDParse(uuidstr, uuid) < 0) {
10132
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10133 10134 10135 10136 10137 10138
        goto error;
    }

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

error:
10139
    virDispatchError(conn);
10140 10141 10142 10143
    return NULL;
}


10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161
/**
 * 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)
{
10162
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
10163 10164 10165 10166

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10167
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10168
        virDispatchError(NULL);
10169
        return NULL;
10170 10171
    }
    if (usageID == NULL) {
10172
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184
        goto error;
    }

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

10185
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10186 10187

error:
10188
    virDispatchError(conn);
10189 10190 10191 10192
    return NULL;
}


10193 10194 10195 10196 10197 10198
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
10199
 * If XML specifies a UUID, locates the specified secret and replaces all
10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215
 * 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)) {
10216
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10217
        virDispatchError(NULL);
10218 10219 10220
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
10221
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10222 10223 10224
        goto error;
    }
    if (xml == NULL) {
10225
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237
        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;
    }

10238
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10239 10240

error:
10241
    virDispatchError(conn);
10242 10243 10244 10245
    return NULL;
}

/**
10246
 * virSecretGetUUID:
10247
 * @secret: A virSecret secret
10248
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
10249 10250 10251
 *
 * Fetches the UUID of the secret.
 *
10252 10253
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
10254
 */
10255 10256
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
10257 10258 10259 10260 10261 10262
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
10263
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10264
        virDispatchError(NULL);
10265 10266 10267
        return -1;
    }
    if (uuid == NULL) {
10268
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10269
        virDispatchError(secret->conn);
10270
        return -1;
10271 10272
    }

10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291
    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];
10292
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
10293 10294

    virResetLastError();
10295

10296
    if (!VIR_IS_SECRET(secret)) {
10297
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10298
        virDispatchError(NULL);
10299
        return -1;
10300 10301
    }
    if (buf == NULL) {
10302
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10303 10304 10305 10306 10307 10308 10309
        goto error;
    }

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

    virUUIDFormat(uuid, buf);
10310
    return 0;
10311 10312

error:
10313
    virDispatchError(secret->conn);
10314
    return -1;
10315 10316
}

10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332
/**
 * 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)
{
10333
    VIR_DEBUG("secret=%p", secret);
10334 10335 10336 10337

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
10338
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10339
        virDispatchError(NULL);
10340
        return -1;
10341
    }
10342
    return secret->usageType;
10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363
}

/**
 * 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)
{
10364
    VIR_DEBUG("secret=%p", secret);
10365 10366 10367 10368

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
10369
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10370
        virDispatchError(NULL);
10371
        return NULL;
10372
    }
10373
    return secret->usageID;
10374 10375
}

10376

10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396
/**
 * 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)) {
10397
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10398
        virDispatchError(NULL);
10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411
        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;
    }

10412
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10413 10414

error:
10415
    virDispatchError(conn);
10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441
    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)) {
10442
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10443
        virDispatchError(NULL);
10444 10445 10446 10447
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10448
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10449 10450 10451
        goto error;
    }
    if (value == NULL) {
10452
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464
        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;
    }

10465
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10466 10467

error:
10468
    virDispatchError(conn);
10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492
    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)) {
10493
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10494
        virDispatchError(NULL);
10495 10496 10497 10498
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10499
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10500 10501 10502
        goto error;
    }
    if (value_size == NULL) {
10503
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10504 10505 10506
        goto error;
    }

10507 10508
    flags &= VIR_SECRET_GET_VALUE_FLAGS_MASK;

10509 10510 10511 10512 10513 10514 10515 10516 10517
    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;
    }

10518
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10519 10520

error:
10521
    virDispatchError(conn);
10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543
    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)) {
10544
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10545
        virDispatchError(NULL);
10546 10547 10548 10549
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10550
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562
        goto error;
    }

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

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

10563
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10564 10565

error:
10566
    virDispatchError(conn);
10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589
    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)) {
10590
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10591
        virDispatchError(NULL);
10592 10593 10594
        return -1;
    }
    virMutexLock(&secret->conn->lock);
10595
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
10607
 * Returns 0 on success, or -1 on error
10608 10609 10610 10611
 */
int
virSecretFree(virSecretPtr secret)
{
10612
    VIR_DEBUG("secret=%p", secret);
10613 10614 10615 10616

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
10617
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10618
        virDispatchError(NULL);
10619 10620
        return -1;
    }
10621 10622
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
10623
        return -1;
10624
    }
10625 10626
    return 0;
}
10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653


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

10654
    VIR_DEBUG("conn=%p, flags=%u", conn, flags);
10655 10656 10657 10658

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10659
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10660
        virDispatchError(NULL);
10661
        return NULL;
10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686
    }

    st = virGetStream(conn);
    if (st)
        st->flags = flags;

    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))) {
10687
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10688
        virDispatchError(NULL);
10689
        return -1;
10690 10691
    }
    virMutexLock(&stream->conn->lock);
10692
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707
    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
10708
 * it should call virStreamFinish to wait for successful
10709 10710 10711 10712 10713 10714 10715 10716 10717
 * 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 已提交
10718
 * An example using this with a hypothetical file upload
10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766
 * 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)
{
10767
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
10768 10769 10770 10771

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
10772
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10773
        virDispatchError(NULL);
10774
        return -1;
10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787
    }

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

10788
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10789 10790

error:
10791
    virDispatchError(stream->conn);
10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809
    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 已提交
10810
 * An example using this with a hypothetical file download
10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861
 * 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)
{
10862
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
10863 10864 10865 10866

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
10867
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10868
        virDispatchError(NULL);
10869
        return -1;
10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882
    }

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

10883
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10884 10885

error:
10886
    virDispatchError(stream->conn);
10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900
    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 已提交
10901
 * An example using this with a hypothetical file upload
10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922
 * 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);
 *
10923
 * Returns 0 if all the data was successfully sent. The caller
10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937
 * 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;
10938
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
10939 10940 10941 10942

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
10943
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10944
        virDispatchError(NULL);
10945
        return -1;
10946 10947 10948
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
10949
        virLibConnError(VIR_ERR_OPERATION_INVALID,
10950 10951 10952 10953 10954
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
10955
        virReportOOMError();
10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981
        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)
10982
        virDispatchError(stream->conn);
10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997

    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 已提交
10998
 * An example using this with a hypothetical file download
10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019
 * 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);
 *
11020
 * Returns 0 if all the data was successfully received. The caller
11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034
 * 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;
11035
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
11036 11037 11038 11039

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11040
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11041
        virDispatchError(NULL);
11042
        return -1;
11043 11044 11045
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
11046
        virLibConnError(VIR_ERR_OPERATION_INVALID,
11047 11048 11049 11050 11051 11052
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
11053
        virReportOOMError();
11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079
        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)
11080
        virDispatchError(stream->conn);
11081 11082 11083 11084 11085 11086

    return ret;
}


/**
M
Matthias Bolte 已提交
11087
 * virStreamEventAddCallback:
11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106
 * @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)
{
11107
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
11108 11109 11110 11111

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11112
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11113
        virDispatchError(NULL);
11114
        return -1;
11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125
    }

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

11126
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11127 11128

error:
11129
    virDispatchError(stream->conn);
11130 11131 11132 11133 11134
    return -1;
}


/**
M
Matthias Bolte 已提交
11135
 * virStreamEventUpdateCallback:
11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148
 * @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)
{
11149
    VIR_DEBUG("stream=%p, events=%d", stream, events);
11150 11151 11152 11153

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11154
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11155
        virDispatchError(NULL);
11156
        return -1;
11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167
    }

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

11168
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11169 11170

error:
11171
    virDispatchError(stream->conn);
11172 11173 11174 11175
    return -1;
}

/**
M
Matthias Bolte 已提交
11176
 * virStreamEventRemoveCallback:
11177 11178
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
11179
 * Remove an event callback from the stream
11180 11181 11182 11183 11184
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
11185
    VIR_DEBUG("stream=%p", stream);
11186 11187 11188 11189

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11190
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11191
        virDispatchError(NULL);
11192
        return -1;
11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203
    }

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

11204
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11205 11206

error:
11207
    virDispatchError(stream->conn);
11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227
    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)
{
11228
    VIR_DEBUG("stream=%p", stream);
11229 11230 11231 11232

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11233
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11234
        virDispatchError(NULL);
11235
        return -1;
11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246
    }

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

11247
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11248 11249

error:
11250
    virDispatchError(stream->conn);
11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268
    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)
{
11269
    VIR_DEBUG("stream=%p", stream);
11270 11271 11272 11273

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11274
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11275
        virDispatchError(NULL);
11276
        return -1;
11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287
    }

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

11288
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11289 11290

error:
11291
    virDispatchError(stream->conn);
11292 11293 11294 11295 11296 11297 11298 11299 11300 11301
    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 已提交
11302
 * There must not be an active data transfer in progress
11303 11304 11305 11306 11307 11308 11309 11310
 * 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)
{
11311
    VIR_DEBUG("stream=%p", stream);
11312 11313 11314 11315

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11316
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11317
        virDispatchError(NULL);
11318
        return -1;
11319 11320 11321 11322
    }

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

11323 11324
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
11325
        return -1;
11326
    }
11327
    return 0;
11328
}
11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340


/**
 * 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)
{
11341
    VIR_DEBUG("dom=%p", dom);
11342 11343 11344 11345

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
11346
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11347
        virDispatchError(NULL);
11348
        return -1;
11349 11350 11351 11352 11353 11354 11355 11356 11357
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

11358
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11359
error:
11360
    virDispatchError(dom->conn);
11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374
    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)
{
11375
    VIR_DOMAIN_DEBUG0(dom);
11376 11377 11378 11379

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
11380
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11381
        virDispatchError(NULL);
11382
        return -1;
11383 11384 11385 11386 11387 11388 11389 11390 11391
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

11392
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11393
error:
11394
    virDispatchError(dom->conn);
11395 11396 11397
    return -1;
}

11398 11399 11400 11401 11402 11403 11404 11405 11406 11407
/**
 * 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)
{
11408
    VIR_DOMAIN_DEBUG0(dom);
11409 11410 11411 11412

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
11413
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11414
        virDispatchError(NULL);
11415
        return -1;
11416 11417 11418 11419 11420 11421 11422 11423 11424
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

11425
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11426 11427 11428 11429 11430
error:
    virDispatchError(dom->conn);
    return -1;
}

11431 11432 11433 11434 11435 11436 11437 11438 11439 11440
/**
 * 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)
{
11441
    VIR_DEBUG("net=%p", net);
11442 11443 11444 11445

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
11446
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11447
        virDispatchError(NULL);
11448
        return -1;
11449 11450 11451 11452 11453 11454 11455 11456 11457
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

11458
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11459
error:
11460
    virDispatchError(net->conn);
11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475
    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)
{
11476
    VIR_DEBUG("net=%p", net);
11477 11478 11479 11480

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
11481
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11482
        virDispatchError(NULL);
11483
        return -1;
11484 11485 11486 11487 11488 11489 11490 11491 11492
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

11493
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11494
error:
11495
    virDispatchError(net->conn);
11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509
    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)
{
11510
    VIR_DEBUG("pool=%p", pool);
11511 11512 11513 11514

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11515
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11516
        virDispatchError(NULL);
11517
        return -1;
11518 11519 11520 11521 11522 11523 11524 11525 11526
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

11527
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11528
error:
11529
    virDispatchError(pool->conn);
11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544
    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)
{
11545
    VIR_DEBUG("pool=%p", pool);
11546 11547 11548 11549

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11550
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11551
        virDispatchError(NULL);
11552
        return -1;
11553 11554 11555 11556 11557 11558 11559 11560 11561
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

11562
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11563
error:
11564
    virDispatchError(pool->conn);
11565 11566 11567 11568
    return -1;
}


S
Stefan Berger 已提交
11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580

/**
 * 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)
{
11581
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
11582 11583 11584 11585

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11586
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598
        virDispatchError(NULL);
        return -1;
    }

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

11599
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619

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)
{
11620
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
11621 11622 11623 11624

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11625
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11626 11627 11628 11629 11630
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
11631
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642
        goto error;
    }

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

11643
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663

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)
{
11664
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
11665 11666 11667 11668

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11669
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11670
        virDispatchError(NULL);
11671
        return NULL;
S
Stefan Berger 已提交
11672 11673
    }
    if (name == NULL) {
11674
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685
        goto  error;
    }

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

11686
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705

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)
{
11706
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
S
Stefan Berger 已提交
11707 11708 11709 11710

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11711
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11712
        virDispatchError(NULL);
11713
        return NULL;
S
Stefan Berger 已提交
11714 11715
    }
    if (uuid == NULL) {
11716
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727
        goto error;
    }

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

11728
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11729 11730 11731 11732 11733 11734 11735

error:
    virDispatchError(conn);
    return NULL;
}

/**
11736
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748
 * @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];
11749
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
S
Stefan Berger 已提交
11750 11751 11752 11753

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11754
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11755
        virDispatchError(NULL);
11756
        return NULL;
S
Stefan Berger 已提交
11757 11758
    }
    if (uuidstr == NULL) {
11759
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11760 11761 11762 11763
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
11764
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786
        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)
{
11787
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
11788 11789 11790 11791

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
11792
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814
        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)
{
11815
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
11816 11817 11818 11819

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
11820
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
11821
        virDispatchError(NULL);
11822
        return NULL;
S
Stefan Berger 已提交
11823
    }
11824
    return nwfilter->name;
S
Stefan Berger 已提交
11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838
}

/**
 * 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)
{
11839
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
11840 11841 11842 11843

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
11844
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
11845 11846 11847 11848
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
11849
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
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
        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];
11876
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
11877 11878 11879 11880

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
11881
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
11882 11883 11884 11885
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
11886
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914
        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)
{
11915
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
11916 11917 11918 11919

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11920
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11921
        virDispatchError(NULL);
11922
        return NULL;
S
Stefan Berger 已提交
11923 11924
    }
    if (xmlDesc == NULL) {
11925
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11926 11927 11928
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
11929
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc, 0);
        if (!ret)
            goto error;
        return ret;
    }

11941
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962

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;
11963
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
11964 11965 11966 11967

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
11968
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
11969 11970 11971 11972 11973 11974
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
11975
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986
        goto error;
    }

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

11987
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009

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;
12010
    VIR_DEBUG("nwfilter=%p, flags=%d", nwfilter, flags);
S
Stefan Berger 已提交
12011 12012 12013 12014

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
12015
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12016
        virDispatchError(NULL);
12017
        return NULL;
S
Stefan Berger 已提交
12018 12019
    }
    if (flags != 0) {
12020
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033
        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;
    }

12034
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062

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))) {
12063
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12064 12065 12066 12067
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
12068
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
12069 12070 12071 12072 12073 12074
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


12075 12076 12077 12078 12079 12080 12081 12082 12083 12084
/**
 * 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)
{
12085
    VIR_DEBUG("iface=%p", iface);
12086 12087 12088 12089

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
12090
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12091
        virDispatchError(NULL);
12092
        return -1;
12093 12094 12095 12096 12097 12098 12099 12100 12101
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

12102
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12103
error:
12104
    virDispatchError(iface->conn);
12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118
    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)
{
12119
    VIR_DEBUG("conn=%p", conn);
12120 12121 12122 12123

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12124
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12125
        virDispatchError(NULL);
12126
        return -1;
12127 12128 12129 12130 12131 12132 12133 12134 12135
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

12136
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12137
error:
12138
    virDispatchError(conn);
12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155
    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)
{
12156
    VIR_DEBUG("conn=%p", conn);
12157 12158 12159 12160

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12161
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12162
        virDispatchError(NULL);
12163
        return -1;
12164 12165 12166 12167 12168 12169 12170 12171 12172
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

12173
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12174
error:
12175
    virDispatchError(conn);
12176 12177
    return -1;
}
J
Jiri Denemark 已提交
12178 12179 12180 12181 12182


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
12183 12184 12185 12186
 * @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 已提交
12187 12188 12189 12190 12191 12192 12193 12194
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
12195
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%u", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
12196 12197 12198 12199

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12200
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12201
        virDispatchError(NULL);
J
Jiri Denemark 已提交
12202 12203 12204
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
12205
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217
        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;
    }

12218
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
12219 12220

error:
12221
    virDispatchError(conn);
J
Jiri Denemark 已提交
12222 12223
    return VIR_CPU_COMPARE_ERROR;
}
12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256


/**
 * 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)) {
12257
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12258 12259 12260 12261
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
12262
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274
        goto error;
    }

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

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

12275
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12276 12277 12278 12279 12280

error:
    virDispatchError(conn);
    return NULL;
}
12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296


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

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
12299 12300 12301 12302

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12303
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12304
        virDispatchError(NULL);
12305
        return -1;
12306 12307
    }
    if (info == NULL) {
12308
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323
        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;
    }

12324
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12325 12326 12327 12328 12329

error:
    virDispatchError(domain->conn);
    return -1;
}
12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346


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

12347
    VIR_DOMAIN_DEBUG0(domain);
12348 12349 12350 12351

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12352
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12353
        virDispatchError(NULL);
12354
        return -1;
12355 12356 12357 12358
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12359
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370
        goto error;
    }

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

12371
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12372 12373 12374 12375 12376

error:
    virDispatchError(conn);
    return -1;
}
12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397


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

12398
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%u", downtime, flags);
12399 12400 12401 12402

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12403
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12404 12405 12406 12407 12408 12409
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12410
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12411 12412 12413 12414 12415 12416 12417 12418 12419
        goto error;
    }

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

12420
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466
error:
    virDispatchError(conn);
    return -1;
}

/**
 * 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.
 * If the callback wishes to keep the domain object after the callback
 * returns, it shall take a reference to it, by calling virDomainRef.
 * 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)
{
12467 12468 12469
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

12470 12471 12472
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12473
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12474
        virDispatchError(NULL);
12475
        return -1;
12476 12477 12478
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
12479
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12480
        virDispatchError(conn);
12481
        return -1;
12482 12483
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
12484
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495
        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;
    }

12496
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12497 12498 12499 12500
error:
    virDispatchError(conn);
    return -1;
}
12501

12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515
/**
 * 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)
{
12516
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
12517 12518 12519 12520

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12521
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12522
        virDispatchError(NULL);
12523
        return -1;
12524 12525
    }
    if (callbackID < 0) {
12526
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12527 12528 12529 12530 12531 12532 12533 12534 12535 12536
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

12537
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12538 12539 12540 12541
error:
    virDispatchError(conn);
    return -1;
}
12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561

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

12562
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
12563 12564 12565 12566

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12567
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12568 12569 12570 12571 12572 12573
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12574
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586
        goto error;
    }

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

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

12587
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609

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;

12610
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
12611 12612 12613 12614

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12615
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630
        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;
    }

12631
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
12643
 * Remove any managed save image for this domain.
12644 12645 12646 12647 12648 12649 12650
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

12651
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
12652 12653 12654 12655

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12656
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12657 12658 12659 12660 12661 12662
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12663
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675
        goto error;
    }

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

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

12676
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12677 12678 12679 12680 12681

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700

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

12701
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%u", xmlDesc, flags);
C
Chris Lalancette 已提交
12702 12703 12704 12705

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12706
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
12707 12708 12709 12710 12711 12712
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12713
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724
        goto error;
    }

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

12725
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745
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;
12746
    VIR_DEBUG("snapshot=%p, flags=%d", snapshot, flags);
C
Chris Lalancette 已提交
12747 12748 12749 12750

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
12751
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
12752 12753
                                  __FUNCTION__);
        virDispatchError(NULL);
12754
        return NULL;
C
Chris Lalancette 已提交
12755 12756 12757 12758 12759
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
12760
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

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

12773
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791
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;
12792 12793

    VIR_DOMAIN_DEBUG0(domain);
C
Chris Lalancette 已提交
12794 12795 12796 12797

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12798
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810
        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;
    }

12811
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835
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;

12836 12837
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%u",
                     names, nameslen, flags);
C
Chris Lalancette 已提交
12838 12839 12840 12841

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12842
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
12843 12844 12845 12846 12847 12848 12849
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
12850
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861
        goto error;
    }

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

12862
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885
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;
12886 12887

    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%u", name, flags);
C
Chris Lalancette 已提交
12888 12889 12890 12891

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12892
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
12893
        virDispatchError(NULL);
12894
        return NULL;
C
Chris Lalancette 已提交
12895 12896 12897 12898 12899
    }

    conn = domain->conn;

    if (name == NULL) {
12900
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911
        goto error;
    }

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

12912
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930
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;
12931 12932

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
12933 12934 12935 12936

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12937
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950
        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;
    }

12951
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972
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;
12973 12974

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
12975 12976 12977 12978

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12979
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
12980
        virDispatchError(NULL);
12981
        return NULL;
C
Chris Lalancette 已提交
12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

12994
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
12995 12996 12997 12998 12999 13000
error:
    virDispatchError(conn);
    return NULL;
}

/**
13001
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014
 * @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;

13015
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
13016 13017 13018 13019

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13020
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;

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

13035
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13036 13037 13038 13039 13040 13041
error:
    virDispatchError(conn);
    return -1;
}

/**
13042
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060
 * @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;

13061
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
13062 13063 13064 13065

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13066
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;

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

13081
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098
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)
{
13099
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
13100 13101 13102 13103

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13104
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13105 13106 13107 13108 13109 13110 13111 13112 13113 13114
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137

/**
 * 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;
13138 13139 13140

    VIR_DOMAIN_DEBUG(dom, "devname=%s, st=%p, flags=%u",
                     NULLSTR(devname), st, flags);
13141 13142 13143 13144

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
13145
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13146 13147 13148 13149 13150 13151
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13152
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
        ret = conn->driver->domainOpenConsole(dom, devname, st, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

13164
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13165 13166 13167 13168 13169

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