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

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

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

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

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

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

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

43
#ifndef WITH_DRIVER_MODULES
44 45 46 47 48 49 50 51 52 53 54 55
# ifdef WITH_TEST
#  include "test/test_driver.h"
# endif
# ifdef WITH_XEN
#  include "xen/xen_driver.h"
# endif
# ifdef WITH_REMOTE
#  include "remote/remote_driver.h"
# endif
# ifdef WITH_OPENVZ
#  include "openvz/openvz_driver.h"
# endif
56 57 58
# ifdef WITH_VMWARE
#  include "vmware/vmware_driver.h"
# endif
59 60 61 62 63 64 65 66 67
# ifdef WITH_PHYP
#  include "phyp/phyp_driver.h"
# endif
# ifdef WITH_VBOX
#  include "vbox/vbox_driver.h"
# endif
# ifdef WITH_ESX
#  include "esx/esx_driver.h"
# endif
68 69 70
# ifdef WITH_XENAPI
#  include "xenapi/xenapi_driver.h"
# endif
71
#endif
72

73 74
#define VIR_FROM_THIS VIR_FROM_NONE

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

81
#define MAX_DRIVERS 20
82

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

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

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

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

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

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

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

    return 0;
}
#endif

136 137 138 139 140 141 142 143
static int virConnectAuthCallbackDefault(virConnectCredentialPtr cred,
                                         unsigned int ncred,
                                         void *cbdata ATTRIBUTE_UNUSED) {
    int i;

    for (i = 0 ; i < ncred ; i++) {
        char buf[1024];
        char *bufptr = buf;
144
        size_t len;
145 146

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

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

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

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

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

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

        default:
            return -1;
199 200
        }

D
Daniel P. Berrange 已提交
201 202 203 204 205 206 207 208 209
        if (cred[i].type != VIR_CRED_EXTERNAL) {
            if (STREQ(bufptr, "") && cred[i].defresult)
                cred[i].result = strdup(cred[i].defresult);
            else
                cred[i].result = strdup(bufptr);
            if (!cred[i].result)
                return -1;
            cred[i].resultlen = strlen(cred[i].result);
        }
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
    }

    return 0;
}

/* Don't typically want VIR_CRED_USERNAME. It enables you to authenticate
 * as one user, and act as another. It just results in annoying
 * prompts for the username twice & is very rarely what you want
 */
static int virConnectCredTypeDefault[] = {
    VIR_CRED_AUTHNAME,
    VIR_CRED_ECHOPROMPT,
    VIR_CRED_REALM,
    VIR_CRED_PASSPHRASE,
    VIR_CRED_NOECHOPROMPT,
225
    VIR_CRED_EXTERNAL,
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
};

static virConnectAuth virConnectAuthDefault = {
    virConnectCredTypeDefault,
    sizeof(virConnectCredTypeDefault)/sizeof(int),
    virConnectAuthCallbackDefault,
    NULL,
};

/*
 * virConnectAuthPtrDefault
 *
 * A default implementation of the authentication callbacks. This
 * implementation is suitable for command line based tools. It will
 * prompt for username, passwords, realm and one time keys as needed.
 * It will print on STDOUT, and read from STDIN. If this is not
 * suitable for the application's needs an alternative implementation
 * should be provided.
 */
virConnectAuthPtr virConnectAuthPtrDefault = &virConnectAuthDefault;

247 248 249 250 251 252 253 254 255 256
#if HAVE_WINSOCK2_H
static int
winsock_init (void)
{
    WORD winsock_version, err;
    WSADATA winsock_data;

    /* http://msdn2.microsoft.com/en-us/library/ms742213.aspx */
    winsock_version = MAKEWORD (2, 2);
    err = WSAStartup (winsock_version, &winsock_data);
J
Jim Meyering 已提交
257
    return err == 0 ? 0 : -1;
258 259 260
}
#endif

D
Daniel P. Berrange 已提交
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
static int virTLSMutexInit (void **priv)
{                                                                             \
    virMutexPtr lock = NULL;

    if (VIR_ALLOC(lock) < 0)
        return ENOMEM;

    if (virMutexInit(lock) < 0) {
        VIR_FREE(lock);
        return errno;
    }

    *priv = lock;
    return 0;
}

static int virTLSMutexDestroy(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexDestroy(lock);
    VIR_FREE(lock);
    return 0;
}

static int virTLSMutexLock(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexLock(lock);
    return 0;
}

static int virTLSMutexUnlock(void **priv)
{
    virMutexPtr lock = *priv;
    virMutexUnlock(lock);
    return 0;
}

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

314 315 316 317 318 319 320 321 322 323 324 325 326 327
/* 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;                           \
    }                                                     \
                                                          \
328
    VIR_DEBUG("dom=%p, (VM: name=%s, uuid=%s), " fmt,         \
329 330 331
          dom, NULLSTR(_domname), _uuidstr, __VA_ARGS__)

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

333 334 335 336 337 338 339 340 341 342 343 344 345
/**
 * 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)
346
        return 0;
347

348
    initialized = 1;
349

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

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

358
    virLogSetFromEnv();
359

360
    VIR_DEBUG("register drivers");
361

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

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

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

433
    return 0;
434 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
#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
469

470
#define virLibConnError(code, ...)                                \
471
    virReportErrorHelper(VIR_FROM_NONE, code, __FILE__,           \
472 473
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibDomainError(code, ...)                              \
474
    virReportErrorHelper(VIR_FROM_DOM, code, __FILE__,            \
475 476
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNetworkError(code, ...)                             \
477
    virReportErrorHelper(VIR_FROM_NETWORK, code, __FILE__,        \
478 479
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStoragePoolError(code, ...)                         \
480
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
481 482
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStorageVolError(code, ...)                          \
483
    virReportErrorHelper(VIR_FROM_STORAGE, code, __FILE__,        \
484 485
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibInterfaceError(code, ...)                           \
486
    virReportErrorHelper(VIR_FROM_INTERFACE, code, __FILE__,      \
487 488
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNodeDeviceError(code, ...)                          \
489
    virReportErrorHelper(VIR_FROM_NODEDEV, code, __FILE__,        \
490 491
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibSecretError(code, ...)                              \
492
    virReportErrorHelper(VIR_FROM_SECRET, code, __FILE__,         \
493 494
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibStreamError(code, ...)                              \
495
    virReportErrorHelper(VIR_FROM_STREAMS, code, __FILE__,        \
496 497
                         __FUNCTION__, __LINE__, __VA_ARGS__)
#define virLibNWFilterError(code, ...)                            \
498
    virReportErrorHelper(VIR_FROM_NWFILTER, code, __FILE__,       \
499
                         __FUNCTION__, __LINE__, __VA_ARGS__)
500 501
#define virLibDomainSnapshotError(code, ...)                       \
    virReportErrorHelper(VIR_FROM_DOMAIN_SNAPSHOT, code, __FILE__, \
502
                         __FUNCTION__, __LINE__, __VA_ARGS__)
503

C
Chris Lalancette 已提交
504

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A
Atsushi SAKAI 已提交
855
#endif
856

857 858


859 860 861
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
862 863 864 865 866 867 868 869 870
 * @type: the type of connection/driver looked at, if @typeVer is not NULL
 * @typeVer: optional return value for the version of the hypervisor (OUT)
 *
 * Provides information on up to two versions: @libVer is the version of the
 * library and will always be set unless an error occurs, in which case an
 * error code will be returned. If @typeVer is not NULL it will be set to the
 * version of the hypervisor @type against which the library was compiled.
 * If @type is NULL, "Xen" is assumed, if @type is unknown or not
 * available, an error code will be returned and @typeVer will be 0.
871 872 873 874 875
 *
 * 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
# endif
J
Jim Fehlig 已提交
915 916 917 918
# if WITH_LIBXL
        if (STRCASEEQ(type, "xenlight"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
919
# if WITH_PHYP
920 921
        if (STRCASEEQ(type, "phyp"))
            *typeVer = LIBVIR_VERSION_NUMBER;
922 923
# endif
# if WITH_OPENVZ
924 925
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
926
# endif
927 928 929 930
# if WITH_VMWARE
        if (STRCASEEQ(type, "VMware"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
931
# if WITH_VBOX
932 933
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
934 935
# endif
# if WITH_UML
936 937
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
938 939
# endif
# if WITH_ONE
D
Daniel Veillard 已提交
940 941
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
942 943
# endif
# if WITH_ESX
944 945
        if (STRCASEEQ(type, "ESX"))
            *typeVer = LIBVIR_VERSION_NUMBER;
946
# endif
947 948 949 950
# if WITH_XENAPI
        if (STRCASEEQ(type, "XenAPI"))
            *typeVer = LIBVIR_VERSION_NUMBER;
# endif
951
# if WITH_REMOTE
952 953
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
954
# endif
955
        if (*typeVer == 0) {
956
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
957
            goto error;
958
        }
959
#endif /* WITH_DRIVER_MODULES */
960
    }
961
    return 0;
962 963 964 965

error:
    virDispatchError(NULL);
    return -1;
966 967
}

968
static virConnectPtr
969 970 971
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
972
{
973
    int i, res;
974 975
    virConnectPtr ret;

976 977
    virResetLastError();

978 979 980
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
981

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

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

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

1032 1033 1034
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

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

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

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

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

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

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

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

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

1182
    return ret;
1183 1184

failed:
1185 1186
    virUnrefConnect(ret);

1187
    return NULL;
1188 1189
}

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

1220
    VIR_DEBUG("name=%s", name);
1221 1222 1223 1224 1225 1226 1227 1228
    ret = do_open (name, NULL, 0);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
1229 1230
}

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

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

error:
    virDispatchError(NULL);
    return NULL;
1263 1264 1265 1266 1267 1268 1269 1270
}

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

1292
    VIR_DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1293 1294 1295 1296 1297 1298 1299 1300
    ret = do_open (name, auth, flags);
    if (!ret)
        goto error;
    return ret;

error:
    virDispatchError(NULL);
    return NULL;
D
Daniel Veillard 已提交
1301 1302 1303
}

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

1320 1321 1322
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1323
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1324
        goto error;
1325
    }
1326

1327 1328 1329 1330 1331 1332 1333 1334
    ret = virUnrefConnect(conn);
    if (ret < 0)
        goto error;
    return ret;

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

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

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

1379 1380 1381
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1382
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1383
        virDispatchError(NULL);
1384
        return -1;
1385
    }
1386

1387 1388 1389 1390
    if (!conn->driver->supports_feature)
        ret = 0;
    else
        ret = conn->driver->supports_feature(conn, feature);
1391 1392

    if (ret < 0)
1393
        virDispatchError(conn);
1394

1395
    return ret;
1396 1397
}

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

1415 1416
    virResetLastError();

D
Daniel Veillard 已提交
1417
    if (!VIR_IS_CONNECT(conn)) {
1418
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1419
        virDispatchError(NULL);
1420
        return NULL;
D
Daniel Veillard 已提交
1421
    }
1422 1423 1424 1425

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1426
    }
1427
    return conn->driver->name;
1428 1429
}

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

1448 1449
    virResetLastError();

D
Daniel Veillard 已提交
1450
    if (!VIR_IS_CONNECT(conn)) {
1451
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1452
        virDispatchError(NULL);
1453
        return -1;
D
Daniel Veillard 已提交
1454
    }
1455

D
Daniel Veillard 已提交
1456
    if (hvVer == NULL) {
1457
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1458
        goto error;
D
Daniel Veillard 已提交
1459
    }
1460

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

1468
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1469 1470

error:
1471
    virDispatchError(conn);
1472
    return -1;
1473 1474
}

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

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
1495
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1496
        virDispatchError(NULL);
1497 1498 1499 1500
        return -1;
    }

    if (libVer == NULL) {
1501
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
        goto error;
    }

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

1512 1513 1514
    *libVer = LIBVIR_VERSION_NUMBER;
    return 0;

1515
error:
1516
    virDispatchError(conn);
1517 1518 1519
    return ret;
}

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

1537 1538
    virResetLastError();

1539
    if (!VIR_IS_CONNECT(conn)) {
1540
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1541
        virDispatchError(NULL);
1542 1543 1544
        return NULL;
    }

1545 1546 1547 1548 1549 1550
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1551

1552
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1553 1554

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

1580 1581
    virResetLastError();

1582
    if (!VIR_IS_CONNECT(conn)) {
1583
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1584
        virDispatchError(NULL);
1585 1586 1587
        return NULL;
    }

1588
    name = (char *)xmlSaveUri(conn->uri);
1589
    if (!name) {
1590
        virReportOOMError();
1591
        goto error;
1592 1593
    }
    return name;
1594 1595

error:
1596
    virDispatchError(conn);
1597
    return NULL;
1598 1599
}

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

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

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

1657 1658
    virResetLastError();

1659
    if (!VIR_IS_CONNECT(conn)) {
1660
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1661
        virDispatchError(NULL);
1662
        return -1;
1663 1664
    }

1665 1666 1667 1668 1669 1670
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1671

1672
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1673
error:
1674
    virDispatchError(conn);
1675
    return -1;
1676 1677
}

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

1693 1694
    virResetLastError();

D
Daniel Veillard 已提交
1695
    if (!VIR_IS_CONNECT(conn)) {
1696
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1697
        virDispatchError(NULL);
1698
        return -1;
D
Daniel Veillard 已提交
1699
    }
1700

1701
    if ((ids == NULL) || (maxids < 0)) {
1702
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1703
        goto error;
D
Daniel Veillard 已提交
1704
    }
1705

1706 1707 1708 1709 1710 1711
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1712

1713
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1714
error:
1715
    virDispatchError(conn);
1716
    return -1;
D
Daniel Veillard 已提交
1717 1718
}

K
 
Karel Zak 已提交
1719 1720 1721 1722
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1723 1724
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1725 1726 1727
 * Returns the number of domain found or -1 in case of error
 */
int
1728 1729
virConnectNumOfDomains(virConnectPtr conn)
{
1730
    VIR_DEBUG("conn=%p", conn);
1731

1732 1733
    virResetLastError();

D
Daniel Veillard 已提交
1734
    if (!VIR_IS_CONNECT(conn)) {
1735
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
1736
        virDispatchError(NULL);
1737
        return -1;
D
Daniel Veillard 已提交
1738
    }
K
Karel Zak 已提交
1739

1740 1741 1742 1743 1744 1745
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1746

1747
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1748
error:
1749
    virDispatchError(conn);
1750
    return -1;
K
 
Karel Zak 已提交
1751 1752
}

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

1772 1773 1774
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1775
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1776
        virDispatchError(NULL);
1777 1778 1779 1780 1781
        return NULL;
    }
    return dom->conn;
}

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

1803 1804
    virResetLastError();

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

1819 1820 1821 1822 1823 1824 1825
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1826

1827
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1828
error:
1829
    virDispatchError(conn);
1830
    return NULL;
D
Daniel Veillard 已提交
1831 1832
}

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

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

1869 1870
    virResetLastError();

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

1881 1882 1883 1884 1885 1886 1887
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1888

1889
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1890 1891

error:
1892
    virDispatchError(conn);
1893
    return NULL;
1894 1895 1896 1897 1898
}

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

1912
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
1913

1914 1915
    virResetLastError();

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

1926 1927 1928 1929 1930 1931 1932
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1933

1934
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
1935 1936

error:
1937
    virDispatchError(conn);
1938
    return NULL;
1939 1940
}

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

1957 1958
    virResetLastError();

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

    if (virUUIDParse(uuidstr, uuid) < 0) {
1970
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
1971
        goto error;
K
Karel Zak 已提交
1972
    }
1973

K
Karel Zak 已提交
1974
    return virDomainLookupByUUID(conn, &uuid[0]);
1975 1976

error:
1977
    virDispatchError(conn);
1978
    return NULL;
K
Karel Zak 已提交
1979 1980
}

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

1996 1997
    virResetLastError();

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

2008 2009 2010 2011 2012 2013 2014
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
2015

2016
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2017 2018

error:
2019
    virDispatchError(conn);
2020
    return NULL;
2021 2022
}

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

2039
    VIR_DOMAIN_DEBUG0(domain);
2040

2041 2042
    virResetLastError();

D
Daniel Veillard 已提交
2043
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2044
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2045
        virDispatchError(NULL);
2046
        return -1;
D
Daniel Veillard 已提交
2047
    }
2048

2049
    conn = domain->conn;
2050
    if (conn->flags & VIR_CONNECT_RO) {
2051
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2052
        goto error;
2053
    }
2054

2055 2056 2057 2058 2059 2060 2061
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2062

2063
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2064 2065

error:
2066
    virDispatchError(conn);
2067
    return -1;
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
}

/**
 * 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
2080 2081
virDomainFree(virDomainPtr domain)
{
2082
    VIR_DOMAIN_DEBUG0(domain);
2083

2084 2085 2086
    virResetLastError();

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

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


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

    VIR_DOMAIN_DEBUG0(domain);
2149

2150 2151
    virResetLastError();

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

2162 2163
    conn = domain->conn;

2164 2165 2166 2167 2168 2169 2170
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2171

2172
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2173 2174

error:
2175
    virDispatchError(domain->conn);
2176
    return -1;
D
Daniel Veillard 已提交
2177 2178 2179
}

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

    VIR_DOMAIN_DEBUG0(domain);
2195

2196 2197
    virResetLastError();

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

2208 2209
    conn = domain->conn;

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

2218
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2219 2220

error:
2221
    virDispatchError(domain->conn);
2222
    return -1;
D
Daniel Veillard 已提交
2223 2224
}

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

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

2244 2245
    virResetLastError();

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

2261 2262 2263
    if (conn->driver->domainSave) {
        int ret;
        char *absolute_to;
2264

2265 2266 2267 2268 2269 2270
        /* We must absolutize the file path as the save is done out of process */
        if (virFileAbsPath(to, &absolute_to) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute output file path"));
            goto error;
        }
2271

2272 2273 2274
        ret = conn->driver->domainSave(domain, absolute_to);

        VIR_FREE(absolute_to);
2275

2276 2277 2278 2279
        if (ret < 0)
            goto error;
        return ret;
    }
2280

2281
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2282 2283

error:
2284
    virDispatchError(domain->conn);
2285
    return -1;
2286 2287 2288 2289
}

/**
 * virDomainRestore:
2290
 * @conn: pointer to the hypervisor connection
2291
 * @from: path to the input file
2292 2293 2294 2295 2296 2297
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2298 2299
virDomainRestore(virConnectPtr conn, const char *from)
{
2300
    VIR_DEBUG("conn=%p, from=%s", conn, from);
2301

2302 2303
    virResetLastError();

D
Daniel Veillard 已提交
2304
    if (!VIR_IS_CONNECT(conn)) {
2305
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
2306
        virDispatchError(NULL);
2307
        return -1;
D
Daniel Veillard 已提交
2308
    }
2309
    if (conn->flags & VIR_CONNECT_RO) {
2310
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2311
        goto error;
2312
    }
D
Daniel Veillard 已提交
2313
    if (from == NULL) {
2314
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2315
        goto error;
D
Daniel Veillard 已提交
2316 2317
    }

2318 2319 2320
    if (conn->driver->domainRestore) {
        int ret;
        char *absolute_from;
2321

2322 2323
        /* We must absolutize the file path as the restore is done out of process */
        if (virFileAbsPath(from, &absolute_from) < 0) {
2324
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
2325
                            _("could not build absolute input file path"));
2326 2327
            goto error;
        }
2328

2329 2330 2331 2332
        ret = conn->driver->domainRestore(conn, absolute_from);

        VIR_FREE(absolute_from);

2333 2334 2335 2336
        if (ret < 0)
            goto error;
        return ret;
    }
2337

2338
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2339 2340

error:
2341
    virDispatchError(conn);
2342
    return -1;
D
Daniel Veillard 已提交
2343 2344 2345 2346 2347 2348
}

/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
2349
 * @flags: an OR'ed set of virDomainCoreDumpFlags
D
Daniel Veillard 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
 *
 * This method will dump the core of a domain on a given file for analysis.
 * Note that for remote Xen Daemon the file path will be interpreted in
 * the remote host.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainCoreDump(virDomainPtr domain, const char *to, int flags)
{
    virConnectPtr conn;
2361 2362

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

2364 2365
    virResetLastError();

D
Daniel Veillard 已提交
2366
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2367
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2368
        virDispatchError(NULL);
2369
        return -1;
D
Daniel Veillard 已提交
2370 2371
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
2372
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2373
        goto error;
D
Daniel Veillard 已提交
2374 2375 2376
    }
    conn = domain->conn;
    if (to == NULL) {
2377
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2378
        goto error;
D
Daniel Veillard 已提交
2379 2380
    }

2381 2382 2383 2384 2385 2386
    if ((flags & VIR_DUMP_CRASH) && (flags & VIR_DUMP_LIVE)) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                          _("crash and live flags are mutually exclusive"));
        goto error;
    }

2387 2388 2389
    if (conn->driver->domainCoreDump) {
        int ret;
        char *absolute_to;
D
Daniel Veillard 已提交
2390

2391 2392 2393 2394
        /* We must absolutize the file path as the save is done out of process */
        if (virFileAbsPath(to, &absolute_to) < 0) {
            virLibConnError(VIR_ERR_INTERNAL_ERROR,
                            _("could not build absolute core file path"));
2395 2396
            goto error;
        }
D
Daniel Veillard 已提交
2397

2398 2399 2400
        ret = conn->driver->domainCoreDump(domain, absolute_to, flags);

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

2402 2403 2404 2405
        if (ret < 0)
            goto error;
        return ret;
    }
2406

2407
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2408 2409

error:
2410
    virDispatchError(domain->conn);
2411
    return -1;
2412 2413
}

2414 2415 2416 2417 2418
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2419 2420
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2421 2422 2423 2424 2425 2426 2427
 *
 * 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
2428 2429
virDomainShutdown(virDomainPtr domain)
{
2430
    virConnectPtr conn;
2431 2432

    VIR_DOMAIN_DEBUG0(domain);
2433

2434 2435
    virResetLastError();

D
Daniel Veillard 已提交
2436
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2437
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2438
        virDispatchError(NULL);
2439
        return -1;
D
Daniel Veillard 已提交
2440
    }
2441
    if (domain->conn->flags & VIR_CONNECT_RO) {
2442
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2443
        goto error;
2444
    }
2445

2446 2447
    conn = domain->conn;

2448 2449 2450 2451 2452 2453 2454
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2455

2456
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2457 2458

error:
2459
    virDispatchError(domain->conn);
2460
    return -1;
2461 2462
}

2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
/**
 * 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)
{
2477
    virConnectPtr conn;
2478 2479

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

2481 2482
    virResetLastError();

2483
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2484
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2485
        virDispatchError(NULL);
2486
        return -1;
2487
    }
2488
    if (domain->conn->flags & VIR_CONNECT_RO) {
2489
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2490
        goto error;
2491
    }
2492

2493 2494
    conn = domain->conn;

2495 2496 2497 2498 2499 2500 2501
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2502

2503
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2504 2505

error:
2506
    virDispatchError(domain->conn);
2507
    return -1;
2508 2509
}

2510
/**
2511
 * virDomainGetName:
2512 2513 2514 2515 2516 2517 2518 2519
 * @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 *
2520 2521
virDomainGetName(virDomainPtr domain)
{
2522
    VIR_DEBUG("domain=%p", domain);
2523

2524 2525
    virResetLastError();

D
Daniel Veillard 已提交
2526
    if (!VIR_IS_DOMAIN(domain)) {
2527
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2528
        virDispatchError(NULL);
2529
        return NULL;
D
Daniel Veillard 已提交
2530
    }
2531
    return domain->name;
2532 2533
}

2534 2535 2536
/**
 * virDomainGetUUID:
 * @domain: a domain object
2537
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2538 2539 2540 2541 2542 2543
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2544 2545
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2546
    VIR_DOMAIN_DEBUG(domain, "uuid=%p", uuid);
2547

2548 2549
    virResetLastError();

D
Daniel Veillard 已提交
2550
    if (!VIR_IS_DOMAIN(domain)) {
2551
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2552
        virDispatchError(NULL);
2553
        return -1;
D
Daniel Veillard 已提交
2554 2555
    }
    if (uuid == NULL) {
2556
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2557
        virDispatchError(domain->conn);
2558
        return -1;
D
Daniel Veillard 已提交
2559 2560
    }

2561 2562
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2563
    return 0;
2564 2565
}

K
Karel Zak 已提交
2566 2567 2568
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2569
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2570
 *
2571
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2572 2573 2574 2575 2576 2577 2578
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2579
    unsigned char uuid[VIR_UUID_BUFLEN];
2580 2581

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

2583 2584
    virResetLastError();

K
Karel Zak 已提交
2585
    if (!VIR_IS_DOMAIN(domain)) {
2586
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2587
        virDispatchError(NULL);
2588
        return -1;
K
Karel Zak 已提交
2589 2590
    }
    if (buf == NULL) {
2591
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2592
        goto error;
K
Karel Zak 已提交
2593
    }
2594

K
Karel Zak 已提交
2595
    if (virDomainGetUUID(domain, &uuid[0]))
2596
        goto error;
K
Karel Zak 已提交
2597

2598
    virUUIDFormat(uuid, buf);
2599
    return 0;
2600 2601

error:
2602
    virDispatchError(domain->conn);
2603
    return -1;
K
Karel Zak 已提交
2604 2605
}

2606
/**
2607
 * virDomainGetID:
2608 2609 2610 2611 2612 2613 2614
 * @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
2615 2616
virDomainGetID(virDomainPtr domain)
{
2617
    VIR_DOMAIN_DEBUG0(domain);
2618

2619 2620
    virResetLastError();

D
Daniel Veillard 已提交
2621
    if (!VIR_IS_DOMAIN(domain)) {
2622
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2623
        virDispatchError(NULL);
2624
        return (unsigned int)-1;
D
Daniel Veillard 已提交
2625
    }
2626
    return domain->id;
2627 2628
}

2629 2630 2631 2632 2633 2634
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2635 2636
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2637 2638
 */
char *
2639 2640
virDomainGetOSType(virDomainPtr domain)
{
2641
    virConnectPtr conn;
2642 2643

    VIR_DOMAIN_DEBUG0(domain);
2644

2645 2646 2647
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2648
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2649
        virDispatchError(NULL);
2650
        return NULL;
D
Daniel Veillard 已提交
2651
    }
2652

2653 2654
    conn = domain->conn;

2655 2656 2657 2658 2659 2660 2661
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2662

2663
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2664 2665

error:
2666
    virDispatchError(domain->conn);
2667
    return NULL;
2668 2669
}

2670
/**
2671
 * virDomainGetMaxMemory:
2672
 * @domain: a domain object or NULL
2673
 *
2674 2675 2676 2677 2678 2679 2680
 * 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
2681 2682
virDomainGetMaxMemory(virDomainPtr domain)
{
2683
    virConnectPtr conn;
2684 2685

    VIR_DOMAIN_DEBUG0(domain);
2686

2687 2688
    virResetLastError();

D
Daniel Veillard 已提交
2689
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2690
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2691
        virDispatchError(NULL);
2692
        return 0;
D
Daniel Veillard 已提交
2693
    }
2694

2695 2696
    conn = domain->conn;

2697 2698 2699 2700 2701 2702 2703
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2704

2705
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2706 2707

error:
2708
    virDispatchError(domain->conn);
2709
    return 0;
2710 2711
}

D
Daniel Veillard 已提交
2712
/**
2713
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2714 2715
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2716
 *
D
Daniel Veillard 已提交
2717 2718 2719
 * 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.
2720
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2721
 *
2722 2723 2724
 * This command is hypervisor-specific for whether active, persistent,
 * or both configurations are changed; for more control, use
 * virDomainSetMemoryFlags().
2725
 *
D
Daniel Veillard 已提交
2726 2727 2728
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2729 2730
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2731
    virConnectPtr conn;
2732 2733

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

2735 2736
    virResetLastError();

2737
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2738
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2739
        virDispatchError(NULL);
2740
        return -1;
2741
    }
2742
    if (domain->conn->flags & VIR_CONNECT_RO) {
2743
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2744
        goto error;
2745
    }
2746
    if (!memory) {
2747
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2748
        goto error;
2749
    }
2750
    conn = domain->conn;
2751

2752 2753 2754 2755 2756 2757 2758
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2759

2760
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2761 2762

error:
2763
    virDispatchError(domain->conn);
2764
    return -1;
2765
}
2766

2767 2768 2769 2770
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2771
 *
2772 2773 2774
 * 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.
2775
 * This function may requires privileged access to the hypervisor.
2776
 *
2777 2778 2779
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
2780 2781 2782 2783 2784 2785
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2786 2787

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

2789 2790
    virResetLastError();

2791
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2792
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2793
        virDispatchError(NULL);
2794
        return -1;
2795
    }
2796
    if (domain->conn->flags & VIR_CONNECT_RO) {
2797
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2798
        goto error;
2799
    }
2800
    if (!memory) {
2801
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2802
        goto error;
2803 2804 2805
    }

    conn = domain->conn;
2806

2807 2808 2809 2810 2811 2812 2813
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2814

2815
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2816 2817

error:
2818
    virDispatchError(domain->conn);
2819
    return -1;
D
Daniel Veillard 已提交
2820 2821
}

2822
/*
2823
 * virDomainSetMemoryFlags:
2824 2825 2826 2827 2828 2829 2830
 * @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.
2831
 * This function may requires privileged access to the hypervisor.
2832
 *
2833 2834 2835 2836 2837 2838 2839 2840
 * @flags may include VIR_DOMAIN_MEM_LIVE or VIR_DOMAIN_MEM_CONFIG.
 * Both flags may be set. If VIR_DOMAIN_MEM_LIVE is set, the change affects
 * a running domain and will fail if domain is not active.
 * If VIR_DOMAIN_MEM_CONFIG is set, the change affects persistent state,
 * and will fail for transient domains. If neither flag is specified
 * (that is, @flags is VIR_DOMAIN_MEM_CURRENT), then an inactive domain
 * modifies persistent setup, while an active domain is hypervisor-dependent
 * on whether just live or both live and persistent state is changed.
2841 2842
 * If VIR_DOMAIN_MEM_MAXIMUM is set, the change affects domain's maximum memory
 * size rather than current memory size.
2843
 * Not all hypervisors can support all flag combinations.
2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868
 *
 * 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;
    }

2869
    if (!memory) {
2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
        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;
    }

2884 2885
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

2886 2887 2888 2889 2890
error:
    virDispatchError(domain->conn);
    return -1;
}

2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
/**
 * 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;
2910 2911 2912

    VIR_DOMAIN_DEBUG(domain, "params=%p, nparams=%d, flags=%u",
                     params, nparams, flags);
2913 2914 2915 2916

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2917
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2918 2919 2920 2921
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
2922
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2923 2924 2925
        goto error;
    }
    if ((nparams <= 0) || (params == NULL)) {
2926
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938
        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;
    }

2939
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956

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
 *
2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973
 * 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;
 *     }
 * }
2974 2975
 *
 * This function requires privileged access to the hypervisor. This function
2976
 * expects the caller to allocate the @params.
2977 2978 2979 2980 2981 2982 2983 2984 2985
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetMemoryParameters(virDomainPtr domain,
                             virMemoryParameterPtr params,
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;
2986 2987 2988

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

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2993
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2994 2995 2996 2997
        virDispatchError(NULL);
        return -1;
    }
    if ((nparams == NULL) || (*nparams < 0)) {
2998
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009
        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;
    }
3010
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3011 3012 3013 3014 3015 3016

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

3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124
/**
 * virDomainSetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter objects
 * @nparams: number of blkio parameters (this value should be same or
 *          less than the number of parameters supported)
 * @flags: currently unused, for future extension
 *
 * Change the blkio tunables
 * This function requires privileged access to the hypervisor.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainSetBlkioParameters(virDomainPtr domain,
                             virBlkioParameterPtr params,
                             int nparams, unsigned int flags)
{
    virConnectPtr conn;

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

    virResetLastError();

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

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virDomainGetBlkioParameters:
 * @domain: pointer to domain object
 * @params: pointer to blkio parameter object
 *          (return value, allocated by the caller)
 * @nparams: pointer to number of blkio parameters
 * @flags: currently unused, for future extension
 *
 * Get the blkio parameters, the @params array will be filled with the values
 * equal to the number of parameters suggested by @nparams
 *
 * This function requires privileged access to the hypervisor. This function
 * expects the caller to allocate the @params.
 *
 * Returns -1 in case of error, 0 in case of success.
 */
int
virDomainGetBlkioParameters(virDomainPtr domain,
                             virBlkioParameterPtr params,
                             int *nparams, unsigned int flags)
{
    virConnectPtr conn;

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

    virResetLastError();

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

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

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

3125 3126
/**
 * virDomainGetInfo:
3127
 * @domain: a domain object
3128
 * @info: pointer to a virDomainInfo structure allocated by the user
3129
 *
3130
 * Extract information about a domain. Note that if the connection
3131
 * used to get the domain is limited only a partial set of the information
3132 3133 3134 3135 3136
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3137 3138
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
3139
    virConnectPtr conn;
3140 3141

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

3143 3144
    virResetLastError();

D
Daniel Veillard 已提交
3145
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3146
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3147
        virDispatchError(NULL);
3148
        return -1;
D
Daniel Veillard 已提交
3149 3150
    }
    if (info == NULL) {
3151
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3152
        goto error;
D
Daniel Veillard 已提交
3153
    }
3154

3155
    memset(info, 0, sizeof(virDomainInfo));
3156

3157 3158
    conn = domain->conn;

3159 3160 3161 3162 3163 3164 3165
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3166

3167
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3168 3169

error:
3170
    virDispatchError(domain->conn);
3171
    return -1;
3172
}
3173

3174 3175 3176
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
3177
 * @flags: an OR'ed set of virDomainXMLFlags
3178 3179
 *
 * Provide an XML description of the domain. The description may be reused
3180
 * later to relaunch the domain with virDomainCreateXML().
3181 3182 3183 3184 3185
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
3186 3187
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
3188
    virConnectPtr conn;
3189 3190

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

3192 3193 3194
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3195
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3196
        virDispatchError(NULL);
3197
        return NULL;
D
Daniel Veillard 已提交
3198
    }
3199

3200 3201
    conn = domain->conn;

3202
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
3203
        virLibConnError(VIR_ERR_OPERATION_DENIED,
3204 3205 3206 3207
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

3208 3209
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

3210
    if (conn->driver->domainGetXMLDesc) {
3211
        char *ret;
3212
        ret = conn->driver->domainGetXMLDesc(domain, flags);
3213 3214 3215 3216
        if (!ret)
            goto error;
        return ret;
    }
3217

3218
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3219 3220

error:
3221
    virDispatchError(domain->conn);
3222
    return NULL;
3223
}
3224

3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243
/**
 * 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)
{
3244
    VIR_DEBUG("conn=%p, format=%s config=%s flags=%u", conn, nativeFormat, nativeConfig, flags);
3245 3246 3247 3248

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3249
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3250
        virDispatchError(NULL);
3251
        return NULL;
3252 3253 3254
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
3255
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3256
        goto error;
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269
    }

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

3270
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3271 3272

error:
3273
    virDispatchError(conn);
3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284
    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 已提交
3285
 * a native configuration file describing the domain.
3286 3287 3288 3289 3290 3291 3292 3293 3294 3295
 * 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)
{
3296
    VIR_DEBUG("conn=%p, format=%s xml=%s flags=%u", conn, nativeFormat, domainXml, flags);
3297 3298 3299 3300

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
3301
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3302
        virDispatchError(NULL);
3303
        return NULL;
3304
    }
3305 3306 3307 3308
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
3309 3310

    if (nativeFormat == NULL || domainXml == NULL) {
3311
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3312
        goto error;
3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
    }

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

3326
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3327 3328

error:
3329
    virDispatchError(conn);
3330 3331 3332 3333
    return NULL;
}


3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344
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;
3345 3346 3347 3348 3349 3350 3351
    int cookielen = 0, ret;
    virDomainInfo info;

    ret = virDomainGetInfo (domain, &info);
    if (ret == 0 && info.state == VIR_DOMAIN_PAUSED) {
        flags |= VIR_MIGRATE_PAUSED;
    }
3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369

    /* 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) {
3370
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414
                         _("domainMigratePrepare did not set uri"));
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare change URI? */

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

    /* Get the destination domain and return it or error.
     * 'domain' no longer actually exists at this point
     * (or so we hope), but we still use the object in memory
     * in order to get the name.
     */
    dname = dname ? dname : domain->name;
    if (dconn->driver->domainMigrateFinish)
        ddomain = dconn->driver->domainMigrateFinish
            (dconn, dname, cookie, cookielen, uri, flags);
    else
        ddomain = virDomainLookupByName (dconn, dname);

 done:
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

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;
3415
    virDomainInfo info;
3416
    virErrorPtr orig_err = NULL;
3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433

    /* 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.
     */
3434
    if (!domain->conn->driver->domainGetXMLDesc) {
3435
        virLibConnError(VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
3436
        virDispatchError(domain->conn);
3437 3438
        return NULL;
    }
3439 3440 3441
    dom_xml = domain->conn->driver->domainGetXMLDesc(domain,
                                                     VIR_DOMAIN_XML_SECURE |
                                                     VIR_DOMAIN_XML_UPDATE_CPU);
3442 3443 3444
    if (!dom_xml)
        return NULL;

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

3450 3451 3452 3453 3454 3455 3456 3457
    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) {
3458
        virLibConnError(VIR_ERR_INTERNAL_ERROR,
3459
                         _("domainMigratePrepare2 did not set uri"));
3460
        virDispatchError(domain->conn);
3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471
        goto done;
    }
    if (uri_out)
        uri = uri_out; /* Did domainMigratePrepare2 change URI? */

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

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

3476 3477 3478 3479 3480 3481 3482 3483 3484
    /* 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:
3485 3486 3487 3488
    if (orig_err) {
        virSetError(orig_err);
        virFreeError(orig_err);
    }
3489 3490 3491 3492 3493
    VIR_FREE (uri_out);
    VIR_FREE (cookie);
    return ddomain;
}

3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509

 /*
  * 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)
{
3510 3511
    xmlURIPtr tempuri = NULL;

3512
    if (!domain->conn->driver->domainMigratePerform) {
3513
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3514
        virDispatchError(domain->conn);
3515 3516 3517
        return -1;
    }

3518 3519
    tempuri = xmlParseURI(uri);
    if (!tempuri) {
3520
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3521 3522 3523 3524 3525
        virDispatchError(domain->conn);
        return -1;
    }

    if (!tempuri->server || STRPREFIX(tempuri->server, "localhost")) {
3526
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3527 3528 3529 3530 3531 3532
        virDispatchError(domain->conn);
        xmlFreeURI(tempuri);
        return -1;
    }
    xmlFreeURI(tempuri);

3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545
    /* 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 已提交
3546
/*
3547
 * This is a variation on v1 & 2  migration
C
Chris Lalancette 已提交
3548
 *
3549 3550 3551 3552 3553 3554
 * 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 已提交
3555
 */
3556 3557 3558 3559 3560 3561 3562 3563
static int
virDomainMigrateDirect (virDomainPtr domain,
                        unsigned long flags,
                        const char *dname,
                        const char *uri,
                        unsigned long bandwidth)
{
    if (!domain->conn->driver->domainMigratePerform) {
3564
        virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3565
        virDispatchError(domain->conn);
3566 3567 3568
        return -1;
    }

C
Chris Lalancette 已提交
3569 3570 3571
    /* Perform the migration.  The driver isn't supposed to return
     * until the migration is complete.
     */
3572 3573 3574 3575 3576 3577 3578
    return domain->conn->driver->domainMigratePerform(domain,
                                                      NULL, /* cookie */
                                                      0,    /* cookielen */
                                                      uri,
                                                      flags,
                                                      dname,
                                                      bandwidth);
C
Chris Lalancette 已提交
3579 3580
}

3581

3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594
/**
 * 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:
3595 3596 3597
 *   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 已提交
3598 3599 3600 3601
 *   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.
3602
 *   VIR_MIGRATE_PAUSED    Leave the domain suspended on the remote side.
3603 3604 3605 3606 3607
 *
 * 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.
3608 3609 3610 3611 3612 3613
 *
 * 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.
 *
3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624
 * 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.
 *
3625
 * In either case it is typically only necessary to specify a
3626 3627
 * URI if the destination host has multiple interfaces and a
 * specific interface is required to transmit migration data.
3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655
 *
 * 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;
3656 3657 3658

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

3660 3661
    virResetLastError();

3662
    /* First checkout the source */
3663
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3664
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3665
        virDispatchError(NULL);
3666 3667
        return NULL;
    }
3668
    if (domain->conn->flags & VIR_CONNECT_RO) {
3669
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3670
        goto error;
3671 3672
    }

3673 3674
    /* Now checkout the destination */
    if (!VIR_IS_CONNECT(dconn)) {
3675
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3676 3677 3678 3679
        goto error;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, deliberately report error against source object, not dest */
3680
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3681 3682 3683
        goto error;
    }

3684 3685 3686 3687 3688 3689
    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);
3690
                if (!dstURI)
3691 3692
                    return NULL;
            }
3693

3694 3695 3696 3697 3698
            if (virDomainMigratePeer2Peer(domain, flags, dname, uri ? uri : dstURI, bandwidth) < 0) {
                VIR_FREE(dstURI);
                goto error;
            }
            VIR_FREE(dstURI);
C
Chris Lalancette 已提交
3699

3700 3701 3702
            ddomain = virDomainLookupByName (dconn, dname ? dname : domain->name);
        } else {
            /* This driver does not support peer to peer migration */
3703
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3704 3705
            goto error;
        }
3706
    } else {
3707
        if (flags & VIR_MIGRATE_TUNNELLED) {
3708
            virLibConnError(VIR_ERR_OPERATION_INVALID,
3709 3710 3711 3712
                            _("cannot perform tunnelled migration without using peer2peer flag"));
            goto error;
        }

C
Chris Lalancette 已提交
3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724
        /* 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 {
3725
            /* This driver does not support any migration method */
3726
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
3727 3728
            goto error;
        }
3729 3730
    }

3731 3732
    if (ddomain == NULL)
        goto error;
D
Daniel Veillard 已提交
3733

3734
    return ddomain;
3735 3736

error:
3737
    virDispatchError(domain->conn);
3738
    return NULL;
3739 3740
}

3741 3742 3743 3744 3745 3746 3747 3748 3749 3750

/**
 * 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 已提交
3751
 * host given by duri.
3752 3753 3754 3755 3756
 *
 * 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
3757 3758 3759 3760
 *   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.
3761
 *
3762 3763 3764 3765 3766 3767 3768 3769 3770 3771
 * 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
3772
 * must be a valid libvirt connection URI, by which the source
D
Dan Kenigsberg 已提交
3773
 * libvirt driver can connect to the destination libvirt.
3774
 *
3775 3776 3777 3778 3779 3780 3781
 * 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.
3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805
 *
 * 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)
{
3806 3807
    VIR_DOMAIN_DEBUG(domain, "duri=%p, flags=%lu, dname=%s, bandwidth=%lu",
                     NULLSTR(duri), flags, NULLSTR(dname), bandwidth);
3808 3809 3810 3811 3812

    virResetLastError();

    /* First checkout the source */
    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3813
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3814
        virDispatchError(NULL);
3815 3816 3817
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
3818
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3819 3820 3821 3822
        goto error;
    }

    if (duri == NULL) {
3823
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
        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 */
3834
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3835 3836 3837 3838 3839 3840 3841 3842 3843
            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 */
3844
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3845 3846 3847 3848 3849 3850 3851
            goto error;
        }
    }

    return 0;

error:
3852
    virDispatchError(domain->conn);
3853 3854 3855 3856
    return -1;
}


D
Daniel Veillard 已提交
3857 3858
/*
 * Not for public use.  This function is part of the internal
3859 3860 3861
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3862
virDomainMigratePrepare (virConnectPtr dconn,
3863 3864 3865 3866 3867 3868 3869
                         char **cookie,
                         int *cookielen,
                         const char *uri_in,
                         char **uri_out,
                         unsigned long flags,
                         const char *dname,
                         unsigned long bandwidth)
3870
{
J
John Levon 已提交
3871 3872 3873
    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);
3874

3875 3876
    virResetLastError();

3877
    if (!VIR_IS_CONNECT (dconn)) {
3878
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3879
        virDispatchError(NULL);
3880 3881 3882
        return -1;
    }

3883
    if (dconn->flags & VIR_CONNECT_RO) {
3884
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3885
        goto error;
3886 3887
    }

3888 3889 3890 3891 3892 3893 3894 3895 3896
    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;
    }
3897

3898
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3899 3900

error:
3901
    virDispatchError(dconn);
3902 3903 3904
    return -1;
}

D
Daniel Veillard 已提交
3905 3906
/*
 * Not for public use.  This function is part of the internal
3907 3908 3909
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3910
virDomainMigratePerform (virDomainPtr domain,
3911 3912 3913 3914 3915 3916 3917 3918
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
3919 3920 3921 3922

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

3924 3925 3926
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3927
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3928
        virDispatchError(NULL);
3929 3930 3931 3932
        return -1;
    }
    conn = domain->conn;

3933
    if (domain->conn->flags & VIR_CONNECT_RO) {
3934
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3935
        goto error;
3936 3937
    }

3938 3939 3940 3941 3942 3943 3944 3945 3946
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3947

3948
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3949 3950

error:
3951
    virDispatchError(domain->conn);
3952 3953 3954
    return -1;
}

D
Daniel Veillard 已提交
3955 3956
/*
 * Not for public use.  This function is part of the internal
3957 3958 3959
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3960
virDomainMigrateFinish (virConnectPtr dconn,
3961 3962 3963 3964 3965 3966
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3967 3968 3969
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3970

3971 3972
    virResetLastError();

3973
    if (!VIR_IS_CONNECT (dconn)) {
3974
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
3975
        virDispatchError(NULL);
3976 3977 3978
        return NULL;
    }

3979
    if (dconn->flags & VIR_CONNECT_RO) {
3980
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3981
        goto error;
3982 3983
    }

3984 3985 3986 3987 3988 3989 3990 3991 3992
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3993

3994
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
3995 3996

error:
3997
    virDispatchError(dconn);
3998
    return NULL;
D
Daniel Veillard 已提交
3999 4000 4001
}


D
Daniel Veillard 已提交
4002 4003
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
4004 4005 4006
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
4007 4008 4009 4010 4011 4012 4013 4014 4015
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 已提交
4016
{
J
John Levon 已提交
4017 4018 4019 4020
    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 已提交
4021

4022 4023
    virResetLastError();

D
Daniel Veillard 已提交
4024
    if (!VIR_IS_CONNECT (dconn)) {
4025
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4026
        virDispatchError(NULL);
D
Daniel Veillard 已提交
4027 4028 4029
        return -1;
    }

4030
    if (dconn->flags & VIR_CONNECT_RO) {
4031
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4032
        goto error;
4033 4034
    }

4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
    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 已提交
4045

4046
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4047 4048

error:
4049
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4050 4051 4052
    return -1;
}

D
Daniel Veillard 已提交
4053 4054
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
4055 4056 4057
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
4058 4059 4060 4061 4062 4063 4064
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
4065
{
J
John Levon 已提交
4066 4067 4068
    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 已提交
4069

4070 4071
    virResetLastError();

D
Daniel Veillard 已提交
4072
    if (!VIR_IS_CONNECT (dconn)) {
4073
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4074
        virDispatchError(NULL);
D
Daniel Veillard 已提交
4075 4076 4077
        return NULL;
    }

4078
    if (dconn->flags & VIR_CONNECT_RO) {
4079
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4080
        goto error;
4081 4082
    }

4083 4084 4085 4086 4087 4088 4089 4090 4091 4092
    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 已提交
4093

4094
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4095 4096

error:
4097
    virDispatchError(dconn);
D
Daniel Veillard 已提交
4098
    return NULL;
4099 4100 4101
}


C
Chris Lalancette 已提交
4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114
/*
 * 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)

{
4115 4116
    VIR_DEBUG("conn=%p, stream=%p, flags=%lu, dname=%s, "
              "bandwidth=%lu, dom_xml=%s", conn, st, flags,
C
Chris Lalancette 已提交
4117 4118 4119 4120 4121
              NULLSTR(dname), bandwidth, dom_xml);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
4122
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4123
        virDispatchError(NULL);
C
Chris Lalancette 已提交
4124 4125 4126 4127
        return -1;
    }

    if (conn->flags & VIR_CONNECT_RO) {
4128
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
4129 4130 4131 4132
        goto error;
    }

    if (conn != st->conn) {
4133
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
4134 4135 4136 4137
        goto error;
    }

    if (conn->driver->domainMigratePrepareTunnel) {
4138
        int rv = conn->driver->domainMigratePrepareTunnel(conn, st,
C
Chris Lalancette 已提交
4139 4140 4141 4142 4143 4144 4145
                                                          flags, dname,
                                                          bandwidth, dom_xml);
        if (rv < 0)
            goto error;
        return rv;
    }

4146
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
4147 4148

error:
4149
    virDispatchError(conn);
C
Chris Lalancette 已提交
4150 4151 4152 4153
    return -1;
}


4154 4155 4156 4157
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
4158
 *
4159 4160 4161 4162 4163
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
4164 4165
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
4166
    VIR_DEBUG("conn=%p, info=%p", conn, info);
4167

4168 4169
    virResetLastError();

4170
    if (!VIR_IS_CONNECT(conn)) {
4171
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4172
        virDispatchError(NULL);
4173
        return -1;
4174 4175
    }
    if (info == NULL) {
4176
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4177
        goto error;
4178 4179
    }

4180 4181 4182 4183 4184 4185 4186
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
4187

4188
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4189 4190

error:
4191
    virDispatchError(conn);
4192
    return -1;
4193
}
4194

4195 4196 4197 4198 4199 4200
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
4201 4202
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
4203 4204 4205 4206 4207
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
4208
    VIR_DEBUG("conn=%p", conn);
4209

4210 4211
    virResetLastError();

4212
    if (!VIR_IS_CONNECT (conn)) {
4213
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4214
        virDispatchError(NULL);
4215 4216 4217
        return NULL;
    }

4218 4219 4220 4221 4222
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
4223
        VIR_DEBUG("conn=%p ret=%s", conn, ret);
4224 4225
        return ret;
    }
4226

4227
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4228 4229

error:
4230
    virDispatchError(conn);
4231 4232 4233
    return NULL;
}

4234 4235 4236
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
4237
 *
D
Daniel Veillard 已提交
4238
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
4239 4240
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
4241
 *
D
Daniel Veillard 已提交
4242
 * Returns the available free memory in bytes or 0 in case of error
4243 4244 4245 4246
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
4247
    VIR_DEBUG("conn=%p", conn);
4248

4249 4250
    virResetLastError();

4251
    if (!VIR_IS_CONNECT (conn)) {
4252
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4253
        virDispatchError(NULL);
4254 4255 4256
        return 0;
    }

4257 4258 4259 4260 4261 4262 4263
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
4264

4265
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4266 4267

error:
4268
    virDispatchError(conn);
4269 4270 4271
    return 0;
}

4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285
/**
 * 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;
4286 4287

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

4289 4290
    virResetLastError();

4291
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4292
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4293
        virDispatchError(NULL);
4294 4295 4296 4297 4298 4299
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
4300 4301
        if (!schedtype)
            goto error;
4302 4303 4304
        return schedtype;
    }

4305
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4306 4307

error:
4308
    virDispatchError(domain->conn);
4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328
    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,
4329
                                virSchedParameterPtr params, int *nparams)
4330 4331
{
    virConnectPtr conn;
4332 4333

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

4335 4336
    virResetLastError();

4337
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4338
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4339
        virDispatchError(NULL);
4340 4341 4342 4343
        return -1;
    }
    conn = domain->conn;

4344 4345 4346 4347 4348 4349 4350
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4351

4352
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4353 4354

error:
4355
    virDispatchError(domain->conn);
4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371
    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
4372
virDomainSetSchedulerParameters(virDomainPtr domain,
4373
                                virSchedParameterPtr params, int nparams)
4374 4375
{
    virConnectPtr conn;
4376 4377

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

4379 4380
    virResetLastError();

4381
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4382
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4383
        virDispatchError(NULL);
4384 4385
        return -1;
    }
4386
    if (domain->conn->flags & VIR_CONNECT_RO) {
4387
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4388
        goto error;
4389
    }
4390 4391
    conn = domain->conn;

4392 4393 4394 4395 4396 4397 4398
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
4399

4400
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4401 4402

error:
4403
    virDispatchError(domain->conn);
4404 4405 4406 4407
    return -1;
}


4408
/**
4409
 * virDomainBlockStats:
4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436
 * @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 };
4437 4438

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

4440 4441
    virResetLastError();

4442
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4443
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4444
        virDispatchError(NULL);
4445 4446
        return -1;
    }
4447
    if (!path || !stats || size > sizeof stats2) {
4448
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4449 4450
        goto error;
    }
4451 4452 4453 4454
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
4455
            goto error;
4456 4457 4458 4459 4460

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

4461
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4462 4463

error:
4464
    virDispatchError(dom->conn);
4465 4466 4467 4468
    return -1;
}

/**
4469
 * virDomainInterfaceStats:
4470 4471 4472 4473 4474 4475 4476 4477 4478 4479
 * @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 已提交
4480
 * Domains may have more than one network interface.  To get stats for
4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495
 * 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 };
4496 4497 4498

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

4500 4501
    virResetLastError();

4502
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4503
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4504
        virDispatchError(NULL);
4505 4506
        return -1;
    }
4507
    if (!path || !stats || size > sizeof stats2) {
4508
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4509 4510
        goto error;
    }
4511 4512 4513 4514
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
4515
            goto error;
4516 4517 4518 4519 4520

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

4521
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4522 4523

error:
4524
    virDispatchError(dom->conn);
4525 4526 4527
    return -1;
}

4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
/**
 * 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;
4563 4564

    VIR_DOMAIN_DEBUG(dom, "stats=%p, nr_stats=%u", stats, nr_stats);
4565 4566 4567 4568

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4569
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4570
        virDispatchError(NULL);
4571 4572
        return -1;
    }
4573 4574 4575 4576 4577 4578
    if (flags != 0) {
        virLibDomainError(VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
        goto error;
    }

4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592
    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;
    }

4593
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4594 4595

error:
4596
    virDispatchError(dom->conn);
4597 4598 4599
    return -1;
}

R
Richard W.M. Jones 已提交
4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632
/**
 * 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 已提交
4633 4634 4635 4636
 * 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 已提交
4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647
 * 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;
4648 4649 4650

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

4652 4653
    virResetLastError();

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

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

R
Richard W.M. Jones 已提交
4666
    if (!path) {
4667
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
4668
                           _("path is NULL"));
4669
        goto error;
R
Richard W.M. Jones 已提交
4670 4671 4672
    }

    if (flags != 0) {
4673
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
4674
                           _("flags must be zero"));
4675
        goto error;
R
Richard W.M. Jones 已提交
4676 4677 4678 4679
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
4680
        virLibDomainError(VIR_ERR_INVALID_ARG,
R
Richard W.M. Jones 已提交
4681
                           _("buffer is NULL"));
4682
        goto error;
R
Richard W.M. Jones 已提交
4683 4684
    }

4685 4686 4687 4688 4689 4690 4691 4692
    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 已提交
4693

4694
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4695 4696

error:
4697
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4698 4699
    return -1;
}
4700

R
Richard W.M. Jones 已提交
4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739
/**
 * 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;
4740 4741 4742

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

4744 4745
    virResetLastError();

R
Richard W.M. Jones 已提交
4746
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
4747
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4748
        virDispatchError(NULL);
R
Richard W.M. Jones 已提交
4749 4750 4751 4752
        return -1;
    }
    conn = dom->conn;

4753
    if (dom->conn->flags & VIR_CONNECT_RO) {
4754
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4755
        goto error;
4756 4757
    }

4758
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
4759 4760 4761 4762 4763 4764
     * 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.
     *
4765
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
4766 4767 4768
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
4769 4770 4771
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
4772 4773 4774 4775 4776 4777 4778 4779
     * 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.
     */
4780 4781

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
4782
        virLibDomainError(VIR_ERR_INVALID_ARG,
4783
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
4784
        goto error;
R
Richard W.M. Jones 已提交
4785 4786 4787 4788
    }

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

4794 4795 4796 4797 4798 4799 4800 4801
    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 已提交
4802

4803
    virLibDomainError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4804 4805

error:
4806
    virDispatchError(dom->conn);
R
Richard W.M. Jones 已提交
4807 4808 4809
    return -1;
}

4810

4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825
/**
 * 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;
4826 4827

    VIR_DOMAIN_DEBUG(domain, "info=%p flags=%u", info, flags);
4828 4829 4830 4831

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4832
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4833
        virDispatchError(NULL);
4834
        return -1;
4835 4836
    }
    if (info == NULL) {
4837
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852
        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;
    }

4853
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4854 4855 4856 4857 4858 4859 4860

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


4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871
/************************************************************************
 *									*
 *		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
 *
4872 4873
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
4874 4875
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
4876 4877 4878 4879 4880
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
4881
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
4882

4883 4884
    virResetLastError();

4885
    if (!VIR_IS_CONNECT(conn)) {
4886
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4887
        virDispatchError(NULL);
4888
        return NULL;
4889
    }
4890
    if (conn->flags & VIR_CONNECT_RO) {
4891
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4892
        goto error;
4893
    }
4894
    if (xml == NULL) {
4895
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
4896
        goto error;
4897 4898
    }

4899 4900 4901 4902 4903 4904 4905
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4906

4907
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4908 4909

error:
4910
    virDispatchError(conn);
4911
    return NULL;
4912 4913 4914 4915 4916 4917
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
4918
 * Undefine a domain but does not stop it if it is running
4919 4920 4921 4922 4923
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
4924
    virConnectPtr conn;
4925 4926

    VIR_DOMAIN_DEBUG0(domain);
4927

4928 4929
    virResetLastError();

4930
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4931
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4932
        virDispatchError(NULL);
4933
        return -1;
4934
    }
4935 4936
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4937
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4938
        goto error;
4939 4940
    }

4941 4942 4943 4944 4945 4946 4947
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4948

4949
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4950 4951

error:
4952
    virDispatchError(domain->conn);
4953
    return -1;
4954 4955 4956 4957 4958 4959
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
4960
 * Provides the number of defined but inactive domains.
4961 4962 4963 4964 4965 4966
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
4967
    VIR_DEBUG("conn=%p", conn);
4968

4969 4970
    virResetLastError();

4971
    if (!VIR_IS_CONNECT(conn)) {
4972
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
4973
        virDispatchError(NULL);
4974
        return -1;
4975 4976
    }

4977 4978 4979 4980 4981 4982 4983
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4984

4985
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
4986 4987

error:
4988
    virDispatchError(conn);
4989
    return -1;
4990 4991 4992 4993 4994 4995 4996 4997
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4998 4999
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
5000
 *
5001 5002 5003
 * Returns the number of names provided in the array or -1 in case of error
 */
int
5004
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
5005
                             int maxnames) {
5006
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
5007

5008 5009
    virResetLastError();

5010
    if (!VIR_IS_CONNECT(conn)) {
5011
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5012
        virDispatchError(NULL);
5013
        return -1;
5014 5015
    }

5016
    if ((names == NULL) || (maxnames < 0)) {
5017
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5018
        goto error;
5019 5020
    }

5021 5022 5023 5024 5025 5026 5027
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5028

5029
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5030 5031

error:
5032
    virDispatchError(conn);
5033
    return -1;
5034 5035 5036 5037 5038 5039
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
5040
 * Launch a defined domain. If the call succeeds the domain moves from the
5041 5042 5043 5044 5045 5046
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
5047
    virConnectPtr conn;
5048 5049

    VIR_DOMAIN_DEBUG0(domain);
5050

5051 5052
    virResetLastError();

5053
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5054
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5055
        virDispatchError(NULL);
5056
        return -1;
5057
    }
5058 5059
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5060
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5061
        goto error;
5062
    }
5063

5064 5065 5066 5067 5068 5069 5070
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5071

5072
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5073 5074

error:
5075
    virDispatchError(domain->conn);
5076
    return -1;
5077 5078
}

5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091
/**
 * 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;
5092 5093

    VIR_DOMAIN_DEBUG(domain, "flags=%d", flags);
5094 5095 5096 5097

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5098
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5099
        virDispatchError(NULL);
5100
        return -1;
5101 5102 5103
    }
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
5104
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115
        goto error;
    }

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

5116
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5117 5118 5119 5120 5121 5122

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

5123 5124 5125
/**
 * virDomainGetAutostart:
 * @domain: a domain object
5126
 * @autostart: the value returned
5127
 *
5128
 * Provides a boolean value indicating whether the domain
5129 5130 5131 5132 5133 5134 5135
 * 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,
5136 5137 5138
                      int *autostart)
{
    virConnectPtr conn;
5139 5140

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

5142 5143 5144
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5145
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5146
        virDispatchError(NULL);
5147
        return -1;
5148 5149
    }
    if (!autostart) {
5150
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5151
        goto error;
5152 5153
    }

5154 5155
    conn = domain->conn;

5156 5157 5158 5159 5160 5161 5162
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5163

5164
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5165 5166

error:
5167
    virDispatchError(domain->conn);
5168
    return -1;
5169 5170 5171 5172 5173
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
5174
 * @autostart: whether the domain should be automatically started 0 or 1
5175 5176 5177 5178 5179 5180 5181 5182
 *
 * 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,
5183 5184 5185
                      int autostart)
{
    virConnectPtr conn;
5186 5187

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

5189 5190 5191
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5192
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5193
        virDispatchError(NULL);
5194
        return -1;
5195 5196
    }

5197 5198
    conn = domain->conn;

5199
    if (domain->conn->flags & VIR_CONNECT_RO) {
5200
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5201
        goto error;
5202 5203
    }

5204 5205 5206 5207 5208 5209 5210
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5211

5212
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5213 5214

error:
5215
    virDispatchError(domain->conn);
5216
    return -1;
5217 5218
}

5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262
/**
 * virDomainInjectNMI:
 * @domain: pointer to domain object, or NULL for Domain0
 * @flags:  the flags for controlling behavior, pass 0 for now
 *
 * Send NMI to the guest
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int virDomainInjectNMI(virDomainPtr domain, unsigned int flags)
{
    virConnectPtr conn;
    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    conn = domain->conn;

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

    virLibConnError (VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

5263 5264 5265 5266 5267 5268 5269 5270
/**
 * 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.
5271
 * This function requires privileged access to the hypervisor.
5272
 *
5273
 * This command only changes the runtime configuration of the domain,
E
Eric Blake 已提交
5274 5275 5276
 * so can only be called on an active domain.  It is hypervisor-dependent
 * whether it also affects persistent configuration; for more control,
 * use virDomainSetVcpusFlags().
5277
 *
5278 5279 5280 5281 5282 5283
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
5284
    virConnectPtr conn;
5285 5286

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

5288 5289
    virResetLastError();

5290
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5291
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5292
        virDispatchError(NULL);
5293
        return -1;
5294
    }
5295
    if (domain->conn->flags & VIR_CONNECT_RO) {
5296
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5297
        goto error;
5298
    }
5299

5300
    if (nvcpus < 1) {
5301
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5302
        goto error;
5303
    }
5304
    conn = domain->conn;
5305

5306 5307 5308 5309 5310 5311 5312
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
5313

5314
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5315 5316

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

E
Eric Blake 已提交
5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351
/**
 * 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;
5352 5353

    VIR_DOMAIN_DEBUG(domain, "nvcpus=%u, flags=%u", nvcpus, flags);
E
Eric Blake 已提交
5354 5355 5356 5357

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5358
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
5359
        virDispatchError(NULL);
5360
        return -1;
E
Eric Blake 已提交
5361 5362
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5363
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
E
Eric Blake 已提交
5364 5365 5366 5367 5368 5369
        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) {
5370
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382
        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;
    }

5383
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415

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;
5416 5417

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
E
Eric Blake 已提交
5418 5419 5420 5421

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5422
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
E
Eric Blake 已提交
5423
        virDispatchError(NULL);
5424
        return -1;
E
Eric Blake 已提交
5425 5426 5427 5428
    }

    /* Exactly one of these two flags should be set.  */
    if (!(flags & VIR_DOMAIN_VCPU_LIVE) == !(flags & VIR_DOMAIN_VCPU_CONFIG)) {
5429
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
E
Eric Blake 已提交
5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441
        goto error;
    }
    conn = domain->conn;

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

5442
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
E
Eric Blake 已提交
5443 5444 5445 5446 5447 5448

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

5449 5450 5451 5452 5453
/**
 * 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 已提交
5454 5455 5456
 *      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.
5457 5458 5459 5460
 * @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.
5461
 *
5462
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
5463
 * This function requires privileged access to the hypervisor.
5464
 *
5465 5466 5467
 * This command only changes the runtime configuration of the domain,
 * so can only be called on an active domain.
 *
5468 5469 5470 5471 5472 5473
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
5474
    virConnectPtr conn;
5475 5476 5477

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

5479 5480
    virResetLastError();

5481
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5482
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5483
        virDispatchError(NULL);
5484
        return -1;
5485
    }
5486
    if (domain->conn->flags & VIR_CONNECT_RO) {
5487
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5488
        goto error;
5489
    }
5490

5491
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
5492
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5493
       goto error;
5494
    }
5495

5496 5497
    conn = domain->conn;

5498 5499 5500 5501 5502 5503 5504
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5505

5506
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5507 5508

error:
5509
    virDispatchError(domain->conn);
5510
    return -1;
5511 5512 5513 5514 5515 5516 5517
}

/**
 * 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 已提交
5518
 * @cpumaps: pointer to a bit map of real CPUs for all vcpus of this
5519
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
5520
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
5521 5522 5523 5524 5525 5526 5527
 *	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...).
5528
 *	Must be zero when cpumaps is NULL and positive when it is non-NULL.
5529
 *
5530
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
5531
 * and also in cpumaps if this pointer isn't NULL.
5532 5533 5534 5535 5536
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
5537
                  unsigned char *cpumaps, int maplen)
5538
{
5539
    virConnectPtr conn;
5540 5541 5542

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

5544 5545
    virResetLastError();

5546
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5547
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5548
        virDispatchError(NULL);
5549
        return -1;
5550 5551
    }
    if ((info == NULL) || (maxinfo < 1)) {
5552
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5553
        goto error;
5554
    }
5555 5556 5557 5558 5559

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

5564 5565
    conn = domain->conn;

5566 5567 5568 5569 5570 5571 5572 5573
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
5574

5575
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5576 5577

error:
5578
    virDispatchError(domain->conn);
5579
    return -1;
5580
}
5581

5582 5583 5584
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
5585
 *
5586 5587
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
E
Eric Blake 已提交
5588
 * the same as virConnectGetMaxVcpus(). If the guest is running
5589
 * this will reflect the maximum number of virtual CPUs the
E
Eric Blake 已提交
5590
 * guest was booted with.  For more details, see virDomainGetVcpusFlags().
5591 5592 5593 5594
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
5595 5596
virDomainGetMaxVcpus(virDomainPtr domain)
{
5597
    virConnectPtr conn;
5598 5599

    VIR_DOMAIN_DEBUG0(domain);
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 5609 5610
    }

    conn = domain->conn;

5611 5612 5613 5614 5615 5616 5617
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
5618

5619
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5620 5621

error:
5622
    virDispatchError(domain->conn);
5623
    return -1;
5624 5625
}

5626 5627 5628 5629 5630
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
5631 5632 5633
 * 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.
5634
 *
5635
 * Returns 0 in case of success, -1 in case of failure
5636 5637 5638 5639 5640 5641
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

5642 5643
    VIR_DOMAIN_DEBUG(domain, "seclabel=%p", seclabel);

5644
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5645
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5646
        virDispatchError(NULL);
5647 5648 5649 5650
        return -1;
    }

    if (seclabel == NULL) {
5651
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5652
        goto error;
5653 5654 5655 5656
    }

    conn = domain->conn;

5657 5658 5659 5660 5661 5662 5663 5664
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

5665
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5666

5667
error:
5668
    virDispatchError(domain->conn);
5669
    return -1;
5670 5671 5672 5673 5674 5675 5676
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
5677 5678 5679
 * 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.
5680
 *
5681
 * Returns 0 in case of success, -1 in case of failure
5682 5683 5684 5685
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
5686
    VIR_DEBUG("conn=%p secmodel=%p", conn, secmodel);
5687

5688
    if (!VIR_IS_CONNECT(conn)) {
5689
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
5690
        virDispatchError(NULL);
5691 5692 5693 5694
        return -1;
    }

    if (secmodel == NULL) {
5695
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
5696 5697 5698 5699 5700 5701 5702 5703 5704
        goto error;
    }

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

5707
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5708

5709
error:
5710
    virDispatchError(conn);
5711
    return -1;
5712
}
5713

5714 5715 5716 5717
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5718
 *
5719 5720
 * Create a virtual device attachment to backend.  This function,
 * having hotplug semantics, is only allowed on an active domain.
5721
 *
5722 5723 5724 5725
 * 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.
 *
5726 5727 5728
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5729
virDomainAttachDevice(virDomainPtr domain, const char *xml)
5730 5731
{
    virConnectPtr conn;
5732 5733

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

5735 5736
    virResetLastError();

5737
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5738
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
5739
        virDispatchError(NULL);
5740
        return -1;
5741 5742
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5743
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5744
        goto error;
5745 5746 5747
    }
    conn = domain->conn;

5748
    if (conn->driver->domainAttachDevice) {
J
Jim Fehlig 已提交
5749 5750 5751 5752 5753 5754 5755
       int ret;
       ret = conn->driver->domainAttachDevice (domain, xml);
       if (ret < 0)
          goto error;
       return ret;
    }

5756
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780

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.
 *
5781 5782 5783 5784
 * 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 已提交
5785 5786 5787 5788 5789 5790 5791
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainAttachDeviceFlags(virDomainPtr domain,
                           const char *xml, unsigned int flags)
{
    virConnectPtr conn;
5792 5793

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
5794 5795 5796 5797

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5798
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
5799
        virDispatchError(NULL);
5800
        return -1;
J
Jim Fehlig 已提交
5801 5802
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5803
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
5804 5805 5806 5807 5808
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainAttachDeviceFlags) {
5809
        int ret;
J
Jim Fehlig 已提交
5810
        ret = conn->driver->domainAttachDeviceFlags(domain, xml, flags);
5811 5812 5813 5814
        if (ret < 0)
            goto error;
        return ret;
    }
5815

5816
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5817 5818

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

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
5827
 *
5828 5829
 * Destroy a virtual device attachment to backend.  This function,
 * having hot-unplug semantics, is only allowed on an active domain.
5830 5831 5832 5833
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
5834
virDomainDetachDevice(virDomainPtr domain, const char *xml)
5835 5836
{
    virConnectPtr conn;
5837 5838

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

5840 5841
    virResetLastError();

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

5853 5854 5855
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
J
Jim Fehlig 已提交
5856 5857 5858 5859 5860
         if (ret < 0)
             goto error;
         return ret;
     }

5861
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jim Fehlig 已提交
5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892

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;
5893 5894

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
J
Jim Fehlig 已提交
5895 5896 5897 5898

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5899
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
5900
        virDispatchError(NULL);
5901
        return -1;
J
Jim Fehlig 已提交
5902 5903
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5904
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
J
Jim Fehlig 已提交
5905 5906 5907 5908 5909 5910 5911
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainDetachDeviceFlags) {
        int ret;
        ret = conn->driver->domainDetachDeviceFlags(domain, xml, flags);
5912 5913 5914 5915 5916
        if (ret < 0)
            goto error;
        return ret;
    }

5917
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952

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;
5953 5954

    VIR_DOMAIN_DEBUG(domain, "xml=%s, flags=%d", xml, flags);
5955 5956 5957 5958

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
5959
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
W
Wen Congyang 已提交
5960
        virDispatchError(NULL);
5961
        return -1;
5962 5963
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
5964
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5965 5966 5967 5968 5969 5970 5971
        goto error;
    }
    conn = domain->conn;

    if (conn->driver->domainUpdateDeviceFlags) {
        int ret;
        ret = conn->driver->domainUpdateDeviceFlags(domain, xml, flags);
5972 5973 5974 5975
        if (ret < 0)
            goto error;
        return ret;
    }
5976

5977
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
5978 5979

error:
5980
    virDispatchError(domain->conn);
5981
    return -1;
5982
}
5983

5984 5985 5986 5987 5988 5989 5990 5991 5992 5993
/**
 * 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
5994
 * with the amount of free memory in bytes for each cell requested,
5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005
 * 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)
{
6006
    VIR_DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
6007 6008
          conn, freeMems, startCell, maxCells);

6009 6010
    virResetLastError();

6011
    if (!VIR_IS_CONNECT(conn)) {
6012
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6013
        virDispatchError(NULL);
6014
        return -1;
6015 6016
    }

D
Daniel Veillard 已提交
6017
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
6018
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6019
        goto error;
6020 6021
    }

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

6030
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6031 6032

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

6037 6038 6039 6040
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
6041
 * Provides the connection pointer associated with a network.  The
6042 6043 6044
 * reference counter on the connection is not increased by this
 * call.
 *
6045 6046 6047 6048
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
6049 6050 6051 6052 6053
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
6054
    VIR_DEBUG("net=%p", net);
6055

6056 6057 6058
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
6059
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6060
        virDispatchError(NULL);
6061 6062 6063 6064 6065
        return NULL;
    }
    return net->conn;
}

6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076
/**
 * 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)
{
6077
    VIR_DEBUG("conn=%p", conn);
6078

6079 6080
    virResetLastError();

6081
    if (!VIR_IS_CONNECT(conn)) {
6082
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6083
        virDispatchError(NULL);
6084
        return -1;
6085 6086
    }

6087 6088 6089 6090 6091 6092 6093
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6094

6095
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6096 6097

error:
6098
    virDispatchError(conn);
6099
    return -1;
6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112
}

/**
 * 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
6113
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
6114
{
6115
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6116

6117 6118
    virResetLastError();

6119
    if (!VIR_IS_CONNECT(conn)) {
6120
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6121
        virDispatchError(NULL);
6122
        return -1;
6123 6124
    }

6125
    if ((names == NULL) || (maxnames < 0)) {
6126
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6127
        goto error;
6128 6129
    }

6130 6131 6132 6133 6134 6135 6136
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6137

6138
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6139 6140

error:
6141
    virDispatchError(conn);
6142
    return -1;
6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155
}

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

6158 6159
    virResetLastError();

6160
    if (!VIR_IS_CONNECT(conn)) {
6161
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6162
        virDispatchError(NULL);
6163
        return -1;
6164 6165
    }

6166 6167 6168 6169 6170 6171 6172
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6173

6174
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6175 6176

error:
6177
    virDispatchError(conn);
6178
    return -1;
6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191
}

/**
 * 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
6192
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
6193 6194
                              int maxnames)
{
6195
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
6196

6197 6198
    virResetLastError();

6199
    if (!VIR_IS_CONNECT(conn)) {
6200
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6201
        virDispatchError(NULL);
6202
        return -1;
6203 6204
    }

6205
    if ((names == NULL) || (maxnames < 0)) {
6206
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6207
        goto error;
6208 6209
    }

6210 6211 6212 6213 6214 6215 6216 6217
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6218

6219
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6220 6221

error:
6222
    virDispatchError(conn);
6223
    return -1;
6224 6225 6226 6227 6228 6229 6230 6231 6232
}

/**
 * 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.
 *
6233 6234
 * 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.
6235 6236 6237 6238
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
6239
    VIR_DEBUG("conn=%p, name=%s", conn, name);
6240

6241 6242
    virResetLastError();

6243
    if (!VIR_IS_CONNECT(conn)) {
6244
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6245
        virDispatchError(NULL);
6246
        return NULL;
6247 6248
    }
    if (name == NULL) {
6249
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6250
        goto  error;
6251 6252
    }

6253 6254 6255 6256 6257 6258 6259
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6260

6261
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6262 6263

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

/**
 * 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.
 *
6275 6276
 * 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.
6277 6278 6279 6280
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
6281 6282 6283
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    virUUIDFormat(uuid, uuidstr);

6284
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuidstr);
6285

6286 6287
    virResetLastError();

6288
    if (!VIR_IS_CONNECT(conn)) {
6289
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6290
        virDispatchError(NULL);
6291
        return NULL;
6292 6293
    }
    if (uuid == NULL) {
6294
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6295
        goto error;
6296 6297
    }

6298 6299 6300 6301 6302 6303 6304
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6305

6306
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6307 6308

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

/**
 * 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.
 *
6320 6321
 * 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.
6322 6323 6324 6325 6326
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
6327
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
6328

6329 6330
    virResetLastError();

6331
    if (!VIR_IS_CONNECT(conn)) {
6332
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6333
        virDispatchError(NULL);
6334
        return NULL;
6335 6336
    }
    if (uuidstr == NULL) {
6337
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6338
        goto error;
6339 6340
    }

6341
    if (virUUIDParse(uuidstr, uuid) < 0) {
6342
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6343
        goto error;
6344 6345 6346
    }

    return virNetworkLookupByUUID(conn, &uuid[0]);
6347 6348

error:
6349
    virDispatchError(conn);
6350
    return NULL;
6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365
}

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

6368 6369
    virResetLastError();

6370
    if (!VIR_IS_CONNECT(conn)) {
6371
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6372
        virDispatchError(NULL);
6373
        return NULL;
6374 6375
    }
    if (xmlDesc == NULL) {
6376
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6377
        goto error;
6378 6379
    }
    if (conn->flags & VIR_CONNECT_RO) {
6380
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6381
        goto error;
6382 6383
    }

6384 6385 6386 6387 6388 6389 6390
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
6391

6392
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6393 6394

error:
6395
    virDispatchError(conn);
6396
    return NULL;
6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408
}

/**
 * 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
6409 6410
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
6411
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
6412

6413 6414
    virResetLastError();

6415
    if (!VIR_IS_CONNECT(conn)) {
6416
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6417
        virDispatchError(NULL);
6418
        return NULL;
6419 6420
    }
    if (conn->flags & VIR_CONNECT_RO) {
6421
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6422
        goto error;
6423 6424
    }
    if (xml == NULL) {
6425
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6426
        goto error;
6427 6428
    }

6429 6430 6431 6432 6433 6434 6435
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
6436

6437
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6438 6439

error:
6440
    virDispatchError(conn);
6441
    return NULL;
6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454
}

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

6457 6458
    virResetLastError();

6459
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6460
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6461
        virDispatchError(NULL);
6462
        return -1;
6463 6464 6465
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6466
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6467
        goto error;
6468 6469
    }

6470 6471 6472 6473 6474 6475 6476
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6477

6478
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6479 6480

error:
6481
    virDispatchError(network->conn);
6482
    return -1;
6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494
}

/**
 * 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
6495 6496
virNetworkCreate(virNetworkPtr network)
{
6497
    virConnectPtr conn;
6498
    VIR_DEBUG("network=%p", network);
6499

6500 6501
    virResetLastError();

6502
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6503
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6504
        virDispatchError(NULL);
6505
        return -1;
6506 6507 6508
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6509
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6510
        goto error;
6511 6512
    }

6513 6514 6515 6516 6517 6518 6519
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6520

6521
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6522 6523

error:
6524
    virDispatchError(network->conn);
6525
    return -1;
6526 6527 6528 6529 6530 6531 6532
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
6533 6534 6535
 * 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
6536 6537 6538 6539 6540 6541 6542
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
6543
    VIR_DEBUG("network=%p", network);
6544

6545 6546
    virResetLastError();

6547
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6548
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6549
        virDispatchError(NULL);
6550
        return -1;
6551 6552 6553 6554
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
6555
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6556
        goto error;
6557 6558
    }

6559 6560 6561 6562 6563 6564 6565
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
6566

6567
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6568 6569

error:
6570
    virDispatchError(network->conn);
6571
    return -1;
6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585
}

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

6588 6589 6590
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6591
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6592
        virDispatchError(NULL);
6593
        return -1;
6594
    }
6595 6596
    if (virUnrefNetwork(network) < 0) {
        virDispatchError(NULL);
6597
        return -1;
6598
    }
6599
    return 0;
6600 6601
}

6602 6603
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
6604
 * @network: the network to hold a reference on
6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615
 *
 * 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 已提交
6616 6617
 *
 * Returns 0 in case of success, -1 in case of failure.
6618 6619 6620 6621 6622
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
6623
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6624
        virDispatchError(NULL);
6625
        return -1;
6626 6627
    }
    virMutexLock(&network->conn->lock);
6628
    VIR_DEBUG("network=%p refs=%d", network, network->refs);
6629 6630 6631 6632 6633
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645
/**
 * 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)
{
6646
    VIR_DEBUG("network=%p", network);
6647

6648 6649
    virResetLastError();

6650
    if (!VIR_IS_NETWORK(network)) {
6651
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6652
        virDispatchError(NULL);
6653
        return NULL;
6654
    }
6655
    return network->name;
6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669
}

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

6672 6673
    virResetLastError();

6674
    if (!VIR_IS_NETWORK(network)) {
6675
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6676
        virDispatchError(NULL);
6677
        return -1;
6678 6679
    }
    if (uuid == NULL) {
6680
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6681
        goto error;
6682 6683 6684 6685
    }

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

6686
    return 0;
6687 6688

error:
6689
    virDispatchError(network->conn);
6690
    return -1;
6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706
}

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

6709 6710
    virResetLastError();

6711
    if (!VIR_IS_NETWORK(network)) {
6712
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6713
        virDispatchError(NULL);
6714
        return -1;
6715 6716
    }
    if (buf == NULL) {
6717
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6718
        goto error;
6719 6720 6721
    }

    if (virNetworkGetUUID(network, &uuid[0]))
6722
        goto error;
6723

6724
    virUUIDFormat(uuid, buf);
6725
    return 0;
6726 6727

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

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
L
Laine Stump 已提交
6735
 * @flags: an OR'ed set of extraction flags, not used yet
6736 6737 6738 6739 6740 6741 6742 6743 6744 6745
 *
 * 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)
{
6746
    virConnectPtr conn;
6747
    VIR_DEBUG("network=%p, flags=%d", network, flags);
6748

6749 6750 6751
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6752
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6753
        virDispatchError(NULL);
6754
        return NULL;
6755 6756
    }
    if (flags != 0) {
6757
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6758
        goto error;
6759 6760
    }

6761 6762
    conn = network->conn;

6763
    if (conn->networkDriver && conn->networkDriver->networkGetXMLDesc) {
6764
        char *ret;
6765
        ret = conn->networkDriver->networkGetXMLDesc(network, flags);
6766 6767 6768 6769
        if (!ret)
            goto error;
        return ret;
    }
6770

6771
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6772 6773

error:
6774
    virDispatchError(network->conn);
6775
    return NULL;
6776
}
6777 6778 6779 6780 6781

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
6782
 * Provides a bridge interface name to which a domain may connect
6783 6784 6785 6786 6787 6788 6789 6790
 * 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)
{
6791
    virConnectPtr conn;
6792
    VIR_DEBUG("network=%p", network);
6793

6794 6795 6796
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6797
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6798
        virDispatchError(NULL);
6799
        return NULL;
6800 6801
    }

6802 6803
    conn = network->conn;

6804 6805 6806 6807 6808 6809 6810
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
6811

6812
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6813 6814

error:
6815
    virDispatchError(network->conn);
6816
    return NULL;
6817
}
6818 6819 6820 6821

/**
 * virNetworkGetAutostart:
 * @network: a network object
6822
 * @autostart: the value returned
6823
 *
6824
 * Provides a boolean value indicating whether the network
6825 6826 6827 6828 6829 6830 6831
 * 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,
6832 6833 6834
                       int *autostart)
{
    virConnectPtr conn;
6835
    VIR_DEBUG("network=%p, autostart=%p", network, autostart);
6836

6837 6838 6839
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6840
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6841
        virDispatchError(NULL);
6842
        return -1;
6843 6844
    }
    if (!autostart) {
6845
        virLibNetworkError(VIR_ERR_INVALID_ARG, __FUNCTION__);
6846
        goto error;
6847 6848
    }

6849 6850
    conn = network->conn;

6851 6852 6853 6854 6855 6856 6857
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6858

6859
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6860 6861

error:
6862
    virDispatchError(network->conn);
6863
    return -1;
6864 6865 6866 6867 6868
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
6869
 * @autostart: whether the network should be automatically started 0 or 1
6870 6871 6872 6873 6874 6875 6876 6877
 *
 * 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,
6878 6879 6880
                       int autostart)
{
    virConnectPtr conn;
6881
    VIR_DEBUG("network=%p, autostart=%d", network, autostart);
6882

6883 6884 6885
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
6886
        virLibNetworkError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
6887
        virDispatchError(NULL);
6888
        return -1;
6889 6890
    }

6891
    if (network->conn->flags & VIR_CONNECT_RO) {
6892
        virLibNetworkError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6893
        goto error;
6894 6895
    }

6896 6897
    conn = network->conn;

6898 6899 6900 6901 6902 6903 6904
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6905

6906
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
6907 6908

error:
6909
    virDispatchError(network->conn);
6910
    return -1;
6911
}
6912

D
Daniel Veillard 已提交
6913 6914
/**
 * virInterfaceGetConnect:
L
Laine Stump 已提交
6915
 * @iface: pointer to an interface
D
Daniel Veillard 已提交
6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927
 *
 * 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
6928
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
6929
{
6930
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6931 6932 6933

    virResetLastError();

6934
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
6935
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
6936
        virDispatchError(NULL);
D
Daniel Veillard 已提交
6937 6938
        return NULL;
    }
6939
    return iface->conn;
D
Daniel Veillard 已提交
6940 6941 6942 6943 6944 6945
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
6946
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
6947
 *
6948
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
6949 6950 6951 6952
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
6953
    VIR_DEBUG("conn=%p", conn);
D
Daniel Veillard 已提交
6954 6955 6956 6957

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6958
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6959
        virDispatchError(NULL);
6960
        return -1;
D
Daniel Veillard 已提交
6961 6962 6963 6964 6965 6966 6967 6968 6969 6970
    }

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

6971
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
6972 6973

error:
6974
    virDispatchError(conn);
D
Daniel Veillard 已提交
6975 6976 6977 6978 6979 6980 6981 6982 6983
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
6984 6985
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
6986 6987 6988 6989 6990 6991
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
6992
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
D
Daniel Veillard 已提交
6993 6994 6995 6996

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
6997
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
6998
        virDispatchError(NULL);
6999
        return -1;
D
Daniel Veillard 已提交
7000 7001 7002
    }

    if ((names == NULL) || (maxnames < 0)) {
7003
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014
        goto error;
    }

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

7015
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7016 7017

error:
7018
    virDispatchError(conn);
D
Daniel Veillard 已提交
7019 7020 7021
    return -1;
}

7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032
/**
 * 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)
{
7033
    VIR_DEBUG("conn=%p", conn);
7034 7035 7036 7037

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7038
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7039
        virDispatchError(NULL);
7040
        return -1;
7041 7042 7043 7044 7045 7046 7047 7048 7049 7050
    }

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

7051
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7052 7053

error:
7054
    virDispatchError(conn);
7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073
    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)
{
7074
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7075 7076 7077 7078

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7079
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7080
        virDispatchError(NULL);
7081
        return -1;
7082 7083 7084
    }

    if ((names == NULL) || (maxnames < 0)) {
7085
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096
        goto error;
    }

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

7097
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7098 7099

error:
7100
    virDispatchError(conn);
7101 7102 7103
    return -1;
}

D
Daniel Veillard 已提交
7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116
/**
 * 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)
{
7117
    VIR_DEBUG("conn=%p, name=%s", conn, name);
D
Daniel Veillard 已提交
7118 7119 7120 7121

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7122
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7123
        virDispatchError(NULL);
7124
        return NULL;
D
Daniel Veillard 已提交
7125 7126
    }
    if (name == NULL) {
7127
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138
        goto  error;
    }

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

7139
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7140 7141

error:
7142
    virDispatchError(conn);
D
Daniel Veillard 已提交
7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158
    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)
{
7159
    VIR_DEBUG("conn=%p, macstr=%s", conn, macstr);
D
Daniel Veillard 已提交
7160 7161 7162 7163

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7164
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7165
        virDispatchError(NULL);
7166
        return NULL;
D
Daniel Veillard 已提交
7167 7168
    }
    if (macstr == NULL) {
7169
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180
        goto  error;
    }

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

7181
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7182 7183

error:
7184
    virDispatchError(conn);
D
Daniel Veillard 已提交
7185 7186 7187 7188 7189
    return NULL;
}

/**
 * virInterfaceGetName:
L
Laine Stump 已提交
7190
 * @iface: an interface object
D
Daniel Veillard 已提交
7191 7192 7193 7194 7195 7196 7197
 *
 * 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 *
7198
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
7199
{
7200
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7201 7202 7203

    virResetLastError();

7204
    if (!VIR_IS_INTERFACE(iface)) {
7205
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7206
        virDispatchError(NULL);
7207
        return NULL;
D
Daniel Veillard 已提交
7208
    }
7209
    return iface->name;
D
Daniel Veillard 已提交
7210 7211 7212 7213
}

/**
 * virInterfaceGetMACString:
L
Laine Stump 已提交
7214
 * @iface: an interface object
D
Daniel Veillard 已提交
7215
 *
L
Laine Stump 已提交
7216
 * Get the MAC for an interface as string. For more information about
D
Daniel Veillard 已提交
7217 7218 7219 7220 7221 7222 7223
 * 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 *
7224
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
7225
{
7226
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7227 7228 7229

    virResetLastError();

7230
    if (!VIR_IS_INTERFACE(iface)) {
7231
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7232
        virDispatchError(NULL);
7233
        return NULL;
D
Daniel Veillard 已提交
7234
    }
7235
    return iface->mac;
D
Daniel Veillard 已提交
7236 7237 7238 7239
}

/**
 * virInterfaceGetXMLDesc:
L
Laine Stump 已提交
7240
 * @iface: an interface object
7241 7242 7243 7244 7245
 * @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 已提交
7246
 *
7247 7248 7249 7250 7251
 * 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 已提交
7252 7253 7254 7255 7256
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
7257
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7258 7259
{
    virConnectPtr conn;
7260
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7261 7262 7263

    virResetLastError();

7264
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7265
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7266
        virDispatchError(NULL);
7267
        return NULL;
D
Daniel Veillard 已提交
7268
    }
7269
    if ((flags & ~VIR_INTERFACE_XML_INACTIVE) != 0) {
7270
        virLibInterfaceError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7271 7272 7273
        goto error;
    }

7274
    conn = iface->conn;
D
Daniel Veillard 已提交
7275 7276 7277

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
7278
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
7279 7280 7281 7282 7283
        if (!ret)
            goto error;
        return ret;
    }

7284
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7285 7286

error:
7287
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303
    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)
{
7304
    VIR_DEBUG("conn=%p, xml=%s, flags=%d", conn, xml, flags);
D
Daniel Veillard 已提交
7305 7306 7307 7308

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
7309
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7310
        virDispatchError(NULL);
7311
        return NULL;
D
Daniel Veillard 已提交
7312 7313
    }
    if (conn->flags & VIR_CONNECT_RO) {
7314
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7315 7316 7317
        goto error;
    }
    if (xml == NULL) {
7318
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329
        goto error;
    }

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

7330
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7331 7332

error:
7333
    virDispatchError(conn);
D
Daniel Veillard 已提交
7334 7335 7336 7337 7338
    return NULL;
}

/**
 * virInterfaceUndefine:
7339
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
7340 7341 7342 7343 7344 7345 7346
 *
 * 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
7347
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
7348
    virConnectPtr conn;
7349
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7350 7351 7352

    virResetLastError();

7353
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7354
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7355
        virDispatchError(NULL);
7356
        return -1;
D
Daniel Veillard 已提交
7357
    }
7358
    conn = iface->conn;
D
Daniel Veillard 已提交
7359
    if (conn->flags & VIR_CONNECT_RO) {
7360
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7361 7362 7363 7364 7365
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
7366
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
7367 7368 7369 7370 7371
        if (ret < 0)
            goto error;
        return ret;
    }

7372
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7373 7374

error:
7375
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7376 7377 7378 7379 7380
    return -1;
}

/**
 * virInterfaceCreate:
7381
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
7382 7383 7384 7385 7386 7387 7388
 * @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
7389
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7390 7391
{
    virConnectPtr conn;
7392
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7393 7394 7395

    virResetLastError();

7396
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7397
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7398
        virDispatchError(NULL);
7399
        return -1;
D
Daniel Veillard 已提交
7400
    }
7401
    conn = iface->conn;
D
Daniel Veillard 已提交
7402
    if (conn->flags & VIR_CONNECT_RO) {
7403
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7404 7405 7406 7407 7408
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
7409
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
7410 7411 7412 7413 7414
        if (ret < 0)
            goto error;
        return ret;
    }

7415
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7416 7417

error:
7418
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7419 7420 7421 7422 7423
    return -1;
}

/**
 * virInterfaceDestroy:
7424
 * @iface: an interface object
D
Daniel Veillard 已提交
7425 7426 7427 7428 7429 7430 7431 7432 7433
 * @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
7434
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
7435 7436
{
    virConnectPtr conn;
7437
    VIR_DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
7438 7439 7440

    virResetLastError();

7441
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7442
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7443
        virDispatchError(NULL);
7444
        return -1;
D
Daniel Veillard 已提交
7445 7446
    }

7447
    conn = iface->conn;
D
Daniel Veillard 已提交
7448
    if (conn->flags & VIR_CONNECT_RO) {
7449
        virLibInterfaceError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
7450 7451 7452 7453 7454
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
7455
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
7456 7457 7458 7459 7460
        if (ret < 0)
            goto error;
        return ret;
    }

7461
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
D
Daniel Veillard 已提交
7462 7463

error:
7464
    virDispatchError(iface->conn);
D
Daniel Veillard 已提交
7465 7466 7467 7468 7469
    return -1;
}

/**
 * virInterfaceRef:
7470
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
7471 7472 7473 7474 7475 7476 7477 7478 7479
 *
 * 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 已提交
7480
 * it. ie, each new thread using an interface would increment
D
Daniel Veillard 已提交
7481 7482 7483 7484 7485
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
7486
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
7487
{
7488
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
7489
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7490
        virDispatchError(NULL);
7491
        return -1;
D
Daniel Veillard 已提交
7492
    }
7493
    virMutexLock(&iface->conn->lock);
7494
    VIR_DEBUG("iface=%p refs=%d", iface, iface->refs);
7495 7496
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
7497 7498 7499 7500 7501
    return 0;
}

/**
 * virInterfaceFree:
L
Laine Stump 已提交
7502
 * @iface: an interface object
D
Daniel Veillard 已提交
7503 7504 7505 7506 7507 7508 7509
 *
 * 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
7510
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
7511
{
7512
    VIR_DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
7513 7514 7515

    virResetLastError();

7516
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
7517
        virLibInterfaceError(VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
7518
        virDispatchError(NULL);
7519
        return -1;
D
Daniel Veillard 已提交
7520
    }
7521 7522
    if (virUnrefInterface(iface) < 0) {
        virDispatchError(NULL);
7523
        return -1;
7524
    }
7525
    return 0;
D
Daniel Veillard 已提交
7526 7527
}

7528 7529 7530

/**
 * virStoragePoolGetConnect:
7531
 * @pool: pointer to a pool
7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545
 *
 * 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)
{
7546
    VIR_DEBUG("pool=%p", pool);
7547

7548 7549 7550
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
7551
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7552
        virDispatchError(NULL);
7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568
        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)
{
7569
    VIR_DEBUG("conn=%p", conn);
7570

7571 7572
    virResetLastError();

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

7579 7580 7581 7582 7583 7584 7585
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7586

7587
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7588 7589

error:
7590
    virDispatchError(conn);
7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610
    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)
{
7611
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7612

7613 7614
    virResetLastError();

7615
    if (!VIR_IS_CONNECT(conn)) {
7616
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7617
        virDispatchError(NULL);
7618
        return -1;
7619 7620 7621
    }

    if ((names == NULL) || (maxnames < 0)) {
7622
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7623
        goto error;
7624 7625
    }

7626 7627 7628 7629 7630 7631 7632
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7633

7634
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7635

7636
error:
7637
    virDispatchError(conn);
7638
    return -1;
7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652
}


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

7655 7656
    virResetLastError();

7657
    if (!VIR_IS_CONNECT(conn)) {
7658
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7659
        virDispatchError(NULL);
7660
        return -1;
7661 7662
    }

7663 7664 7665 7666 7667 7668 7669
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
7670

7671
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7672 7673

error:
7674
    virDispatchError(conn);
7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695
    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)
{
7696
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
7697

7698 7699
    virResetLastError();

7700
    if (!VIR_IS_CONNECT(conn)) {
7701
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7702
        virDispatchError(NULL);
7703
        return -1;
7704 7705 7706
    }

    if ((names == NULL) || (maxnames < 0)) {
7707
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7708
        goto error;
7709 7710
    }

7711 7712 7713 7714 7715 7716 7717
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7718

7719
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7720 7721

error:
7722
    virDispatchError(conn);
7723 7724 7725 7726
    return -1;
}


7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753
/**
 * 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)
{
7754
    VIR_DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);
7755 7756 7757

    virResetLastError();

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

7768
    if (conn->flags & VIR_CONNECT_RO) {
7769
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7770
        goto error;
7771 7772
    }

7773 7774 7775 7776 7777 7778 7779
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
7780

7781
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7782 7783

error:
7784
    virDispatchError(conn);
7785 7786 7787 7788
    return NULL;
}


7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801
/**
 * 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)
{
7802
    VIR_DEBUG("conn=%p, name=%s", conn, name);
7803

7804 7805
    virResetLastError();

7806
    if (!VIR_IS_CONNECT(conn)) {
7807
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7808
        virDispatchError(NULL);
7809
        return NULL;
7810 7811
    }
    if (name == NULL) {
7812
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7813
        goto error;
7814 7815
    }

7816 7817 7818 7819 7820 7821 7822
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7823

7824
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7825 7826

error:
7827
    virDispatchError(conn);
7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844
    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)
{
7845
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
7846

7847 7848
    virResetLastError();

7849
    if (!VIR_IS_CONNECT(conn)) {
7850
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7851
        virDispatchError(NULL);
7852
        return NULL;
7853 7854
    }
    if (uuid == NULL) {
7855
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7856
        goto error;
7857 7858
    }

7859 7860 7861 7862 7863 7864 7865
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
7866

7867
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7868

7869
error:
7870
    virDispatchError(conn);
7871
    return NULL;
7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885
}


/**
 * 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,
7886
                                 const char *uuidstr)
7887 7888
{
    unsigned char uuid[VIR_UUID_BUFLEN];
7889
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
7890

7891 7892
    virResetLastError();

7893
    if (!VIR_IS_CONNECT(conn)) {
7894
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7895
        virDispatchError(NULL);
7896
        return NULL;
7897 7898
    }
    if (uuidstr == NULL) {
7899
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7900
        goto error;
7901 7902 7903
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
7904
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7905
        goto error;
7906 7907 7908
    }

    return virStoragePoolLookupByUUID(conn, uuid);
7909 7910

error:
7911
    virDispatchError(conn);
7912
    return NULL;
7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926
}


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

7929 7930 7931
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
7932
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7933
        virDispatchError(NULL);
7934
        return NULL;
7935 7936
    }

7937 7938 7939 7940 7941 7942 7943
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
7944

7945
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7946

7947
error:
7948
    virDispatchError(vol->conn);
7949
    return NULL;
7950 7951 7952 7953 7954 7955
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
7956
 * @flags: future flags, use 0 for now
7957 7958
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
7959
 * pool is not persistent, so its definition will disappear
7960 7961 7962 7963 7964 7965 7966 7967 7968
 * 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)
{
7969
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
7970

7971 7972
    virResetLastError();

7973
    if (!VIR_IS_CONNECT(conn)) {
7974
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
7975
        virDispatchError(NULL);
7976
        return NULL;
7977 7978
    }
    if (xmlDesc == NULL) {
7979
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
7980
        goto error;
7981 7982
    }
    if (conn->flags & VIR_CONNECT_RO) {
7983
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7984
        goto error;
7985 7986
    }

7987 7988 7989 7990 7991 7992 7993
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7994

7995
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
7996 7997

error:
7998
    virDispatchError(conn);
7999 8000 8001 8002 8003 8004 8005
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
8006
 * @flags: future flags, use 0 for now
8007 8008
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
8009
 * pool is persistent, until explicitly undefined.
8010 8011 8012 8013 8014 8015 8016 8017
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
8018
    VIR_DEBUG("conn=%p, xml=%s", conn, xml);
8019

8020 8021
    virResetLastError();

8022
    if (!VIR_IS_CONNECT(conn)) {
8023
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8024
        virDispatchError(NULL);
8025
        return NULL;
8026 8027
    }
    if (conn->flags & VIR_CONNECT_RO) {
8028
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8029
        goto error;
8030 8031
    }
    if (xml == NULL) {
8032
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8033
        goto error;
8034 8035
    }

8036 8037 8038 8039 8040 8041 8042
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
8043

8044
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8045

8046
error:
8047
    virDispatchError(conn);
8048
    return NULL;
8049 8050 8051 8052 8053
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
8054
 * @flags: future flags, use 0 for now
8055 8056 8057 8058 8059 8060 8061 8062 8063 8064
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
8065
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8066

8067 8068
    virResetLastError();

8069
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8070
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8071
        virDispatchError(NULL);
8072
        return -1;
8073 8074 8075
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8076
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8077
        goto error;
8078 8079
    }

8080 8081 8082 8083 8084 8085 8086
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8087

8088
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8089

8090
error:
8091
    virDispatchError(pool->conn);
8092
    return -1;
8093 8094 8095 8096 8097 8098 8099 8100 8101
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
8102
 * Returns 0 on success, -1 on failure
8103 8104 8105 8106 8107
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
8108
    VIR_DEBUG("pool=%p", pool);
8109

8110 8111
    virResetLastError();

8112
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8113
        virLibStoragePoolError(VIR_ERR_INVALID_NETWORK, __FUNCTION__);
8114
        virDispatchError(NULL);
8115
        return -1;
8116 8117 8118
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8119
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8120
        goto error;
8121 8122
    }

8123 8124 8125 8126 8127 8128 8129
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8130

8131
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8132

8133
error:
8134
    virDispatchError(pool->conn);
8135
    return -1;
8136 8137 8138 8139 8140 8141
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
8142
 * @flags: future flags, use 0 for now
8143 8144 8145 8146 8147 8148 8149 8150 8151 8152
 *
 * 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;
8153
    VIR_DEBUG("pool=%p", pool);
8154

8155 8156
    virResetLastError();

8157
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8158
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8159
        virDispatchError(NULL);
8160
        return -1;
8161 8162 8163
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8164
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8165
        goto error;
8166 8167
    }

8168 8169 8170 8171 8172 8173 8174
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8175

8176
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8177

8178
error:
8179
    virDispatchError(pool->conn);
8180
    return -1;
8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199
}


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

8202 8203
    virResetLastError();

8204
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8205
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8206
        virDispatchError(NULL);
8207
        return -1;
8208 8209 8210 8211
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8212
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8213
        goto error;
8214 8215
    }

8216 8217 8218 8219 8220 8221 8222
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8223

8224
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8225 8226

error:
8227
    virDispatchError(pool->conn);
8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246
    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;
8247
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8248

8249 8250
    virResetLastError();

8251
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8252
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8253
        virDispatchError(NULL);
8254
        return -1;
8255 8256 8257 8258
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8259
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8260
        goto error;
8261 8262
    }

8263 8264 8265 8266 8267 8268 8269
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8270

8271
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8272 8273

error:
8274
    virDispatchError(pool->conn);
8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290
    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)
{
8291
    VIR_DEBUG("pool=%p", pool);
8292

8293 8294 8295
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8296
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8297
        virDispatchError(NULL);
8298
        return -1;
8299
    }
8300 8301
    if (virUnrefStoragePool(pool) < 0) {
        virDispatchError(NULL);
8302
        return -1;
8303
    }
8304
    return 0;
8305 8306 8307 8308

}


8309 8310
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
8311
 * @pool: the pool to hold a reference on
8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322
 *
 * 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 已提交
8323 8324
 *
 * Returns 0 in case of success, -1 in case of failure.
8325 8326 8327 8328 8329
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
8330
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8331
        virDispatchError(NULL);
8332
        return -1;
8333 8334
    }
    virMutexLock(&pool->conn->lock);
8335
    VIR_DEBUG("pool=%p refs=%d", pool, pool->refs);
8336 8337 8338 8339 8340
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

8341 8342 8343 8344 8345 8346 8347 8348 8349
/**
 * 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
 *
8350
 * Returns 0 if the volume list was refreshed, -1 on failure
8351 8352 8353 8354 8355 8356
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
8357
    VIR_DEBUG("pool=%p flags=%u", pool, flags);
8358

8359 8360
    virResetLastError();

8361
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8362
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8363
        virDispatchError(NULL);
8364
        return -1;
8365 8366 8367 8368
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
8369
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8370
        goto error;
8371 8372
    }

8373 8374 8375 8376 8377 8378 8379
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8380

8381
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8382 8383

error:
8384
    virDispatchError(pool->conn);
8385 8386 8387 8388 8389 8390 8391 8392 8393 8394
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
8395
 * Returns the name of the pool, or NULL on error
8396 8397 8398 8399
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
8400
    VIR_DEBUG("pool=%p", pool);
8401

8402 8403
    virResetLastError();

8404
    if (!VIR_IS_STORAGE_POOL(pool)) {
8405
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8406
        virDispatchError(NULL);
8407
        return NULL;
8408
    }
8409
    return pool->name;
8410 8411 8412 8413 8414 8415 8416 8417 8418 8419
}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
8420
 * Returns 0 on success, or -1 on error;
8421 8422 8423 8424 8425
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
8426
    VIR_DEBUG("pool=%p, uuid=%p", pool, uuid);
8427

8428 8429
    virResetLastError();

8430
    if (!VIR_IS_STORAGE_POOL(pool)) {
8431
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8432
        virDispatchError(NULL);
8433
        return -1;
8434 8435
    }
    if (uuid == NULL) {
8436
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8437
        goto error;
8438 8439 8440 8441
    }

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

8442
    return 0;
8443

8444
error:
8445
    virDispatchError(pool->conn);
8446
    return -1;
8447 8448 8449 8450 8451 8452 8453 8454 8455
}

/**
 * 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
 *
8456
 * Returns 0 on success, or -1 on error;
8457 8458 8459 8460 8461 8462
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
8463
    VIR_DEBUG("pool=%p, buf=%p", pool, buf);
8464

8465 8466
    virResetLastError();

8467
    if (!VIR_IS_STORAGE_POOL(pool)) {
8468
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8469
        virDispatchError(NULL);
8470
        return -1;
8471 8472
    }
    if (buf == NULL) {
8473
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8474
        goto error;
8475 8476 8477
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
8478
        goto error;
8479 8480

    virUUIDFormat(uuid, buf);
8481
    return 0;
8482

8483
error:
8484
    virDispatchError(pool->conn);
8485
    return -1;
8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496
}


/**
 * 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
 *
8497
 * Returns 0 on success, or -1 on failure.
8498 8499 8500 8501 8502 8503
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
8504
    VIR_DEBUG("pool=%p, info=%p", pool, info);
8505

8506 8507
    virResetLastError();

8508
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8509
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8510
        virDispatchError(NULL);
8511
        return -1;
8512 8513
    }
    if (info == NULL) {
8514
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8515
        goto error;
8516 8517 8518 8519 8520 8521
    }

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

    conn = pool->conn;

8522 8523 8524 8525 8526 8527 8528
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
8529

8530
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8531

8532
error:
8533
    virDispatchError(pool->conn);
8534
    return -1;
8535 8536 8537 8538 8539 8540
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
8541
 * @flags: flags for XML format options (set of virDomainXMLFlags)
8542 8543 8544 8545 8546
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
8547
 * Returns a XML document, or NULL on error
8548 8549 8550 8551 8552 8553
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
8554
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8555

8556 8557 8558
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8559
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8560
        virDispatchError(NULL);
8561
        return NULL;
8562 8563
    }
    if (flags != 0) {
8564
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8565
        goto error;
8566 8567 8568 8569
    }

    conn = pool->conn;

8570 8571 8572 8573 8574 8575 8576
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
8577

8578
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8579

8580
error:
8581
    virDispatchError(pool->conn);
8582
    return NULL;
8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593
}


/**
 * 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
 *
8594
 * Returns 0 on success, -1 on failure
8595 8596 8597 8598 8599 8600
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
8601
    VIR_DEBUG("pool=%p, autostart=%p", pool, autostart);
8602

8603 8604 8605
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8606
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8607
        virDispatchError(NULL);
8608
        return -1;
8609 8610
    }
    if (!autostart) {
8611
        virLibStoragePoolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8612
        goto error;
8613 8614 8615 8616
    }

    conn = pool->conn;

8617 8618 8619 8620 8621 8622 8623
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8624

8625
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8626 8627

error:
8628
    virDispatchError(pool->conn);
8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
8640
 * Returns 0 on success, -1 on failure
8641 8642 8643 8644 8645 8646
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
8647
    VIR_DEBUG("pool=%p, autostart=%d", pool, autostart);
8648

8649 8650 8651
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
8652
        virLibStoragePoolError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8653
        virDispatchError(NULL);
8654
        return -1;
8655 8656
    }

8657
    if (pool->conn->flags & VIR_CONNECT_RO) {
8658
        virLibStoragePoolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
8659
        goto error;
8660 8661
    }

8662 8663
    conn = pool->conn;

8664 8665 8666 8667 8668 8669 8670
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
8671

8672
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8673 8674

error:
8675
    virDispatchError(pool->conn);
8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690
    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)
{
8691
    VIR_DEBUG("pool=%p", pool);
8692

8693 8694
    virResetLastError();

8695
    if (!VIR_IS_STORAGE_POOL(pool)) {
8696
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8697
        virDispatchError(NULL);
8698
        return -1;
8699 8700
    }

8701 8702 8703 8704 8705 8706 8707
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
8708

8709
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8710 8711

error:
8712
    virDispatchError(pool->conn);
8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732
    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)
{
8733
    VIR_DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);
8734

8735 8736
    virResetLastError();

8737
    if (!VIR_IS_STORAGE_POOL(pool)) {
8738
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
8739
        virDispatchError(NULL);
8740
        return -1;
8741 8742 8743
    }

    if ((names == NULL) || (maxnames < 0)) {
8744
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8745
        goto error;
8746 8747
    }

8748 8749 8750 8751 8752 8753 8754
    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;
    }
8755

8756
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8757 8758

error:
8759
    virDispatchError(pool->conn);
8760 8761 8762 8763 8764 8765
    return -1;
}


/**
 * virStorageVolGetConnect:
8766
 * @vol: pointer to a pool
8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780
 *
 * 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)
{
8781
    VIR_DEBUG("vol=%p", vol);
8782

8783 8784
    virResetLastError();

8785
    if (!VIR_IS_STORAGE_VOL (vol)) {
8786
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8787
        virDispatchError(NULL);
8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801
        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
 *
8802
 * Returns a storage volume, or NULL if not found / error
8803 8804 8805 8806 8807
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
8808
    VIR_DEBUG("pool=%p, name=%s", pool, name);
8809

8810 8811
    virResetLastError();

8812
    if (!VIR_IS_STORAGE_POOL(pool)) {
8813
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8814
        virDispatchError(NULL);
8815
        return NULL;
8816 8817
    }
    if (name == NULL) {
8818
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8819
        goto error;
8820 8821
    }

8822 8823 8824 8825 8826 8827 8828
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
8829

8830
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8831 8832

error:
8833
    virDispatchError(pool->conn);
8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846
    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
 *
8847
 * Returns a storage volume, or NULL if not found / error
8848 8849 8850 8851 8852
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
8853
    VIR_DEBUG("conn=%p, key=%s", conn, key);
8854

8855 8856
    virResetLastError();

8857
    if (!VIR_IS_CONNECT(conn)) {
8858
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8859
        virDispatchError(NULL);
8860
        return NULL;
8861 8862
    }
    if (key == NULL) {
8863
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8864
        goto error;
8865 8866
    }

8867 8868 8869 8870 8871 8872 8873
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
8874

8875
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8876 8877

error:
8878
    virDispatchError(conn);
8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889
    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
 *
8890
 * Returns a storage volume, or NULL if not found / error
8891 8892 8893 8894 8895
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
8896
    VIR_DEBUG("conn=%p, path=%s", conn, path);
8897

8898 8899
    virResetLastError();

8900
    if (!VIR_IS_CONNECT(conn)) {
8901
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
8902
        virDispatchError(NULL);
8903
        return NULL;
8904 8905
    }
    if (path == NULL) {
8906
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
8907
        goto error;
8908 8909
    }

8910 8911 8912 8913 8914 8915 8916
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
8917

8918
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
8919 8920

error:
8921
    virDispatchError(conn);
8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
8933
 * Returns the volume name, or NULL on error
8934 8935 8936 8937
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
8938
    VIR_DEBUG("vol=%p", vol);
8939

8940 8941
    virResetLastError();

8942
    if (!VIR_IS_STORAGE_VOL(vol)) {
8943
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8944
        virDispatchError(NULL);
8945
        return NULL;
8946
    }
8947
    return vol->name;
8948 8949 8950 8951 8952 8953 8954 8955
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
8956
 * unique, so the same volume will have the same
8957 8958
 * key no matter what host it is accessed from
 *
8959
 * Returns the volume key, or NULL on error
8960 8961 8962 8963
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
8964
    VIR_DEBUG("vol=%p", vol);
8965

8966 8967
    virResetLastError();

8968
    if (!VIR_IS_STORAGE_VOL(vol)) {
8969
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
8970
        virDispatchError(NULL);
8971
        return NULL;
8972
    }
8973
    return vol->key;
8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986
}


/**
 * 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
 *
8987
 * Returns the storage volume, or NULL on error
8988 8989 8990 8991 8992 8993
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
8994
    VIR_DEBUG("pool=%p, flags=%u", pool, flags);
8995

8996 8997
    virResetLastError();

8998
    if (!VIR_IS_STORAGE_POOL(pool)) {
8999
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9000
        virDispatchError(NULL);
9001
        return NULL;
9002 9003 9004
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
9005
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9006
        goto error;
9007 9008
    }

9009 9010 9011 9012 9013 9014 9015
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
9016

9017
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9018 9019

error:
9020
    virDispatchError(pool->conn);
9021 9022 9023 9024
    return NULL;
}


9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036
/**
 * 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.
 *
9037
 * Returns the storage volume, or NULL on error
9038 9039 9040 9041 9042 9043 9044
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
9045
    VIR_DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);
9046 9047 9048 9049

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
9050
        virLibConnError(VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
9051
        virDispatchError(NULL);
9052
        return NULL;
9053 9054 9055
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
9056
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9057
        goto error;
9058 9059 9060 9061
    }

    if (pool->conn->flags & VIR_CONNECT_RO ||
        clonevol->conn->flags & VIR_CONNECT_RO) {
9062
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075
        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;
    }

9076
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9077 9078

error:
9079
    virDispatchError(pool->conn);
9080 9081 9082 9083
    return NULL;
}


9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223
/**
 * virStorageVolDownload:
 * @vol: pointer to volume to download from
 * @stream: stream to use as output
 * @offset: position in @vol to start reading from
 * @length: limit on amount of data to download
 * @flags: future flags (unused, pass 0)
 *
 * Download the content of the volume as a stream. If @length
 * is zero, then the remaining contents of the volume after
 * @offset will be downloaded.
 *
 * This call sets up an asynchronous stream; subsequent use of
 * stream APIs is necessary to transfer the actual data,
 * determine how much data is successfully transferred, and
 * detect any errors. The results will be unpredictable if
 * another active stream is writing to the storage volume.
 *
 * Returns 0, or -1 upon error.
 */
int
virStorageVolDownload(virStorageVolPtr vol,
                      virStreamPtr stream,
                      unsigned long long offset,
                      unsigned long long length,
                      unsigned int flags)
{
    VIR_DEBUG("vol=%p stream=%p offset=%llu length=%llu flags=%u",
              vol, stream, offset, length, flags);

    virResetLastError();

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return -1;
    }

    if (!VIR_IS_STREAM(stream)) {
        virLibConnError(VIR_ERR_INVALID_STREAM, __FUNCTION__);
        return -1;
    }

    if (vol->conn->flags & VIR_CONNECT_RO ||
        stream->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/**
 * virStorageVolUpload:
 * @vol: pointer to volume to upload
 * @stream: stream to use as input
 * @offset: position to start writing to
 * @length: limit on amount of data to upload
 * @flags: flags for creation (unused, pass 0)
 *
 * Upload new content to the volume from a stream. This call
 * will fail if @offset + @length exceeds the size of the
 * volume. Otherwise, if @length is non-zero, an error
 * will be raised if an attempt is made to upload greater
 * than @length bytes of data.
 *
 * This call sets up an asynchronous stream; subsequent use of
 * stream APIs is necessary to transfer the actual data,
 * determine how much data is successfully transferred, and
 * detect any errors. The results will be unpredictable if
 * another active stream is writing to the storage volume.
 *
 * Returns 0, or -1 upon error.
 */
int
virStorageVolUpload(virStorageVolPtr vol,
                    virStreamPtr stream,
                    unsigned long long offset,
                    unsigned long long length,
                    unsigned int flags)
{
    VIR_DEBUG("vol=%p stream=%p offset=%llu length=%llu flags=%u",
              vol, stream, offset, length, flags);

    virResetLastError();

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibConnError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return -1;
    }

    if (!VIR_IS_STREAM(stream)) {
        virLibConnError(VIR_ERR_INVALID_STREAM, __FUNCTION__);
        return -1;
    }

    if (vol->conn->flags & VIR_CONNECT_RO ||
        stream->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


9224 9225 9226
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
9227
 * @flags: future flags, use 0 for now
9228 9229 9230
 *
 * Delete the storage volume from the pool
 *
9231
 * Returns 0 on success, or -1 on error
9232 9233 9234 9235 9236 9237
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
9238
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
9239

9240 9241
    virResetLastError();

9242
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
9243
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9244
        virDispatchError(NULL);
9245
        return -1;
9246 9247 9248 9249
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9250
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9251
        goto error;
9252 9253
    }

9254 9255 9256 9257 9258 9259 9260
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9261

9262
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9263 9264

error:
9265
    virDispatchError(vol->conn);
9266 9267 9268 9269
    return -1;
}


9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288
/**
 * 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)) {
9289
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9290
        virDispatchError(NULL);
9291
        return -1;
9292 9293 9294 9295
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
9296
        virLibStorageVolError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308
        goto error;
    }

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

9309
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9310 9311 9312 9313 9314 9315 9316

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


9317 9318 9319 9320 9321
/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
9322
 * storage volume continues to exist.
9323
 *
9324
 * Returns 0 on success, or -1 on error
9325 9326 9327 9328
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
9329
    VIR_DEBUG("vol=%p", vol);
9330

9331 9332
    virResetLastError();

9333
    if (!VIR_IS_STORAGE_VOL(vol)) {
9334
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9335
        virDispatchError(NULL);
9336
        return -1;
9337
    }
9338 9339
    if (virUnrefStorageVol(vol) < 0) {
        virDispatchError(NULL);
9340
        return -1;
9341
    }
9342
    return 0;
9343 9344 9345
}


9346 9347
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
9348
 * @vol: the vol to hold a reference on
9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359
 *
 * 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 已提交
9360 9361
 *
 * Returns 0 in case of success, -1 in case of failure.
9362 9363 9364 9365 9366
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
9367
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9368
        virDispatchError(NULL);
9369
        return -1;
9370 9371
    }
    virMutexLock(&vol->conn->lock);
9372
    VIR_DEBUG("vol=%p refs=%d", vol, vol->refs);
9373 9374 9375 9376 9377
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

9378 9379 9380 9381 9382 9383 9384 9385
/**
 * 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
 *
9386
 * Returns 0 on success, or -1 on failure
9387 9388 9389 9390 9391 9392
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
9393
    VIR_DEBUG("vol=%p, info=%p", vol, info);
9394

9395 9396
    virResetLastError();

9397
    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
9398
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9399
        virDispatchError(NULL);
9400
        return -1;
9401 9402
    }
    if (info == NULL) {
9403
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9404
        goto error;
9405 9406 9407 9408 9409 9410
    }

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

    conn = vol->conn;

9411 9412 9413 9414 9415 9416 9417
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
9418

9419
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9420 9421

error:
9422
    virDispatchError(vol->conn);
9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434
    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
 *
9435
 * Returns the XML document, or NULL on error
9436 9437 9438 9439 9440 9441
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
9442
    VIR_DEBUG("vol=%p, flags=%u", vol, flags);
9443

9444 9445
    virResetLastError();

9446
    if (!VIR_IS_STORAGE_VOL(vol)) {
9447
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9448
        virDispatchError(NULL);
9449
        return NULL;
9450 9451
    }
    if (flags != 0) {
9452
        virLibStorageVolError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9453
        goto error;
9454 9455 9456 9457
    }

    conn = vol->conn;

9458 9459 9460 9461 9462 9463 9464
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
9465

9466
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9467

9468
error:
9469
    virDispatchError(vol->conn);
9470
    return NULL;
9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489
}


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

9492 9493
    virResetLastError();

9494
    if (!VIR_IS_STORAGE_VOL(vol)) {
9495
        virLibStorageVolError(VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
9496
        virDispatchError(NULL);
9497
        return NULL;
9498 9499 9500 9501
    }

    conn = vol->conn;

9502 9503 9504 9505 9506 9507 9508
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
9509

9510
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9511 9512

error:
9513
    virDispatchError(vol->conn);
9514 9515
    return NULL;
}
9516 9517


9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533
/**
 * 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)
{
9534
    VIR_DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
9535

9536 9537
    virResetLastError();

9538
    if (!VIR_IS_CONNECT(conn)) {
9539
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9540
        virDispatchError(NULL);
9541
        return -1;
9542 9543
    }
    if (flags != 0) {
9544
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9545
        goto error;
9546 9547
    }

9548 9549 9550 9551 9552 9553 9554
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9555

9556
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9557 9558

error:
9559
    virDispatchError(conn);
9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584
    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)
{
9585
    VIR_DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%d",
9586 9587
          conn, cap, names, maxnames, flags);

9588 9589
    virResetLastError();

9590
    if (!VIR_IS_CONNECT(conn)) {
9591
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9592
        virDispatchError(NULL);
9593
        return -1;
9594 9595
    }
    if ((flags != 0) || (names == NULL) || (maxnames < 0)) {
9596
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9597
        goto error;
9598 9599
    }

9600 9601 9602 9603 9604 9605 9606
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
9607

9608
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9609 9610

error:
9611
    virDispatchError(conn);
9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626
    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)
{
9627
    VIR_DEBUG("conn=%p, name=%p", conn, name);
9628

9629 9630
    virResetLastError();

9631
    if (!VIR_IS_CONNECT(conn)) {
9632
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
9633
        virDispatchError(NULL);
9634 9635 9636 9637
        return NULL;
    }

    if (name == NULL) {
9638
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9639
        goto error;
9640 9641
    }

9642 9643 9644 9645 9646 9647 9648
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
9649

9650
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9651 9652

error:
9653
    virDispatchError(conn);
9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665
    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.
 *
9666
 * Returns the XML document, or NULL on error
9667 9668 9669
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
9670
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9671

9672 9673
    virResetLastError();

9674
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9675
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9676
        virDispatchError(NULL);
9677 9678 9679
        return NULL;
    }

9680
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetXMLDesc) {
9681
        char *ret;
9682
        ret = dev->conn->deviceMonitor->deviceGetXMLDesc(dev, flags);
9683 9684 9685 9686
        if (!ret)
            goto error;
        return ret;
    }
9687

9688
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9689 9690

error:
9691
    virDispatchError(dev->conn);
9692 9693 9694 9695 9696 9697 9698 9699
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9700 9701 9702
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
9703 9704 9705
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
9706
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9707 9708

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9709
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9710
        virDispatchError(NULL);
9711 9712 9713 9714 9715 9716 9717 9718 9719 9720
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9721 9722
 * Accessor for the parent of the device
 *
9723 9724 9725 9726 9727
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
9728
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9729

9730 9731
    virResetLastError();

9732
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9733
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9734
        virDispatchError(NULL);
9735 9736 9737
        return NULL;
    }

9738 9739 9740 9741
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
9742
            virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9743
            virDispatchError(dev->conn);
9744 9745 9746 9747
            return NULL;
        }
    }
    return dev->parent;
9748 9749 9750 9751 9752 9753
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
9754 9755
 * Accessor for the number of capabilities supported by the device.
 *
9756 9757 9758 9759
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
9760
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9761

9762 9763
    virResetLastError();

9764
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9765
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9766
        virDispatchError(NULL);
9767 9768 9769
        return -1;
    }

9770 9771 9772 9773 9774 9775 9776
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
9777

9778
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9779 9780

error:
9781
    virDispatchError(dev->conn);
9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798
    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)
{
9799
    VIR_DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
9800 9801
          dev, dev ? dev->conn : NULL, names, maxnames);

9802 9803
    virResetLastError();

9804
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9805
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9806
        virDispatchError(NULL);
9807 9808 9809
        return -1;
    }

9810 9811 9812 9813 9814 9815 9816
    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;
    }
9817

9818
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9819 9820

error:
9821
    virDispatchError(dev->conn);
9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836
    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)
{
9837
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9838

9839 9840
    virResetLastError();

9841
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9842
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9843
        virDispatchError(NULL);
9844
        return -1;
9845
    }
9846 9847
    if (virUnrefNodeDevice(dev) < 0) {
        virDispatchError(NULL);
9848
        return -1;
9849
    }
9850
    return 0;
9851 9852 9853
}


9854 9855
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
9856
 * @dev: the dev to hold a reference on
9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867
 *
 * 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 已提交
9868 9869
 *
 * Returns 0 in case of success, -1 in case of failure.
9870 9871 9872 9873 9874
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
9875
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
9876
        virDispatchError(NULL);
9877
        return -1;
9878 9879
    }
    virMutexLock(&dev->conn->lock);
9880
    VIR_DEBUG("dev=%p refs=%d", dev, dev->refs);
9881 9882 9883 9884 9885
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}

9886
/**
D
Daniel Veillard 已提交
9887
 * virNodeDeviceDettach:
9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901
 * @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 已提交
9902 9903
 *
 * Returns 0 in case of success, -1 in case of failure.
9904 9905 9906 9907
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
9908
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9909 9910 9911 9912

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9913
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9914
        virDispatchError(NULL);
9915
        return -1;
9916 9917
    }

9918 9919 9920 9921 9922
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

9923 9924 9925 9926 9927 9928 9929 9930
    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

9931
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9932 9933

error:
9934
    virDispatchError(dev->conn);
9935
    return -1;
9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949
}

/**
 * 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 已提交
9950 9951
 *
 * Returns 0 in case of success, -1 in case of failure.
9952 9953 9954 9955
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
9956
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
9957 9958 9959 9960

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
9961
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
9962
        virDispatchError(NULL);
9963
        return -1;
9964 9965
    }

9966 9967 9968 9969 9970
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

9971 9972 9973 9974 9975 9976 9977 9978
    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

9979
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
9980 9981

error:
9982
    virDispatchError(dev->conn);
9983
    return -1;
9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999
}

/**
 * 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 已提交
10000 10001
 *
 * Returns 0 in case of success, -1 in case of failure.
10002 10003 10004 10005
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
10006
    VIR_DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);
10007 10008 10009 10010

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10011
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10012
        virDispatchError(NULL);
10013
        return -1;
10014 10015
    }

10016 10017 10018 10019 10020
    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

10021 10022 10023 10024 10025 10026 10027 10028
    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

10029
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10030 10031

error:
10032
    virDispatchError(dev->conn);
10033
    return -1;
10034 10035
}

10036

10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057
/**
 * 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)) {
10058
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10059
        virDispatchError(NULL);
10060 10061 10062 10063
        return NULL;
    }

    if (conn->flags & VIR_CONNECT_RO) {
10064
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10065 10066 10067 10068
        goto error;
    }

    if (xmlDesc == NULL) {
10069
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080
        goto error;
    }

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

10081
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10082 10083

error:
10084
    virDispatchError(conn);
10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100
    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)
{
10101
    VIR_DEBUG("dev=%p", dev);
10102 10103 10104 10105

    virResetLastError();

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
10106
        virLibNodeDeviceError(VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
10107
        virDispatchError(NULL);
10108
        return -1;
10109 10110 10111
    }

    if (dev->conn->flags & VIR_CONNECT_RO) {
10112
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125
        goto error;
    }

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

        return 0;
    }

10126
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10127 10128

error:
10129
    virDispatchError(dev->conn);
10130 10131 10132 10133
    return -1;
}


10134 10135 10136 10137 10138 10139 10140 10141 10142
/*
 * 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 已提交
10143
 * @freecb: optional function to deallocate opaque when not used anymore
10144
 *
10145 10146 10147 10148 10149 10150
 * 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
10151
 *
10152 10153
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
10154 10155
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
10156 10157 10158
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
10159 10160 10161 10162 10163
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
10164 10165
                              void *opaque,
                              virFreeCallback freecb)
10166
{
10167
    VIR_DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
10168
    virResetLastError();
10169 10170

    if (!VIR_IS_CONNECT(conn)) {
10171
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10172
        virDispatchError(NULL);
10173
        return -1;
10174 10175
    }
    if (cb == NULL) {
10176
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10177
        goto error;
10178 10179
    }

10180 10181 10182 10183 10184 10185 10186 10187
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

10188
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10189
error:
10190
    virDispatchError(conn);
10191 10192 10193 10194 10195 10196 10197 10198
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
10199 10200 10201 10202 10203 10204
 * 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
10205 10206 10207 10208 10209 10210 10211
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{
10212
    VIR_DEBUG("conn=%p, cb=%p", conn, cb);
10213 10214

    virResetLastError();
10215 10216

    if (!VIR_IS_CONNECT(conn)) {
10217
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10218
        virDispatchError(NULL);
10219
        return -1;
10220 10221
    }
    if (cb == NULL) {
10222
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10223 10224 10225 10226 10227 10228 10229 10230
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
10231 10232
    }

10233
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10234
error:
10235
    virDispatchError(conn);
10236 10237
    return -1;
}
10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253

/**
 * 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)
{
10254
    VIR_DEBUG("secret=%p", secret);
10255 10256 10257 10258

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET (secret)) {
10259
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10260
        virDispatchError(NULL);
10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281
        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)) {
10282
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10283
        virDispatchError(NULL);
10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296
        return -1;
    }

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

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

10297
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10298 10299

error:
10300
    virDispatchError(conn);
10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321
    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)) {
10322
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10323
        virDispatchError(NULL);
10324 10325 10326
        return -1;
    }
    if (uuids == NULL || maxuuids < 0) {
10327
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339
        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;
    }

10340
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10341 10342

error:
10343
    virDispatchError(conn);
10344 10345 10346 10347
    return -1;
}

/**
10348 10349 10350
 * virSecretLookupByUUID:
 * @conn: pointer to the hypervisor connection
 * @uuid: the raw UUID for the secret
10351
 *
10352 10353
 * Try to lookup a secret on the given hypervisor based on its UUID.
 * Uses the 16 bytes of raw data to describe the UUID
10354
 *
10355 10356
 * 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.
10357 10358
 */
virSecretPtr
10359
virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
10360
{
10361
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
10362 10363 10364 10365

    virResetLastError();

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

10375 10376
    if (conn->secretDriver &&
        conn->secretDriver->lookupByUUID) {
10377
        virSecretPtr ret;
10378 10379
        ret = conn->secretDriver->lookupByUUID (conn, uuid);
        if (!ret)
10380 10381 10382 10383
            goto error;
        return ret;
    }

10384
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10385 10386

error:
10387
    virDispatchError(conn);
10388 10389 10390
    return NULL;
}

10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405
/**
 * 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];
10406
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
10407 10408 10409 10410

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10411
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10412
        virDispatchError(NULL);
10413
        return NULL;
10414 10415
    }
    if (uuidstr == NULL) {
10416
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10417 10418
        goto error;
    }
10419 10420

    if (virUUIDParse(uuidstr, uuid) < 0) {
10421
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10422 10423 10424 10425 10426 10427
        goto error;
    }

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

error:
10428
    virDispatchError(conn);
10429 10430 10431 10432
    return NULL;
}


10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450
/**
 * 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)
{
10451
    VIR_DEBUG("conn=%p, usageType=%d usageID=%s", conn, usageType, NULLSTR(usageID));
10452 10453 10454 10455

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10456
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10457
        virDispatchError(NULL);
10458
        return NULL;
10459 10460
    }
    if (usageID == NULL) {
10461
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473
        goto error;
    }

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

10474
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10475 10476

error:
10477
    virDispatchError(conn);
10478 10479 10480 10481
    return NULL;
}


10482 10483 10484 10485 10486 10487
/**
 * virSecretDefineXML:
 * @conn: virConnect connection
 * @xml: XML describing the secret.
 * @flags: flags, use 0 for now
 *
D
Dan Kenigsberg 已提交
10488
 * If XML specifies a UUID, locates the specified secret and replaces all
10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504
 * 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)) {
10505
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10506
        virDispatchError(NULL);
10507 10508 10509
        return NULL;
    }
    if (conn->flags & VIR_CONNECT_RO) {
10510
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10511 10512 10513
        goto error;
    }
    if (xml == NULL) {
10514
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526
        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;
    }

10527
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10528 10529

error:
10530
    virDispatchError(conn);
10531 10532 10533 10534
    return NULL;
}

/**
10535
 * virSecretGetUUID:
10536
 * @secret: A virSecret secret
10537
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
10538 10539 10540
 *
 * Fetches the UUID of the secret.
 *
10541 10542
 * Returns 0 on success with the uuid buffer being filled, or
 * -1 upon failure.
10543
 */
10544 10545
int
virSecretGetUUID(virSecretPtr secret, unsigned char *uuid)
10546 10547 10548 10549 10550 10551
{
    VIR_DEBUG("secret=%p", secret);

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
10552
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10553
        virDispatchError(NULL);
10554 10555 10556
        return -1;
    }
    if (uuid == NULL) {
10557
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10558
        virDispatchError(secret->conn);
10559
        return -1;
10560 10561
    }

10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580
    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];
10581
    VIR_DEBUG("secret=%p, buf=%p", secret, buf);
10582 10583

    virResetLastError();
10584

10585
    if (!VIR_IS_SECRET(secret)) {
10586
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10587
        virDispatchError(NULL);
10588
        return -1;
10589 10590
    }
    if (buf == NULL) {
10591
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10592 10593 10594 10595 10596 10597 10598
        goto error;
    }

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

    virUUIDFormat(uuid, buf);
10599
    return 0;
10600 10601

error:
10602
    virDispatchError(secret->conn);
10603
    return -1;
10604 10605
}

10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621
/**
 * 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)
{
10622
    VIR_DEBUG("secret=%p", secret);
10623 10624 10625 10626

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
10627
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10628
        virDispatchError(NULL);
10629
        return -1;
10630
    }
10631
    return secret->usageType;
10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652
}

/**
 * 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)
{
10653
    VIR_DEBUG("secret=%p", secret);
10654 10655 10656 10657

    virResetLastError();

    if (!VIR_IS_SECRET(secret)) {
10658
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10659
        virDispatchError(NULL);
10660
        return NULL;
10661
    }
10662
    return secret->usageID;
10663 10664
}

10665

10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685
/**
 * 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)) {
10686
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10687
        virDispatchError(NULL);
10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700
        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;
    }

10701
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10702 10703

error:
10704
    virDispatchError(conn);
10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730
    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)) {
10731
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10732
        virDispatchError(NULL);
10733 10734 10735 10736
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10737
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10738 10739 10740
        goto error;
    }
    if (value == NULL) {
10741
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753
        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;
    }

10754
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10755 10756

error:
10757
    virDispatchError(conn);
10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781
    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)) {
10782
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10783
        virDispatchError(NULL);
10784 10785 10786 10787
        return NULL;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10788
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10789 10790 10791
        goto error;
    }
    if (value_size == NULL) {
10792
        virLibSecretError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10793 10794 10795
        goto error;
    }

10796 10797
    flags &= VIR_SECRET_GET_VALUE_FLAGS_MASK;

10798 10799 10800 10801 10802 10803 10804 10805 10806
    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;
    }

10807
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10808 10809

error:
10810
    virDispatchError(conn);
10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832
    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)) {
10833
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10834
        virDispatchError(NULL);
10835 10836 10837 10838
        return -1;
    }
    conn = secret->conn;
    if (conn->flags & VIR_CONNECT_RO) {
10839
        virLibSecretError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851
        goto error;
    }

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

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

10852
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
10853 10854

error:
10855
    virDispatchError(conn);
10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878
    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)) {
10879
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10880
        virDispatchError(NULL);
10881 10882 10883
        return -1;
    }
    virMutexLock(&secret->conn->lock);
10884
    VIR_DEBUG("secret=%p refs=%d", secret, secret->refs);
10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895
    secret->refs++;
    virMutexUnlock(&secret->conn->lock);
    return 0;
}

/**
 * virSecretFree:
 * @secret: pointer to a secret
 *
 * Release the secret handle. The underlying secret continues to exist.
 *
10896
 * Returns 0 on success, or -1 on error
10897 10898 10899 10900
 */
int
virSecretFree(virSecretPtr secret)
{
10901
    VIR_DEBUG("secret=%p", secret);
10902 10903 10904 10905

    virResetLastError();

    if (!VIR_IS_CONNECTED_SECRET(secret)) {
10906
        virLibSecretError(VIR_ERR_INVALID_SECRET, __FUNCTION__);
10907
        virDispatchError(NULL);
10908 10909
        return -1;
    }
10910 10911
    if (virUnrefSecret(secret) < 0) {
        virDispatchError(NULL);
10912
        return -1;
10913
    }
10914 10915
    return 0;
}
10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942


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

10943
    VIR_DEBUG("conn=%p, flags=%u", conn, flags);
10944 10945 10946 10947

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
10948
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
10949
        virDispatchError(NULL);
10950
        return NULL;
10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975
    }

    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))) {
10976
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
10977
        virDispatchError(NULL);
10978
        return -1;
10979 10980
    }
    virMutexLock(&stream->conn->lock);
10981
    VIR_DEBUG("stream=%p refs=%d", stream, stream->refs);
10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996
    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
10997
 * it should call virStreamFinish to wait for successful
10998 10999 11000 11001 11002 11003 11004 11005 11006
 * 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 已提交
11007
 * An example using this with a hypothetical file upload
11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055
 * 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)
{
11056
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
11057 11058 11059 11060

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11061
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11062
        virDispatchError(NULL);
11063
        return -1;
11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076
    }

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

11077
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11078 11079

error:
11080
    virDispatchError(stream->conn);
11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098
    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 已提交
11099
 * An example using this with a hypothetical file download
11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150
 * 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)
{
11151
    VIR_DEBUG("stream=%p, data=%p, nbytes=%zi", stream, data, nbytes);
11152 11153 11154 11155

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11156
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11157
        virDispatchError(NULL);
11158
        return -1;
11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171
    }

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

11172
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11173 11174

error:
11175
    virDispatchError(stream->conn);
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189
    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 已提交
11190
 * An example using this with a hypothetical file upload
11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211
 * 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);
 *
11212
 * Returns 0 if all the data was successfully sent. The caller
11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226
 * 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;
11227
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
11228 11229 11230 11231

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11232
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11233
        virDispatchError(NULL);
11234
        return -1;
11235 11236 11237
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
11238
        virLibConnError(VIR_ERR_OPERATION_INVALID,
11239 11240 11241 11242 11243
                        _("data sources cannot be used for non-blocking streams"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(bytes, want) < 0) {
11244
        virReportOOMError();
11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270
        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)
11271
        virDispatchError(stream->conn);
11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286

    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 已提交
11287
 * An example using this with a hypothetical file download
11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308
 * 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);
 *
11309
 * Returns 0 if all the data was successfully received. The caller
11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323
 * 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;
11324
    VIR_DEBUG("stream=%p, handler=%p, opaque=%p", stream, handler, opaque);
11325 11326 11327 11328

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11329
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11330
        virDispatchError(NULL);
11331
        return -1;
11332 11333 11334
    }

    if (stream->flags & VIR_STREAM_NONBLOCK) {
11335
        virLibConnError(VIR_ERR_OPERATION_INVALID,
11336 11337 11338 11339 11340 11341
                        _("data sinks cannot be used for non-blocking streams"));
        goto cleanup;
    }


    if (VIR_ALLOC_N(bytes, want) < 0) {
11342
        virReportOOMError();
11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368
        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)
11369
        virDispatchError(stream->conn);
11370 11371 11372 11373 11374 11375

    return ret;
}


/**
M
Matthias Bolte 已提交
11376
 * virStreamEventAddCallback:
11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395
 * @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)
{
11396
    VIR_DEBUG("stream=%p, events=%d, cb=%p, opaque=%p, ff=%p", stream, events, cb, opaque, ff);
11397 11398 11399 11400

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11401
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11402
        virDispatchError(NULL);
11403
        return -1;
11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414
    }

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

11415
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11416 11417

error:
11418
    virDispatchError(stream->conn);
11419 11420 11421 11422 11423
    return -1;
}


/**
M
Matthias Bolte 已提交
11424
 * virStreamEventUpdateCallback:
11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437
 * @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)
{
11438
    VIR_DEBUG("stream=%p, events=%d", stream, events);
11439 11440 11441 11442

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11443
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11444
        virDispatchError(NULL);
11445
        return -1;
11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456
    }

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

11457
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11458 11459

error:
11460
    virDispatchError(stream->conn);
11461 11462 11463 11464
    return -1;
}

/**
M
Matthias Bolte 已提交
11465
 * virStreamEventRemoveCallback:
11466 11467
 * @stream: pointer to the stream object
 *
D
Dan Kenigsberg 已提交
11468
 * Remove an event callback from the stream
11469 11470 11471 11472 11473
 *
 * Returns 0 on success, -1 on error
 */
int virStreamEventRemoveCallback(virStreamPtr stream)
{
11474
    VIR_DEBUG("stream=%p", stream);
11475 11476 11477 11478

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11479
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11480
        virDispatchError(NULL);
11481
        return -1;
11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492
    }

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

11493
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11494 11495

error:
11496
    virDispatchError(stream->conn);
11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516
    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)
{
11517
    VIR_DEBUG("stream=%p", stream);
11518 11519 11520 11521

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11522
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11523
        virDispatchError(NULL);
11524
        return -1;
11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535
    }

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

11536
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11537 11538

error:
11539
    virDispatchError(stream->conn);
11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557
    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)
{
11558
    VIR_DEBUG("stream=%p", stream);
11559 11560 11561 11562

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11563
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11564
        virDispatchError(NULL);
11565
        return -1;
11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576
    }

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

11577
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11578 11579

error:
11580
    virDispatchError(stream->conn);
11581 11582 11583 11584 11585 11586 11587 11588 11589 11590
    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 已提交
11591
 * There must not be an active data transfer in progress
11592 11593 11594 11595 11596 11597 11598 11599
 * 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)
{
11600
    VIR_DEBUG("stream=%p", stream);
11601 11602 11603 11604

    virResetLastError();

    if (!VIR_IS_CONNECTED_STREAM(stream)) {
11605
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11606
        virDispatchError(NULL);
11607
        return -1;
11608 11609 11610 11611
    }

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

11612 11613
    if (virUnrefStream(stream) < 0) {
        virDispatchError(NULL);
11614
        return -1;
11615
    }
11616
    return 0;
11617
}
11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629


/**
 * 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)
{
11630
    VIR_DEBUG("dom=%p", dom);
11631 11632 11633 11634

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
11635
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11636
        virDispatchError(NULL);
11637
        return -1;
11638 11639 11640 11641 11642 11643 11644 11645 11646
    }
    if (dom->conn->driver->domainIsActive) {
        int ret;
        ret = dom->conn->driver->domainIsActive(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

11647
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11648
error:
11649
    virDispatchError(dom->conn);
11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663
    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)
{
11664
    VIR_DOMAIN_DEBUG0(dom);
11665 11666 11667 11668

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
11669
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11670
        virDispatchError(NULL);
11671
        return -1;
11672 11673 11674 11675 11676 11677 11678 11679 11680
    }
    if (dom->conn->driver->domainIsPersistent) {
        int ret;
        ret = dom->conn->driver->domainIsPersistent(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

11681
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11682
error:
11683
    virDispatchError(dom->conn);
11684 11685 11686
    return -1;
}

11687 11688 11689 11690 11691 11692 11693 11694 11695 11696
/**
 * 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)
{
11697
    VIR_DOMAIN_DEBUG0(dom);
11698 11699 11700 11701

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
11702
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11703
        virDispatchError(NULL);
11704
        return -1;
11705 11706 11707 11708 11709 11710 11711 11712 11713
    }
    if (dom->conn->driver->domainIsUpdated) {
        int ret;
        ret = dom->conn->driver->domainIsUpdated(dom);
        if (ret < 0)
            goto error;
        return ret;
    }

11714
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11715 11716 11717 11718 11719
error:
    virDispatchError(dom->conn);
    return -1;
}

11720 11721 11722 11723 11724 11725 11726 11727 11728 11729
/**
 * 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)
{
11730
    VIR_DEBUG("net=%p", net);
11731 11732 11733 11734

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
11735
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11736
        virDispatchError(NULL);
11737
        return -1;
11738 11739 11740 11741 11742 11743 11744 11745 11746
    }
    if (net->conn->networkDriver->networkIsActive) {
        int ret;
        ret = net->conn->networkDriver->networkIsActive(net);
        if (ret < 0)
            goto error;
        return ret;
    }

11747
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11748
error:
11749
    virDispatchError(net->conn);
11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764
    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)
{
11765
    VIR_DEBUG("net=%p", net);
11766 11767 11768 11769

    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(net)) {
11770
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11771
        virDispatchError(NULL);
11772
        return -1;
11773 11774 11775 11776 11777 11778 11779 11780 11781
    }
    if (net->conn->networkDriver->networkIsPersistent) {
        int ret;
        ret = net->conn->networkDriver->networkIsPersistent(net);
        if (ret < 0)
            goto error;
        return ret;
    }

11782
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11783
error:
11784
    virDispatchError(net->conn);
11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798
    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)
{
11799
    VIR_DEBUG("pool=%p", pool);
11800 11801 11802 11803

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11804
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11805
        virDispatchError(NULL);
11806
        return -1;
11807 11808 11809 11810 11811 11812 11813 11814 11815
    }
    if (pool->conn->storageDriver->poolIsActive) {
        int ret;
        ret = pool->conn->storageDriver->poolIsActive(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

11816
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11817
error:
11818
    virDispatchError(pool->conn);
11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833
    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)
{
11834
    VIR_DEBUG("pool=%p", pool);
11835 11836 11837 11838

    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
11839
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
11840
        virDispatchError(NULL);
11841
        return -1;
11842 11843 11844 11845 11846 11847 11848 11849 11850
    }
    if (pool->conn->storageDriver->poolIsPersistent) {
        int ret;
        ret = pool->conn->storageDriver->poolIsPersistent(pool);
        if (ret < 0)
            goto error;
        return ret;
    }

11851
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
11852
error:
11853
    virDispatchError(pool->conn);
11854 11855 11856 11857
    return -1;
}


S
Stefan Berger 已提交
11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869

/**
 * 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)
{
11870
    VIR_DEBUG("conn=%p", conn);
S
Stefan Berger 已提交
11871 11872 11873 11874

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11875
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887
        virDispatchError(NULL);
        return -1;
    }

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

11888
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908

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)
{
11909
    VIR_DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);
S
Stefan Berger 已提交
11910 11911 11912 11913

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11914
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11915 11916 11917 11918 11919
        virDispatchError(NULL);
        return -1;
    }

    if ((names == NULL) || (maxnames < 0)) {
11920
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931
        goto error;
    }

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

11932
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952

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)
{
11953
    VIR_DEBUG("conn=%p, name=%s", conn, name);
S
Stefan Berger 已提交
11954 11955 11956 11957

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
11958
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
11959
        virDispatchError(NULL);
11960
        return NULL;
S
Stefan Berger 已提交
11961 11962
    }
    if (name == NULL) {
11963
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974
        goto  error;
    }

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

11975
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994

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)
{
11995
    VIR_DEBUG("conn=%p, uuid=%s", conn, uuid);
S
Stefan Berger 已提交
11996 11997 11998 11999

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12000
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12001
        virDispatchError(NULL);
12002
        return NULL;
S
Stefan Berger 已提交
12003 12004
    }
    if (uuid == NULL) {
12005
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016
        goto error;
    }

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

12017
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12018 12019 12020 12021 12022 12023 12024

error:
    virDispatchError(conn);
    return NULL;
}

/**
12025
 * virNWFilterLookupByUUIDString:
S
Stefan Berger 已提交
12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037
 * @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];
12038
    VIR_DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
S
Stefan Berger 已提交
12039 12040 12041 12042

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12043
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12044
        virDispatchError(NULL);
12045
        return NULL;
S
Stefan Berger 已提交
12046 12047
    }
    if (uuidstr == NULL) {
12048
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12049 12050 12051 12052
        goto error;
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
12053
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075
        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)
{
12076
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12077 12078 12079 12080

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
12081
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103
        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)
{
12104
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12105 12106 12107 12108

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12109
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12110
        virDispatchError(NULL);
12111
        return NULL;
S
Stefan Berger 已提交
12112
    }
12113
    return nwfilter->name;
S
Stefan Berger 已提交
12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127
}

/**
 * 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)
{
12128
    VIR_DEBUG("nwfilter=%p, uuid=%p", nwfilter, uuid);
S
Stefan Berger 已提交
12129 12130 12131 12132

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12133
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12134 12135 12136 12137
        virDispatchError(NULL);
        return -1;
    }
    if (uuid == NULL) {
12138
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164
        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];
12165
    VIR_DEBUG("nwfilter=%p, buf=%p", nwfilter, buf);
S
Stefan Berger 已提交
12166 12167 12168 12169

    virResetLastError();

    if (!VIR_IS_NWFILTER(nwfilter)) {
12170
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12171 12172 12173 12174
        virDispatchError(NULL);
        return -1;
    }
    if (buf == NULL) {
12175
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203
        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)
{
12204
    VIR_DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);
S
Stefan Berger 已提交
12205 12206 12207 12208

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12209
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
S
Stefan Berger 已提交
12210
        virDispatchError(NULL);
12211
        return NULL;
S
Stefan Berger 已提交
12212 12213
    }
    if (xmlDesc == NULL) {
12214
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12215 12216 12217
        goto error;
    }
    if (conn->flags & VIR_CONNECT_RO) {
12218
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229
        goto error;
    }

    if (conn->nwfilterDriver && conn->nwfilterDriver->defineXML) {
        virNWFilterPtr ret;
        ret = conn->nwfilterDriver->defineXML (conn, xmlDesc, 0);
        if (!ret)
            goto error;
        return ret;
    }

12230
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251

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;
12252
    VIR_DEBUG("nwfilter=%p", nwfilter);
S
Stefan Berger 已提交
12253 12254 12255 12256

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
12257
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12258 12259 12260 12261 12262 12263
        virDispatchError(NULL);
        return -1;
    }

    conn = nwfilter->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12264
        virLibNWFilterError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
S
Stefan Berger 已提交
12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275
        goto error;
    }

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

12276
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298

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;
12299
    VIR_DEBUG("nwfilter=%p, flags=%d", nwfilter, flags);
S
Stefan Berger 已提交
12300 12301 12302 12303

    virResetLastError();

    if (!VIR_IS_CONNECTED_NWFILTER(nwfilter)) {
12304
        virLibNWFilterError(VIR_ERR_INVALID_NWFILTER, __FUNCTION__);
S
Stefan Berger 已提交
12305
        virDispatchError(NULL);
12306
        return NULL;
S
Stefan Berger 已提交
12307 12308
    }
    if (flags != 0) {
12309
        virLibNWFilterError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322
        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;
    }

12323
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
S
Stefan Berger 已提交
12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351

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))) {
12352
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
S
Stefan Berger 已提交
12353 12354 12355 12356
        virDispatchError(NULL);
        return -1;
    }
    virMutexLock(&nwfilter->conn->lock);
12357
    VIR_DEBUG("nwfilter=%p refs=%d", nwfilter, nwfilter->refs);
S
Stefan Berger 已提交
12358 12359 12360 12361 12362 12363
    nwfilter->refs++;
    virMutexUnlock(&nwfilter->conn->lock);
    return 0;
}


12364 12365 12366 12367 12368 12369 12370 12371 12372 12373
/**
 * 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)
{
12374
    VIR_DEBUG("iface=%p", iface);
12375 12376 12377 12378

    virResetLastError();

    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
12379
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12380
        virDispatchError(NULL);
12381
        return -1;
12382 12383 12384 12385 12386 12387 12388 12389 12390
    }
    if (iface->conn->interfaceDriver->interfaceIsActive) {
        int ret;
        ret = iface->conn->interfaceDriver->interfaceIsActive(iface);
        if (ret < 0)
            goto error;
        return ret;
    }

12391
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12392
error:
12393
    virDispatchError(iface->conn);
12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407
    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)
{
12408
    VIR_DEBUG("conn=%p", conn);
12409 12410 12411 12412

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12413
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12414
        virDispatchError(NULL);
12415
        return -1;
12416 12417 12418 12419 12420 12421 12422 12423 12424
    }
    if (conn->driver->isEncrypted) {
        int ret;
        ret = conn->driver->isEncrypted(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

12425
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12426
error:
12427
    virDispatchError(conn);
12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444
    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)
{
12445
    VIR_DEBUG("conn=%p", conn);
12446 12447 12448 12449

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12450
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12451
        virDispatchError(NULL);
12452
        return -1;
12453 12454 12455 12456 12457 12458 12459 12460 12461
    }
    if (conn->driver->isSecure) {
        int ret;
        ret = conn->driver->isSecure(conn);
        if (ret < 0)
            goto error;
        return ret;
    }

12462
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12463
error:
12464
    virDispatchError(conn);
12465 12466
    return -1;
}
J
Jiri Denemark 已提交
12467 12468 12469 12470 12471


/**
 * virConnectCompareCPU:
 * @conn: virConnect connection
12472 12473 12474 12475
 * @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 已提交
12476 12477 12478 12479 12480 12481 12482 12483
 *
 * Returns comparison result according to enum virCPUCompareResult
 */
int
virConnectCompareCPU(virConnectPtr conn,
                     const char *xmlDesc,
                     unsigned int flags)
{
12484
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%u", conn, xmlDesc, flags);
J
Jiri Denemark 已提交
12485 12486 12487 12488

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12489
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12490
        virDispatchError(NULL);
J
Jiri Denemark 已提交
12491 12492 12493
        return VIR_CPU_COMPARE_ERROR;
    }
    if (xmlDesc == NULL) {
12494
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
J
Jiri Denemark 已提交
12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506
        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;
    }

12507
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
J
Jiri Denemark 已提交
12508 12509

error:
12510
    virDispatchError(conn);
J
Jiri Denemark 已提交
12511 12512
    return VIR_CPU_COMPARE_ERROR;
}
12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545


/**
 * 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)) {
12546
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12547 12548 12549 12550
        virDispatchError(NULL);
        return NULL;
    }
    if (xmlCPUs == NULL) {
12551
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563
        goto error;
    }

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

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

12564
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12565 12566 12567 12568 12569

error:
    virDispatchError(conn);
    return NULL;
}
12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585


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

    VIR_DOMAIN_DEBUG(domain, "info=%p", info);
12588 12589 12590 12591

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12592
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12593
        virDispatchError(NULL);
12594
        return -1;
12595 12596
    }
    if (info == NULL) {
12597
        virLibDomainError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612
        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;
    }

12613
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12614 12615 12616 12617 12618

error:
    virDispatchError(domain->conn);
    return -1;
}
12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635


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

12636
    VIR_DOMAIN_DEBUG0(domain);
12637 12638 12639 12640

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12641
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12642
        virDispatchError(NULL);
12643
        return -1;
12644 12645 12646 12647
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12648
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659
        goto error;
    }

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

12660
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12661 12662 12663 12664 12665

error:
    virDispatchError(conn);
    return -1;
}
12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686


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

12687
    VIR_DOMAIN_DEBUG(domain, "downtime=%llu, flags=%u", downtime, flags);
12688 12689 12690 12691

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
12692
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12693 12694 12695 12696 12697 12698
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12699
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12700 12701 12702 12703 12704 12705 12706 12707 12708
        goto error;
    }

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

12709
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12710 12711 12712 12713 12714
error:
    virDispatchError(conn);
    return -1;
}

12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761
/**
 * virDomainMigrateSetMaxSpeed:
 * @domain: a domain object
 * @bandwidth: migration bandwidth limit in Mbps
 * @flags: fine-tuning flags, currently unused, use 0
 *
 * The maximum bandwidth (in Mbps) that will be used to do migration
 * can be specified with the bandwidth parameter. Not all hypervisors
 * will support a bandwidth cap
 *
 * Returns 0 in case of success, -1 otherwise.
 */
int
virDomainMigrateSetMaxSpeed(virDomainPtr domain,
                            unsigned long bandwidth,
                            unsigned int flags)
{
    virConnectPtr conn;

    VIR_DOMAIN_DEBUG(domain, "bandwidth=%lu, flags=%u", bandwidth, flags);

    virResetLastError();

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

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

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

    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    virDispatchError(conn);
    return -1;
}

12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783
/**
 * 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.
12784 12785
 * If the callback wishes to keep the domain object after the callback returns,
 * it shall take a reference to it, by calling virDomainRef.
12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802
 * 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)
{
12803 12804 12805
    VIR_DOMAIN_DEBUG(dom, "conn=%p, eventID=%d, cb=%p, opaque=%p, freecb=%p",
                     conn, eventID, cb, opaque, freecb);

12806 12807 12808
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12809
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12810
        virDispatchError(NULL);
12811
        return -1;
12812 12813 12814
    }
    if (dom != NULL &&
        !(VIR_IS_CONNECTED_DOMAIN(dom) && dom->conn == conn)) {
12815
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12816
        virDispatchError(conn);
12817
        return -1;
12818 12819
    }
    if (eventID < 0 || eventID >= VIR_DOMAIN_EVENT_ID_LAST || cb == NULL) {
12820
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831
        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;
    }

12832
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12833 12834 12835 12836
error:
    virDispatchError(conn);
    return -1;
}
12837

12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851
/**
 * 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)
{
12852
    VIR_DEBUG("conn=%p, callbackID=%d", conn, callbackID);
12853 12854 12855 12856

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
12857
        virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
12858
        virDispatchError(NULL);
12859
        return -1;
12860 12861
    }
    if (callbackID < 0) {
12862
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
12863 12864 12865 12866 12867 12868 12869 12870 12871 12872
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregisterAny)) {
        int ret;
        ret = conn->driver->domainEventDeregisterAny(conn, callbackID);
        if (ret < 0)
            goto error;
        return ret;
    }

12873
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12874 12875 12876 12877
error:
    virDispatchError(conn);
    return -1;
}
12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897

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

12898
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
12899 12900 12901 12902

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12903
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12904 12905 12906 12907 12908 12909
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12910
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922
        goto error;
    }

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

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

12923
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945

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;

12946
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
12947 12948 12949 12950

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12951
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966
        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;
    }

12967
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978

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

/**
 * virDomainManagedSaveRemove:
 * @dom: pointer to the domain
 * @flags: optional flags currently unused
 *
D
Daniel Veillard 已提交
12979
 * Remove any managed save image for this domain.
12980 12981 12982 12983 12984 12985 12986
 *
 * Returns 0 in case of success, and -1 in case of error
 */
int virDomainManagedSaveRemove(virDomainPtr dom, unsigned int flags)
{
    virConnectPtr conn;

12987
    VIR_DOMAIN_DEBUG(dom, "flags=%u", flags);
12988 12989 12990 12991

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(dom)) {
12992
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
12993 12994 12995 12996 12997 12998
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
12999
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011
        goto error;
    }

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

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

13012
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13013 13014 13015 13016 13017

error:
    virDispatchError(conn);
    return -1;
}
C
Chris Lalancette 已提交
13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036

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

13037
    VIR_DOMAIN_DEBUG(domain, "xmlDesc=%s, flags=%u", xmlDesc, flags);
C
Chris Lalancette 已提交
13038 13039 13040 13041

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13042
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13043 13044 13045 13046 13047 13048
        virDispatchError(NULL);
        return NULL;
    }

    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13049
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
C
Chris Lalancette 已提交
13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060
        goto error;
    }

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

13061
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081
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;
13082
    VIR_DEBUG("snapshot=%p, flags=%d", snapshot, flags);
C
Chris Lalancette 已提交
13083 13084 13085 13086

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13087
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13088 13089
                                  __FUNCTION__);
        virDispatchError(NULL);
13090
        return NULL;
C
Chris Lalancette 已提交
13091 13092 13093 13094 13095
    }

    conn = snapshot->domain->conn;

    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
13096
        virLibConnError(VIR_ERR_OPERATION_DENIED,
C
Chris Lalancette 已提交
13097 13098 13099 13100
                        _("virDomainSnapshotGetXMLDesc with secure flag"));
        goto error;
    }

13101
    if (conn->driver->domainSnapshotGetXMLDesc) {
C
Chris Lalancette 已提交
13102
        char *ret;
13103
        ret = conn->driver->domainSnapshotGetXMLDesc(snapshot, flags);
C
Chris Lalancette 已提交
13104 13105 13106 13107 13108
        if (!ret)
            goto error;
        return ret;
    }

13109
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127
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;
13128 13129

    VIR_DOMAIN_DEBUG0(domain);
C
Chris Lalancette 已提交
13130 13131 13132 13133

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13134
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146
        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;
    }

13147
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171
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;

13172 13173
    VIR_DOMAIN_DEBUG(domain, "names=%p, nameslen=%d, flags=%u",
                     names, nameslen, flags);
C
Chris Lalancette 已提交
13174 13175 13176 13177

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13178
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13179 13180 13181 13182 13183 13184 13185
        virDispatchError(NULL);
        return -1;
    }

    conn = domain->conn;

    if ((names == NULL) || (nameslen < 0)) {
13186
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197
        goto error;
    }

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

13198
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221
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;
13222 13223

    VIR_DOMAIN_DEBUG(domain, "name=%s, flags=%u", name, flags);
C
Chris Lalancette 已提交
13224 13225 13226 13227

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13228
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13229
        virDispatchError(NULL);
13230
        return NULL;
C
Chris Lalancette 已提交
13231 13232 13233 13234 13235
    }

    conn = domain->conn;

    if (name == NULL) {
13236
        virLibConnError(VIR_ERR_INVALID_ARG, __FUNCTION__);
C
Chris Lalancette 已提交
13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247
        goto error;
    }

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

13248
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266
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;
13267 13268

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
13269 13270 13271 13272

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13273
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286
        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;
    }

13287
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308
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;
13309 13310

    VIR_DOMAIN_DEBUG(domain, "flags=%u", flags);
C
Chris Lalancette 已提交
13311 13312 13313 13314

    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
13315
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
C
Chris Lalancette 已提交
13316
        virDispatchError(NULL);
13317
        return NULL;
C
Chris Lalancette 已提交
13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329
    }

    conn = domain->conn;

    if (conn->driver->domainSnapshotCurrent) {
        virDomainSnapshotPtr snap;
        snap = conn->driver->domainSnapshotCurrent(domain, flags);
        if (!snap)
            goto error;
        return snap;
    }

13330
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13331 13332 13333 13334 13335 13336
error:
    virDispatchError(conn);
    return NULL;
}

/**
13337
 * virDomainRevertToSnapshot:
C
Chris Lalancette 已提交
13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350
 * @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;

13351
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
13352 13353 13354 13355

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13356
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13357 13358 13359 13360 13361 13362
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
13363 13364 13365 13366
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
13367 13368 13369 13370 13371 13372 13373 13374

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

13375
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13376 13377 13378 13379 13380 13381
error:
    virDispatchError(conn);
    return -1;
}

/**
13382
 * virDomainSnapshotDelete:
C
Chris Lalancette 已提交
13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400
 * @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;

13401
    VIR_DEBUG("snapshot=%p, flags=%u", snapshot, flags);
C
Chris Lalancette 已提交
13402 13403 13404 13405

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13406
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13407 13408 13409 13410 13411 13412
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }

    conn = snapshot->domain->conn;
13413 13414 13415 13416
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }
C
Chris Lalancette 已提交
13417 13418 13419 13420 13421 13422 13423 13424

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

13425
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
C
Chris Lalancette 已提交
13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442
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)
{
13443
    VIR_DEBUG("snapshot=%p", snapshot);
C
Chris Lalancette 已提交
13444 13445 13446 13447

    virResetLastError();

    if (!VIR_IS_DOMAIN_SNAPSHOT(snapshot)) {
13448
        virLibDomainSnapshotError(VIR_ERR_INVALID_DOMAIN_SNAPSHOT,
C
Chris Lalancette 已提交
13449 13450 13451 13452 13453 13454 13455 13456 13457 13458
                                  __FUNCTION__);
        virDispatchError(NULL);
        return -1;
    }
    if (virUnrefDomainSnapshot(snapshot) < 0) {
        virDispatchError(NULL);
        return -1;
    }
    return 0;
}
13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481

/**
 * 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;
13482 13483 13484

    VIR_DOMAIN_DEBUG(dom, "devname=%s, st=%p, flags=%u",
                     NULLSTR(devname), st, flags);
13485 13486 13487 13488

    virResetLastError();

    if (!VIR_IS_DOMAIN(dom)) {
13489
        virLibDomainError(VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
13490 13491 13492 13493 13494 13495
        virDispatchError(NULL);
        return -1;
    }

    conn = dom->conn;
    if (conn->flags & VIR_CONNECT_RO) {
13496
        virLibDomainError(VIR_ERR_OPERATION_DENIED, __FUNCTION__);
13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507
        goto error;
    }

    if (conn->driver->domainOpenConsole) {
        int ret;
        ret = conn->driver->domainOpenConsole(dom, devname, st, flags);
        if (ret < 0)
            goto error;
        return ret;
    }

13508
    virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
13509 13510 13511 13512 13513

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