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

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

14
#include <stdio.h>
15
#include <stdlib.h>
16
#include <string.h>
17 18 19
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
20
#include <assert.h>
21 22 23
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif
24

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

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

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

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

#ifdef WITH_TEST
45
#include "test.h"
46 47
#endif
#ifdef WITH_XEN
48
#include "xen_unified.h"
49 50
#endif
#ifdef WITH_REMOTE
51
#include "remote_internal.h"
52 53
#endif
#ifdef WITH_QEMU
54
#include "qemu_driver.h"
55
#endif
56 57 58
#ifdef WITH_OPENVZ
#include "openvz_driver.h"
#endif
D
Daniel Veillard 已提交
59 60 61
#ifdef WITH_LXC
#include "lxc_driver.h"
#endif
62
#include "storage_driver.h"
63 64 65
#ifdef WITH_NETWORK
#include "network_driver.h"
#endif
66

D
Daniel Veillard 已提交
67 68 69
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
D
Daniel Veillard 已提交
70
 * - use reference counting to guarantee coherent pointer state ?
D
Daniel Veillard 已提交
71 72
 */

73 74
#define MAX_DRIVERS 10

75
static virDriverPtr virDriverTab[MAX_DRIVERS];
76
static int virDriverTabCount = 0;
77
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
78
static int virNetworkDriverTabCount = 0;
79 80
static virStorageDriverPtr virStorageDriverTab[MAX_DRIVERS];
static int virStorageDriverTabCount = 0;
A
Atsushi SAKAI 已提交
81
#ifdef WITH_LIBVIRTD
82 83
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
A
Atsushi SAKAI 已提交
84
#endif
85 86
static int initialized = 0;

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
#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

120 121 122 123 124 125 126 127
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;
128
        size_t len;
129 130

        switch (cred[i].type) {
131 132 133 134
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

135
#if defined(POLKIT_AUTH)
136
            if (virConnectAuthGainPolkit(cred[i].prompt) < 0)
137
                return -1;
138 139 140 141 142 143 144
#else
            /*
             * Ignore & carry on. Although we can't auth
             * directly, the user may have authenticated
             * themselves already outside context of libvirt
             */
#endif
145 146
            break;
        }
147

148 149 150 151
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
152 153 154 155 156
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

157 158 159 160 161 162 163
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
164 165 166
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
167 168 169 170
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
171 172 173 174 175
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

176 177 178 179
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
180 181 182

        default:
            return -1;
183 184
        }

D
Daniel P. Berrange 已提交
185 186 187 188 189 190 191 192 193
        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);
        }
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    }

    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,
209
    VIR_CRED_EXTERNAL,
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
};

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;

231 232 233 234 235 236 237 238 239 240
#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 已提交
241
    return err == 0 ? 0 : -1;
242 243 244
}
#endif

245 246 247 248 249 250 251 252 253 254 255 256
/**
 * 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)
{
257 258 259
#ifdef ENABLE_DEBUG
    char *debugEnv;
#endif
260 261
    if (initialized)
        return(0);
262
    initialized = 1;
263

264 265 266 267 268 269 270 271
#ifdef ENABLE_DEBUG
    debugEnv = getenv("LIBVIRT_DEBUG");
    if (debugEnv && *debugEnv && *debugEnv != '0')
        debugFlag = 1;
#endif

    DEBUG0("register drivers");

272 273 274 275
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

276 277 278
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

279
    /*
280 281
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
282
     */
283
#ifdef WITH_TEST
284
    if (testRegister() == -1) return -1;
285
#endif
286 287
#ifdef WITH_XEN
    if (xenUnifiedRegister () == -1) return -1;
288
#endif
289 290 291
#ifdef WITH_QEMU
    if (qemudRegister() == -1) return -1;
#endif
292 293
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
D
Daniel Veillard 已提交
294 295 296
#endif
#ifdef WITH_LXC
    if (lxcRegister() == -1) return -1;
297 298 299
#endif
#ifdef WITH_NETWORK
    if (networkRegister() == -1) return -1;
300
#endif
301
#ifdef WITH_STORAGE_DIR
302
    if (storageRegister() == -1) return -1;
303
#endif
304 305
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
306
#endif
D
Daniel P. Berrange 已提交
307

308 309 310 311 312
    return(0);
}



D
Daniel Veillard 已提交
313 314 315
/**
 * virLibConnError:
 * @conn: the connection if available
316
 * @error: the error number
D
Daniel Veillard 已提交
317 318 319 320 321
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
322 323
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
324
    const char *errmsg;
325

D
Daniel Veillard 已提交
326 327 328
    if (error == VIR_ERR_OK)
        return;

329 330 331
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
332 333 334
}

/**
335
 * virLibConnWarning:
D
Daniel Veillard 已提交
336
 * @conn: the connection if available
337 338 339 340 341 342 343 344 345 346 347 348 349
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibConnWarning(virConnectPtr conn, virErrorNumber error, const char *info)
{
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

350 351 352
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
353 354 355 356 357 358
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
359 360 361 362 363
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
364 365 366
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
367 368
    virConnectPtr conn = NULL;
    const char *errmsg;
369

D
Daniel Veillard 已提交
370 371 372
    if (error == VIR_ERR_OK)
        return;

373
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
374 375 376
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
377 378
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
379 380
}

381
/**
382 383
 * virLibNetworkError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
384
 * @error: the error number
385
 * @info: extra information string
386
 *
387
 * Handle an error at the connection level
388
 */
389 390 391 392 393 394 395 396 397 398
static void
virLibNetworkError(virNetworkPtr network, virErrorNumber error,
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

399
    errmsg = virErrorMsg(error, info);
400 401 402
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
403 404
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
405 406
}

407 408 409
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
410
 * @error: the error number
411 412 413 414 415 416 417 418 419 420 421 422 423 424
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibStoragePoolError(virStoragePoolPtr pool, virErrorNumber error,
                       const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

425
    errmsg = virErrorMsg(error, info);
426 427 428
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

429 430
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
431 432 433 434 435
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
436
 * @error: the error number
437 438 439 440 441 442 443 444 445 446 447 448 449 450
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
virLibStorageVolError(virStorageVolPtr vol, virErrorNumber error,
                      const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

451
    errmsg = virErrorMsg(error, info);
452 453 454
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

455 456
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
457 458
}

459 460 461 462 463 464 465 466 467 468 469
/**
 * 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)
{
470 471 472 473 474
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
475
        return(-1);
476 477 478
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
479 480
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
481 482 483 484
    }

    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
485 486
}

487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
/**
 * 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) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virStorageDriverTabCount >= MAX_DRIVERS) {
507
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
508 509 510 511 512 513 514
        return(-1);
    }

    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

515 516 517 518 519 520 521 522 523 524 525
/**
 * 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)
{
526 527 528 529 530
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
531
        return(-1);
532 533 534
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
535 536
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
537 538
    }

539
    if (driver->no < 0) {
540
        virLibConnError
541 542 543 544 545
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

546 547 548
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

549 550
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
551 552
}

A
Atsushi SAKAI 已提交
553
#ifdef WITH_LIBVIRTD
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
/**
 * 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) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    if (virStateDriverTabCount >= MAX_DRIVERS) {
574
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
575 576 577 578 579 580 581 582 583 584 585 586 587 588
        return(-1);
    }

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

int __virStateInitialize(void) {
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
589 590
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
591 592 593 594 595 596 597 598 599
            ret = -1;
    }
    return ret;
}

int __virStateCleanup(void) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
600 601
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
602 603 604 605 606 607 608 609 610
            ret = -1;
    }
    return ret;
}

int __virStateReload(void) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
611 612
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
613 614 615 616 617 618 619 620 621
            ret = -1;
    }
    return ret;
}

int __virStateActive(void) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
622 623
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
624 625 626 627 628
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
629
#endif
630

631 632


633 634 635
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
636
 * @type: the type of connection/driver looked at
637 638 639 640 641
 * @typeVer: return value for the version of the hypervisor (OUT)
 *
 * Provides two information back, @libVer is the version of the library
 * while @typeVer will be the version of the hypervisor type @type against
 * which the library was compiled. If @type is NULL, "Xen" is assumed, if
D
Daniel Veillard 已提交
642
 * @type is unknown or not available, an error code will be returned and
643 644 645 646 647 648
 * @typeVer will be 0.
 *
 * Returns -1 in case of failure, 0 otherwise, and values for @libVer and
 *       @typeVer have the format major * 1,000,000 + minor * 1,000 + release.
 */
int
649 650 651
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
652
    int i;
653
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
654

655
    if (!initialized)
656
        if (virInitialize() < 0)
657
            return -1;
658

659
    if (libVer == NULL)
660
        return (-1);
661 662 663
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
664
        if (type == NULL)
665 666 667
            type = "Xen";
        for (i = 0;i < virDriverTabCount;i++) {
            if ((virDriverTab[i] != NULL) &&
668
                (STRCASEEQ(virDriverTab[i]->name, type))) {
669 670 671 672
                *typeVer = virDriverTab[i]->ver;
                break;
            }
        }
673
        if (i >= virDriverTabCount) {
674
            *typeVer = 0;
675
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
676 677 678 679
            return (-1);
        }
    }
    return (0);
680 681
}

682
static virConnectPtr
683 684 685
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
686
{
687
    int i, res;
688
    virConnectPtr ret = NULL;
689
    xmlURIPtr uri;
690

691 692 693 694 695 696 697 698
    /*
     *  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) {
699
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
700 701
            name = defname;
        } else {
702 703 704
            const char *use = NULL;
            const char *latest;
            int probes = 0;
D
Daniel Veillard 已提交
705
            for (i = 0; i < virDriverTabCount; i++) {
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
                if ((virDriverTab[i]->probe != NULL) &&
                    ((latest = virDriverTab[i]->probe()) != NULL)) {
                    probes++;

                    DEBUG("Probed %s", latest);
                    /*
                     * if running a xen kernel, give it priority over
                     * QEmu emulation
                     */
                    if (STREQ(latest, "xen:///"))
                        use = latest;
                    else if (use == NULL)
                        use = latest;
                }
            }
            if (use == NULL) {
                name = "xen:///";
                DEBUG("Could not probe any hypervisor defaulting to %s",
                      name);
            } else {
                name = use;
                DEBUG("Using %s as default URI, %d hypervisor found",
                      use, probes);
            }
        }
731
    }
732 733

    /* Convert xen -> xen:/// for back compat */
734
    if (STRCASEEQ(name, "xen"))
735 736
        name = "xen:///";

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

743
    ret = virGetConnect();
744
    if (ret == NULL)
745 746 747 748 749 750
        return NULL;

    uri = xmlParseURI (name);
    if (!uri) {
        virLibConnError (ret, VIR_ERR_INVALID_ARG,
                         _("could not parse connection URI"));
751 752 753
        goto failed;
    }

754 755 756 757 758 759 760 761 762 763 764
    DEBUG("name \"%s\" to URI components:\n"
          "  scheme %s\n"
          "  opaque %s\n"
          "  authority %s\n"
          "  server %s\n"
          "  user %s\n"
          "  port %d\n"
          "  path %s\n",
          name,
          uri->scheme, uri->opaque, uri->authority, uri->server,
          uri->user, uri->port, uri->path);
765

766 767
    ret->name = strdup (name);
    if (!ret->name) {
768
        virLibConnError (ret, VIR_ERR_NO_MEMORY, _("allocating conn->name"));
769 770 771
        goto failed;
    }

772 773 774
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

775
    for (i = 0; i < virDriverTabCount; i++) {
776 777
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
778
        res = virDriverTab[i]->open (ret, uri, auth, flags);
779 780 781 782 783
        DEBUG("driver %d %s returned %s",
              i, virDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
784 785 786 787 788
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
789 790
    }

791
    if (!ret->driver) {
792 793
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
794
        goto failed;
795 796
    }

797
    for (i = 0; i < virNetworkDriverTabCount; i++) {
798
        res = virNetworkDriverTab[i]->open (ret, uri, auth, flags);
799 800 801 802 803
        DEBUG("network driver %d %s returned %s",
              i, virNetworkDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
804
        if (res == VIR_DRV_OPEN_ERROR) {
805
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
806
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
807 808
                                   "Is the daemon running ?");
            }
809 810
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
811 812 813
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
814
    }
815

816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
        res = virStorageDriverTab[i]->open (ret, uri, auth, flags);
#ifdef ENABLE_DEBUG
        DEBUG("storage driver %d %s returned %s",
              i, virStorageDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
#endif
        if (res == VIR_DRV_OPEN_ERROR) {
            if (0 && STREQ(virStorageDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_STORAGE,
                                   "Is the daemon running ?");
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->storageDriver = virStorageDriverTab[i];
            break;
        }
    }

839 840
    xmlFreeURI (uri);

841
    return ret;
842 843

failed:
844
    if (ret->driver) ret->driver->close (ret);
845
    if (uri) xmlFreeURI(uri);
846

847
    /* If no global error was set, copy any error set
848
       in the connection object we're about to dispose of */
849 850
    if (virLastErr.code == VIR_ERR_OK) {
        memcpy(&virLastErr, &ret->err, sizeof(ret->err));
851 852 853 854
        memset(&ret->err, 0, sizeof(ret->err));
    }

    /* Still no error set, then raise a generic error */
855
    if (virLastErr.code == VIR_ERR_OK)
856 857 858 859 860
        virLibConnError (NULL, VIR_ERR_INTERNAL_ERROR,
                         _("unable to open connection"));

    virUnrefConnect(ret);

861
    return NULL;
862 863
}

864 865
/**
 * virConnectOpen:
866
 * @name: URI of the hypervisor
867
 *
868
 * This function should be called first to get a connection to the
869 870 871
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
872 873
 *
 * URIs are documented at http://libvirt.org/uri.html
874 875 876 877
 */
virConnectPtr
virConnectOpen (const char *name)
{
878 879 880 881
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

882
    DEBUG("name=%s", name);
883
    return do_open (name, NULL, 0);
884 885
}

886
/**
887
 * virConnectOpenReadOnly:
888
 * @name: URI of the hypervisor
889
 *
890
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
891
 * library functionalities. The set of APIs usable are then restricted
892
 * on the available methods to control the domains.
893 894
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
895 896
 *
 * URIs are documented at http://libvirt.org/uri.html
897
 */
898
virConnectPtr
899 900
virConnectOpenReadOnly(const char *name)
{
901 902 903 904
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

905
    DEBUG("name=%s", name);
906 907 908 909 910 911 912 913 914
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
915
 * This function should be called first to get a connection to the
916
 * Hypervisor. If necessary, authentication will be performed fetching
917 918 919 920 921 922 923 924 925 926 927
 * credentials via the callback
 *
 * 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)
{
928 929 930 931 932
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

    DEBUG("name=%s, auth=%p, flags=%d", name, auth, flags);
933
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
934 935 936
}

/**
937
 * virConnectClose:
D
Daniel Veillard 已提交
938 939 940 941 942 943 944 945 946 947
 * @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
948 949
virConnectClose(virConnectPtr conn)
{
950 951
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
952
    if (!VIR_IS_CONNECT(conn))
953
        return (-1);
954 955 956

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
957 958
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
959
    conn->driver->close (conn);
960

961
    if (virUnrefConnect(conn) < 0)
962
        return (-1);
963
    return (0);
D
Daniel Veillard 已提交
964 965
}

966 967 968 969 970 971 972 973 974 975 976 977 978 979
/* Not for public use.  This function is part of the internal
 * implementation of driver features in the remote case.
 */
int
__virDrvSupportsFeature (virConnectPtr conn, int feature)
{
    DEBUG("conn=%p, feature=%d", conn, feature);

    if (!VIR_IS_CONNECT(conn))
        return (-1);

    return VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
}

980 981 982 983 984 985 986
/**
 * 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.
987 988 989
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
990 991
 */
const char *
992 993
virConnectGetType(virConnectPtr conn)
{
994
    const char *ret;
995
    DEBUG("conn=%p", conn);
996

D
Daniel Veillard 已提交
997
    if (!VIR_IS_CONNECT(conn)) {
998
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
999
        return (NULL);
D
Daniel Veillard 已提交
1000
    }
1001 1002 1003 1004

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1005
    }
1006
    return conn->driver->name;
1007 1008
}

D
Daniel Veillard 已提交
1009
/**
1010
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1011
 * @conn: pointer to the hypervisor connection
1012
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1013
 *
1014
 * Get the version level of the Hypervisor running. This may work only with
1015
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1016
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1017
 *
1018 1019 1020
 * 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 已提交
1021
 */
1022
int
1023 1024
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1025 1026
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
1027
    if (!VIR_IS_CONNECT(conn)) {
1028
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1029
        return (-1);
D
Daniel Veillard 已提交
1030
    }
1031

D
Daniel Veillard 已提交
1032 1033
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1034
        return (-1);
D
Daniel Veillard 已提交
1035
    }
1036

1037 1038
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
1039

1040 1041
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1042 1043
}

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
/**
 * virConnectGetHostname:
 * @conn: pointer to a hypervisor connection
 *
 * This returns the system hostname on which the hypervisor is
 * running (the result of the gethostname(2) system call).  If
 * 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)
{
1059 1060
    DEBUG("conn=%p", conn);

1061
    if (!VIR_IS_CONNECT(conn)) {
1062
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
        return NULL;
    }

    if (conn->driver->getHostname)
        return conn->driver->getHostname (conn);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
1091 1092
    char *name;

1093 1094
    DEBUG("conn=%p", conn);

1095
    if (!VIR_IS_CONNECT(conn)) {
1096
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1097 1098 1099
        return NULL;
    }

1100 1101 1102
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
1103 1104 1105
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

1106 1107 1108 1109 1110 1111
    name = strdup (conn->name);
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
1112 1113
}

1114 1115 1116 1117 1118
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1119
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1120 1121 1122 1123 1124 1125 1126 1127 1128
 * 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)
{
1129 1130
    DEBUG("conn=%p, type=%s", conn, type);

1131
    if (!VIR_IS_CONNECT(conn)) {
1132
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1133 1134 1135
        return (-1);
    }

1136 1137
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
1138

1139 1140
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1141 1142
}

1143
/**
1144
 * virConnectListDomains:
1145 1146 1147 1148 1149 1150 1151 1152 1153
 * @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
1154 1155
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1156 1157
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
1158
    if (!VIR_IS_CONNECT(conn)) {
1159
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1160
        return (-1);
D
Daniel Veillard 已提交
1161
    }
1162

1163
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1164
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1165
        return (-1);
D
Daniel Veillard 已提交
1166
    }
1167

1168 1169
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
1170

1171 1172
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1173 1174
}

K
 
Karel Zak 已提交
1175 1176 1177 1178
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1179 1180
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1181 1182 1183
 * Returns the number of domain found or -1 in case of error
 */
int
1184 1185
virConnectNumOfDomains(virConnectPtr conn)
{
1186 1187
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
1188
    if (!VIR_IS_CONNECT(conn)) {
1189
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1190
        return (-1);
D
Daniel Veillard 已提交
1191
    }
K
Karel Zak 已提交
1192

1193 1194
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
1195

1196 1197
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
1198 1199
}

1200 1201 1202 1203
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1204
 * Provides the connection pointer associated with a domain.  The
1205 1206 1207
 * reference counter on the connection is not increased by this
 * call.
 *
1208 1209 1210 1211
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1212 1213 1214 1215 1216
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1217 1218
    DEBUG("dom=%p", dom);

1219
    if (!VIR_IS_DOMAIN (dom)) {
1220
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1221 1222 1223 1224 1225
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1226
/**
1227
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1228
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1229
 * @xmlDesc: string containing an XML description of the domain
1230
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1231
 *
1232
 * Launch a new guest domain, based on an XML description similar
1233
 * to the one returned by virDomainGetXMLDesc()
1234
 * This function may requires privileged access to the hypervisor.
1235 1236 1237
 * 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).
1238
 *
D
Daniel Veillard 已提交
1239 1240
 * Returns a new domain object or NULL in case of failure
 */
1241
virDomainPtr
1242 1243
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1244
{
1245 1246
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
1247
    if (!VIR_IS_CONNECT(conn)) {
1248
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1249
        return (NULL);
D
Daniel Veillard 已提交
1250 1251 1252
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1253
        return (NULL);
D
Daniel Veillard 已提交
1254
    }
1255 1256
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1257
        return (NULL);
1258
    }
D
Daniel Veillard 已提交
1259

1260 1261
    if (conn->driver->domainCreateXML)
        return conn->driver->domainCreateXML (conn, xmlDesc, flags);
1262 1263 1264

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
D
Daniel Veillard 已提交
1265 1266
}

1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
/**
 * 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.
 * This existing name will left indefinitely for API compatability.
 *
 * Returns a new domain object or NULL in case of failure
 */
virDomainPtr
virDomainCreateLinux(virConnectPtr conn, const char *xmlDesc,
                     unsigned int flags)
{
    return(virDomainCreateXML(conn, xmlDesc, flags));
}
1285

1286
/**
1287
 * virDomainLookupByID:
1288 1289 1290 1291
 * @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 已提交
1292 1293
 * 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.
1294
 *
1295 1296
 * 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.
1297
 */
1298
virDomainPtr
1299 1300
virDomainLookupByID(virConnectPtr conn, int id)
{
1301 1302
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
1303
    if (!VIR_IS_CONNECT(conn)) {
1304
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1305
        return (NULL);
D
Daniel Veillard 已提交
1306 1307 1308
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1309
        return (NULL);
D
Daniel Veillard 已提交
1310
    }
1311

1312 1313
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1314

1315 1316
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1317 1318 1319 1320 1321
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1322
 * @uuid: the raw UUID for the domain
1323 1324 1325
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1326 1327
 * 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.
1328 1329
 */
virDomainPtr
1330 1331
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1332 1333
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
1334
    if (!VIR_IS_CONNECT(conn)) {
1335
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1336
        return (NULL);
D
Daniel Veillard 已提交
1337 1338 1339
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1340
        return (NULL);
D
Daniel Veillard 已提交
1341
    }
1342

1343 1344
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1345

1346 1347
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1348 1349
}

K
Karel Zak 已提交
1350 1351 1352 1353 1354 1355 1356
/**
 * 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.
 *
1357 1358
 * 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 已提交
1359 1360 1361 1362
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1363 1364
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1365 1366
    int ret;

1367 1368
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1369
    if (!VIR_IS_CONNECT(conn)) {
1370
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1371 1372 1373 1374 1375
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
1376

K
Karel Zak 已提交
1377
    }
1378 1379
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
     */
    ret = sscanf(uuidstr,
                 "%02x%02x%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x%02x%02x%02x%02x",
                 raw + 0, raw + 1, raw + 2, raw + 3,
                 raw + 4, raw + 5, raw + 6, raw + 7,
                 raw + 8, raw + 9, raw + 10, raw + 11,
                 raw + 12, raw + 13, raw + 14, raw + 15);
1391

1392
    if (ret!=VIR_UUID_BUFLEN) {
1393 1394
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
K
Karel Zak 已提交
1395
    }
1396
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1397
        uuid[i] = raw[i] & 0xFF;
1398

K
Karel Zak 已提交
1399 1400 1401
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1402 1403 1404 1405 1406
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1407
 * Try to lookup a domain on the given hypervisor based on its name.
1408
 *
1409 1410
 * 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.
1411 1412
 */
virDomainPtr
1413 1414
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1415 1416
    DEBUG("conn=%p, name=%s", conn, name);

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

1426 1427 1428 1429 1430
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1431 1432
}

D
Daniel Veillard 已提交
1433
/**
1434
 * virDomainDestroy:
D
Daniel Veillard 已提交
1435 1436 1437
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1438 1439 1440
 * 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 已提交
1441 1442
 *
 * Returns 0 in case of success and -1 in case of failure.
1443
 */
D
Daniel Veillard 已提交
1444
int
1445 1446
virDomainDestroy(virDomainPtr domain)
{
1447
    virConnectPtr conn;
1448

1449 1450
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1451
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1452
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1453
        return (-1);
D
Daniel Veillard 已提交
1454
    }
1455

1456
    conn = domain->conn;
1457 1458
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1459
        return (-1);
1460
    }
1461

1462 1463
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1464

1465 1466
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478
}

/**
 * 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
1479 1480
virDomainFree(virDomainPtr domain)
{
1481 1482
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1483
    if (!VIR_IS_DOMAIN(domain)) {
1484
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1485
        return (-1);
D
Daniel Veillard 已提交
1486
    }
1487
    if (virUnrefDomain(domain) < 0)
1488 1489
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1490 1491 1492
}

/**
1493
 * virDomainSuspend:
D
Daniel Veillard 已提交
1494 1495 1496
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1497
 * to CPU resources and I/O but the memory used by the domain at the
1498
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1499
 * the domain.
1500
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1501 1502 1503 1504
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1505 1506
virDomainSuspend(virDomainPtr domain)
{
1507
    virConnectPtr conn;
1508
    DEBUG("domain=%p", domain);
1509

D
Daniel Veillard 已提交
1510
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1511
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1512
        return (-1);
D
Daniel Veillard 已提交
1513
    }
1514 1515
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1516
        return (-1);
1517
    }
D
Daniel Veillard 已提交
1518

1519 1520
    conn = domain->conn;

1521 1522
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1523

1524 1525
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1526 1527 1528
}

/**
1529
 * virDomainResume:
D
Daniel Veillard 已提交
1530 1531 1532
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1533
 * it was frozen by calling virSuspendDomain().
1534
 * This function may requires privileged access
D
Daniel Veillard 已提交
1535 1536 1537 1538
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1539 1540
virDomainResume(virDomainPtr domain)
{
1541
    virConnectPtr conn;
1542
    DEBUG("domain=%p", domain);
1543

D
Daniel Veillard 已提交
1544
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1545
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1546
        return (-1);
D
Daniel Veillard 已提交
1547
    }
1548 1549
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1550
        return (-1);
1551
    }
D
Daniel Veillard 已提交
1552

1553 1554
    conn = domain->conn;

1555 1556
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1557

1558 1559
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1560 1561
}

1562 1563 1564 1565 1566 1567
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1568 1569 1570
 * 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.
1571 1572 1573 1574
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1575 1576
virDomainSave(virDomainPtr domain, const char *to)
{
1577
    char filepath[4096];
1578
    virConnectPtr conn;
1579
    DEBUG("domain=%p, to=%s", domain, to);
1580

D
Daniel Veillard 已提交
1581
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1582
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1583
        return (-1);
D
Daniel Veillard 已提交
1584
    }
1585 1586
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1587
        return (-1);
1588
    }
1589
    conn = domain->conn;
D
Daniel Veillard 已提交
1590 1591
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1592
        return (-1);
D
Daniel Veillard 已提交
1593
    }
1594

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

1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
        t = strlen(to);
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL)
            return (-1);
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
        if (len > sizeof(filepath) - (t + 3))
            return (-1);
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];
1612 1613 1614

    }

1615 1616 1617
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1618
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1619
    return -1;
1620 1621 1622 1623
}

/**
 * virDomainRestore:
1624
 * @conn: pointer to the hypervisor connection
1625
 * @from: path to the
1626 1627 1628 1629 1630 1631
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1632 1633
virDomainRestore(virConnectPtr conn, const char *from)
{
1634
    char filepath[4096];
1635
    DEBUG("conn=%p, from=%s", conn, from);
1636

D
Daniel Veillard 已提交
1637
    if (!VIR_IS_CONNECT(conn)) {
1638
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1639
        return (-1);
D
Daniel Veillard 已提交
1640
    }
1641 1642
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1643
        return (-1);
1644
    }
D
Daniel Veillard 已提交
1645 1646
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1647
        return (-1);
D
Daniel Veillard 已提交
1648 1649
    }

1650 1651 1652 1653 1654
    /*
     * We must absolutize the file path as the restore is done out of process
     * TODO: check for URI when libxml2 is linked in.
     */
    if (from[0] != '/') {
1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668
        unsigned int len, t;

        t = strlen(from);
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL)
            return (-1);
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
        if (len > sizeof(filepath) - (t + 3))
            return (-1);
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

1669 1670 1671
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1672
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1673
    return -1;
D
Daniel Veillard 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
}

/**
 * virDomainCoreDump:
 * @domain: a domain object
 * @to: path for the core file
 * @flags: extra flags, currently unused
 *
 * This method will dump the core of a domain on a given file for analysis.
 * Note that for remote Xen Daemon the file path will be interpreted in
 * the remote host.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainCoreDump(virDomainPtr domain, const char *to, int flags)
{
    char filepath[4096];
    virConnectPtr conn;
1693
    DEBUG("domain=%p, to=%s, flags=%d", domain, to, flags);
D
Daniel Veillard 已提交
1694 1695

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1696
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1697 1698 1699 1700
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1701
        return (-1);
D
Daniel Veillard 已提交
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

        t = strlen(to);
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL)
            return (-1);
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
        if (len > sizeof(filepath) - (t + 3))
            return (-1);
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

1729 1730 1731
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1732
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1733
    return -1;
1734 1735
}

1736 1737 1738 1739 1740
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1741 1742
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1743 1744 1745 1746 1747 1748 1749
 *
 * 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
1750 1751
virDomainShutdown(virDomainPtr domain)
{
1752
    virConnectPtr conn;
1753
    DEBUG("domain=%p", domain);
1754

D
Daniel Veillard 已提交
1755
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1756
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1757
        return (-1);
D
Daniel Veillard 已提交
1758
    }
1759 1760
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1761
        return (-1);
1762
    }
1763

1764 1765
    conn = domain->conn;

1766 1767
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1768

1769
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1770
    return -1;
1771 1772
}

1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
/**
 * 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)
{
1787
    virConnectPtr conn;
1788
    DEBUG("domain=%p, flags=%u", domain, flags);
1789 1790

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1791
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1792 1793
        return (-1);
    }
1794 1795
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1796
        return (-1);
1797
    }
1798

1799 1800
    conn = domain->conn;

1801 1802
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1803

1804
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1805
    return -1;
1806 1807
}

1808
/**
1809
 * virDomainGetName:
1810 1811 1812 1813 1814 1815 1816 1817
 * @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 *
1818 1819
virDomainGetName(virDomainPtr domain)
{
1820 1821
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1822
    if (!VIR_IS_DOMAIN(domain)) {
1823
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1824
        return (NULL);
D
Daniel Veillard 已提交
1825
    }
1826
    return (domain->name);
1827 1828
}

1829 1830 1831
/**
 * virDomainGetUUID:
 * @domain: a domain object
1832
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1833 1834 1835 1836 1837 1838
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1839 1840
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1841 1842
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1843
    if (!VIR_IS_DOMAIN(domain)) {
1844
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1845
        return (-1);
D
Daniel Veillard 已提交
1846 1847 1848
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1849
        return (-1);
D
Daniel Veillard 已提交
1850 1851
    }

1852 1853
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

1854
    return (0);
1855 1856
}

K
Karel Zak 已提交
1857 1858 1859
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1860
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1861
 *
1862
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
1863 1864 1865 1866 1867 1868 1869
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
1870
    unsigned char uuid[VIR_UUID_BUFLEN];
1871
    DEBUG("domain=%p, buf=%p", domain, buf);
1872

K
Karel Zak 已提交
1873
    if (!VIR_IS_DOMAIN(domain)) {
1874
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1875 1876 1877 1878 1879 1880
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1881

K
Karel Zak 已提交
1882
    if (virDomainGetUUID(domain, &uuid[0]))
1883
        return (-1);
K
Karel Zak 已提交
1884

1885
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1886 1887 1888
    return (0);
}

1889
/**
1890
 * virDomainGetID:
1891 1892 1893 1894 1895 1896 1897
 * @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
1898 1899
virDomainGetID(virDomainPtr domain)
{
1900 1901
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1902
    if (!VIR_IS_DOMAIN(domain)) {
1903
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1904
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1905
    }
1906
    return (domain->id);
1907 1908
}

1909 1910 1911 1912 1913 1914
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1915 1916
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1917 1918
 */
char *
1919 1920
virDomainGetOSType(virDomainPtr domain)
{
1921
    virConnectPtr conn;
1922
    DEBUG("domain=%p", domain);
1923

D
Daniel Veillard 已提交
1924
    if (!VIR_IS_DOMAIN(domain)) {
1925
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1926
        return (NULL);
D
Daniel Veillard 已提交
1927
    }
1928

1929 1930 1931 1932
    conn = domain->conn;

    if (conn->driver->domainGetOSType)
        return conn->driver->domainGetOSType (domain);
1933

1934
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1935
    return NULL;
1936 1937
}

1938
/**
1939
 * virDomainGetMaxMemory:
1940
 * @domain: a domain object or NULL
1941
 *
1942 1943 1944 1945 1946 1947 1948
 * 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
1949 1950
virDomainGetMaxMemory(virDomainPtr domain)
{
1951
    virConnectPtr conn;
1952
    DEBUG("domain=%p", domain);
1953

D
Daniel Veillard 已提交
1954
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1955
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1956
        return (0);
D
Daniel Veillard 已提交
1957
    }
1958

1959 1960
    conn = domain->conn;

1961 1962 1963
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

1964
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1965
    return 0;
1966 1967
}

D
Daniel Veillard 已提交
1968
/**
1969
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1970 1971
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
1972
 *
D
Daniel Veillard 已提交
1973 1974 1975
 * 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.
1976
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
1977 1978 1979 1980
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1981 1982
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1983
    virConnectPtr conn;
1984
    DEBUG("domain=%p, memory=%lu", domain, memory);
1985

1986 1987
    if (domain == NULL) {
        TODO
1988
        return (-1);
1989 1990
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1991
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1992
        return (-1);
1993
    }
1994 1995
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1996
        return (-1);
1997 1998 1999 2000 2001
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2002
    conn = domain->conn;
2003

2004 2005 2006
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

2007
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2008
    return -1;
2009
}
2010

2011 2012 2013 2014
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2015
 *
2016 2017 2018
 * 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.
2019
 * This function may requires privileged access to the hypervisor.
2020 2021 2022 2023 2024 2025 2026
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2027
    DEBUG("domain=%p, memory=%lu", domain, memory);
2028

2029 2030
    if (domain == NULL) {
        TODO
2031
        return (-1);
2032 2033
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2034
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2035
        return (-1);
2036
    }
2037 2038
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2039
        return (-1);
2040 2041 2042
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2043
        return (-1);
2044 2045 2046
    }

    conn = domain->conn;
2047

2048 2049 2050
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

2051
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2052
    return -1;
D
Daniel Veillard 已提交
2053 2054
}

2055 2056
/**
 * virDomainGetInfo:
2057
 * @domain: a domain object
2058
 * @info: pointer to a virDomainInfo structure allocated by the user
2059
 *
2060
 * Extract information about a domain. Note that if the connection
2061
 * used to get the domain is limited only a partial set of the information
2062 2063 2064 2065 2066
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2067 2068
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2069
    virConnectPtr conn;
2070
    DEBUG("domain=%p, info=%p", domain, info);
2071

D
Daniel Veillard 已提交
2072
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2073
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2074
        return (-1);
D
Daniel Veillard 已提交
2075 2076 2077
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2078
        return (-1);
D
Daniel Veillard 已提交
2079
    }
2080

2081
    memset(info, 0, sizeof(virDomainInfo));
2082

2083 2084 2085 2086
    conn = domain->conn;

    if (conn->driver->domainGetInfo)
        return conn->driver->domainGetInfo (domain, info);
2087

2088
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2089
    return -1;
2090
}
2091

2092 2093 2094
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2095
 * @flags: an OR'ed set of virDomainXMLFlags
2096 2097
 *
 * Provide an XML description of the domain. The description may be reused
2098
 * later to relaunch the domain with virDomainCreateXML().
2099 2100 2101 2102 2103
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2104 2105
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2106
    virConnectPtr conn;
2107
    DEBUG("domain=%p, flags=%d", domain, flags);
2108

D
Daniel Veillard 已提交
2109
    if (!VIR_IS_DOMAIN(domain)) {
2110
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2111
        return (NULL);
D
Daniel Veillard 已提交
2112
    }
2113

2114 2115 2116 2117 2118
    conn = domain->conn;

    if (conn->driver->domainDumpXML)
        return conn->driver->domainDumpXML (domain, flags);

2119
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2120
    return NULL;
2121
}
2122

2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187
/**
 * 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:
 *   VIR_MIGRATE_LIVE   Attempt a live migration.
 *
 * 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.
 *
 * Since typically the two hypervisors connect directly to each
 * other in order to perform the migration, you may need to specify
 * a path from the source to the destination.  This is the purpose
 * of the uri parameter.  If uri is NULL, then libvirt will try to
 * find the best method.  Uri may specify the hostname or IP address
 * of the destination host as seen from the source.  Or uri may be
 * a URI giving transport, hostname, user, port, etc. in the usual
 * form.  Refer to driver documentation for the particular URIs
 * supported.
 *
 * 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)
{
    virConnectPtr conn;
    virDomainPtr ddomain = NULL;
    char *uri_out = NULL;
    char *cookie = NULL;
    int cookielen = 0, ret;
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
2188
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    /* Check that migration is supported by both drivers. */
    if (!VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn,
                                   VIR_DRV_FEATURE_MIGRATION_V1) ||
        !VIR_DRV_SUPPORTS_FEATURE (dconn->driver, dconn,
                                   VIR_DRV_FEATURE_MIGRATION_V1)) {
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
        return NULL;
    }

    /* 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.
     */
    ret = dconn->driver->domainMigratePrepare
        (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname, bandwidth);
    if (ret == -1) goto done;
    if (uri == NULL && uri_out == NULL) {
        virLibConnError (conn, VIR_ERR_INTERNAL_ERROR,
2222
                         _("domainMigratePrepare did not set uri"));
2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248
        goto done;
    }
    if (uri_out) uri = uri_out; /* Did domainMigratePrepare change URI? */

    assert (uri != NULL);

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

    if (ret == -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:
2249 2250
    free (uri_out);
    free (cookie);
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269
    return ddomain;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
__virDomainMigratePrepare (virConnectPtr dconn,
                           char **cookie,
                           int *cookielen,
                           const char *uri_in,
                           char **uri_out,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, flags=%lu, dname=%s, bandwidth=%lu", dconn, cookie, cookielen, uri_in, uri_out, flags, dname, bandwidth);

    if (!VIR_IS_CONNECT (dconn)) {
2270
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298
        return -1;
    }

    if (dconn->driver->domainMigratePrepare)
        return dconn->driver->domainMigratePrepare (dconn, cookie, cookielen,
                                                    uri_in, uri_out,
                                                    flags, dname, bandwidth);

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
__virDomainMigratePerform (virDomainPtr domain,
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
    DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags, dname, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
2299
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326
        return -1;
    }
    conn = domain->conn;

    if (conn->driver->domainMigratePerform)
        return conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                   uri,
                                                   flags, dname, bandwidth);

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
virDomainPtr
__virDomainMigrateFinish (virConnectPtr dconn,
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
    DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, flags=%lu", dconn, dname, cookie, cookielen, uri, flags);

    if (!VIR_IS_CONNECT (dconn)) {
2327
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
        return NULL;
    }

    if (dconn->driver->domainMigrateFinish)
        return dconn->driver->domainMigrateFinish (dconn, dname,
                                                   cookie, cookielen,
                                                   uri, flags);

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}


2341 2342 2343 2344
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
2345
 *
2346 2347 2348 2349 2350
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2351 2352
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2353 2354
    DEBUG("conn=%p, info=%p", conn, info);

2355
    if (!VIR_IS_CONNECT(conn)) {
2356
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2357 2358 2359 2360 2361 2362 2363
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2364 2365 2366
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2367
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2368
    return -1;
2369
}
2370

2371 2372 2373 2374 2375 2376
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2377 2378
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2379 2380 2381 2382 2383
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2384 2385
    DEBUG("conn=%p", conn);

2386
    if (!VIR_IS_CONNECT (conn)) {
2387
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2388 2389 2390
        return NULL;
    }

2391 2392
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2393

2394
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2395 2396 2397
    return NULL;
}

2398 2399 2400
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
2401
 *
D
Daniel Veillard 已提交
2402
 * provides the free memory available on the Node
2403 2404 2405 2406 2407 2408
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
2409 2410
    DEBUG("conn=%p", conn);

2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

    if (conn->driver->getFreeMemory)
        return conn->driver->getFreeMemory (conn);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return 0;
}

2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436
/**
 * 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;
2437
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2438 2439

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2440
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2441 2442 2443 2444 2445 2446 2447 2448 2449
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
        return schedtype;
    }

2450
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470
    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,
2471
                                virSchedParameterPtr params, int *nparams)
2472 2473
{
    virConnectPtr conn;
2474
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2475 2476

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2477
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2478 2479 2480 2481 2482 2483 2484
        return -1;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerParameters)
        return conn->driver->domainGetSchedulerParameters (domain, params, nparams);

2485
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
    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
2502
virDomainSetSchedulerParameters(virDomainPtr domain,
2503
                                virSchedParameterPtr params, int nparams)
2504 2505
{
    virConnectPtr conn;
2506
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2507 2508

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

    if (conn->driver->domainSetSchedulerParameters)
        return conn->driver->domainSetSchedulerParameters (domain, params, nparams);

2521
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2522 2523 2524 2525
    return -1;
}


2526
/**
2527
 * virDomainBlockStats:
2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561
 * @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 };
    DEBUG("domain=%p, path=%s, stats=%p, size=%zi", dom, path, stats, size);

    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
2562
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579
        return -1;
    }
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
            return -1;

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

/**
2580
 * virDomainInterfaceStats:
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613
 * @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.
 *
 * Domains may have more than network interface.  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
virDomainInterfaceStats (virDomainPtr dom, const char *path,
                         virDomainInterfaceStatsPtr stats, size_t size)
{
    virConnectPtr conn;
    struct _virDomainInterfaceStats stats2 = { -1, -1, -1, -1,
                                               -1, -1, -1, -1 };
    DEBUG("domain=%p, path=%s, stats=%p, size=%zi", dom, path, stats, size);

    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
2614
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630
        return -1;
    }
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
            return -1;

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

R
Richard W.M. Jones 已提交
2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663
/**
 * 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 已提交
2664 2665 2666 2667
 * 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 已提交
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686
 * 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;
    DEBUG("domain=%p, path=%s, offset=%lld, size=%zi, buffer=%p",
          dom, path, offset, size, buffer);

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
2687

R
Richard W.M. Jones 已提交
2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
        return -1;
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
        return -1;
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("buffer is NULL"));
        return -1;
    }

    if (conn->driver->domainBlockPeek)
2708 2709
        return conn->driver->domainBlockPeek (dom, path, offset, size,
                                              buffer, flags);
R
Richard W.M. Jones 已提交
2710 2711 2712 2713

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}
2714

R
Richard W.M. Jones 已提交
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
/**
 * 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;
    DEBUG ("domain=%p, start=%lld, size=%zi, buffer=%p, flags=%d",
           dom, start, size, buffer, flags);

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

    /* Flags must be VIR_MEMORY_VIRTUAL at the moment.
     *
     * Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
     * 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.
     *
     * The QEMU driver handles only VIR_MEMORY_VIRTUAL, mapping it
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
     * 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.
     */
    if (flags != VIR_MEMORY_VIRTUAL) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags parameter must be VIR_MEMORY_VIRTUAL"));
        return -1;
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("buffer is NULL but size is non-zero"));
        return -1;
    }

    if (conn->driver->domainMemoryPeek)
        return conn->driver->domainMemoryPeek (dom, start, size,
                                               buffer, flags);

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

2805

2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
/************************************************************************
 *									*
 *		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
 *
2817 2818 2819
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
 * virDomainUndefine().
2820 2821 2822 2823 2824
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
2825 2826
    DEBUG("conn=%p, xml=%s", conn, xml);

2827
    if (!VIR_IS_CONNECT(conn)) {
2828
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2829 2830
        return (NULL);
    }
2831 2832
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2833
        return (NULL);
2834
    }
2835 2836 2837 2838 2839
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2840 2841
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
2842

2843
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2844
    return NULL;
2845 2846 2847 2848 2849 2850
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
2851
 * Undefine a domain but does not stop it if it is running
2852 2853 2854 2855 2856
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
2857
    virConnectPtr conn;
2858
    DEBUG("domain=%p", domain);
2859 2860

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2861
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2862 2863
        return (-1);
    }
2864 2865
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2866
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2867
        return (-1);
2868 2869
    }

2870 2871
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
2872

2873
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2874
    return -1;
2875 2876 2877 2878 2879 2880
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
2881
 * Provides the number of defined but inactive domains.
2882 2883 2884 2885 2886 2887
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
2888 2889
    DEBUG("conn=%p", conn);

2890
    if (!VIR_IS_CONNECT(conn)) {
2891
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2892 2893 2894
        return (-1);
    }

2895 2896
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
2897

2898
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2899
    return -1;
2900 2901 2902 2903 2904 2905 2906 2907
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
2908 2909
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
2910
 *
2911 2912 2913
 * Returns the number of names provided in the array or -1 in case of error
 */
int
2914
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
2915
                             int maxnames) {
2916 2917
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2918
    if (!VIR_IS_CONNECT(conn)) {
2919
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2920 2921 2922
        return (-1);
    }

2923
    if ((names == NULL) || (maxnames < 0)) {
2924 2925 2926 2927
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2928 2929
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
2930

2931
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2932
    return -1;
2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945
}

/**
 * virDomainCreate:
 * @domain: pointer to a defined domain
 *
 * launch a defined domain. If the call succeed the domain moves from the
 * defined to the running domains pools.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainCreate(virDomainPtr domain) {
2946
    virConnectPtr conn;
2947
    DEBUG("domain=%p", domain);
2948

2949 2950
    if (domain == NULL) {
        TODO
2951
        return (-1);
2952
    }
2953
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2954
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2955 2956
        return (-1);
    }
2957 2958
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2959
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2960
        return (-1);
2961
    }
2962

2963 2964 2965
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

2966
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2967
    return -1;
2968 2969
}

2970 2971 2972
/**
 * virDomainGetAutostart:
 * @domain: a domain object
2973
 * @autostart: the value returned
2974
 *
2975
 * Provides a boolean value indicating whether the domain
2976 2977 2978 2979 2980 2981 2982
 * 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,
2983 2984 2985
                      int *autostart)
{
    virConnectPtr conn;
2986
    DEBUG("domain=%p, autostart=%p", domain, autostart);
2987 2988

    if (!VIR_IS_DOMAIN(domain)) {
2989
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2990 2991 2992 2993 2994 2995 2996
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2997 2998 2999 3000 3001
    conn = domain->conn;

    if (conn->driver->domainGetAutostart)
        return conn->driver->domainGetAutostart (domain, autostart);

3002
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3003
    return -1;
3004 3005 3006 3007 3008
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3009
 * @autostart: whether the domain should be automatically started 0 or 1
3010 3011 3012 3013 3014 3015 3016 3017
 *
 * 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,
3018 3019 3020
                      int autostart)
{
    virConnectPtr conn;
3021
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3022 3023

    if (!VIR_IS_DOMAIN(domain)) {
3024
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3025 3026 3027
        return (-1);
    }

3028 3029 3030 3031 3032
    conn = domain->conn;

    if (conn->driver->domainSetAutostart)
        return conn->driver->domainSetAutostart (domain, autostart);

3033
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3034
    return -1;
3035 3036
}

3037 3038 3039 3040 3041 3042 3043 3044
/**
 * 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.
3045
 * This function requires privileged access to the hypervisor.
3046 3047 3048 3049 3050 3051 3052
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3053
    virConnectPtr conn;
3054
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3055

3056 3057
    if (domain == NULL) {
        TODO
3058
        return (-1);
3059 3060
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3061
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3062 3063
        return (-1);
    }
3064 3065
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3066
        return (-1);
3067
    }
3068

3069 3070 3071 3072
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3073
    conn = domain->conn;
3074

3075 3076
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
3077

3078
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3079
    return -1;
3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093
}

/**
 * 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)
 * 	Each bit set to 1 means that corresponding CPU is usable.
 * 	Bytes are stored in little-endian order: CPU0-7, 8-15...
 * 	In each byte, lowest CPU number is least significant bit.
 * @maplen: number of bytes in cpumap, from 1 up to size of CPU map in
 *	underlying virtualization system (Xen...).
 *	If maplen < size, missing bytes are set to zero.
 *	If maplen > size, failure code is returned.
3094
 *
3095
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
3096
 * This function requires privileged access to the hypervisor.
3097 3098 3099 3100 3101 3102 3103
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
3104
    virConnectPtr conn;
3105
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
3106

3107 3108
    if (domain == NULL) {
        TODO
3109
        return (-1);
3110 3111
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3112
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3113 3114
        return (-1);
    }
3115 3116
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3117
        return (-1);
3118
    }
3119

3120
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
3121 3122 3123
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3124

3125 3126
    conn = domain->conn;

3127 3128 3129
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

3130
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3131
    return -1;
3132 3133 3134 3135 3136 3137 3138 3139 3140
}

/**
 * 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
 * @cpumaps: pointer to an bit map of real CPUs for all vcpus of this
 *      domain (in 8-bit bytes) (OUT)
D
Daniel Veillard 已提交
3141
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
3142 3143 3144 3145 3146 3147 3148
 *	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...).
3149
 *
3150
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
3151
 * and also in cpumaps if this pointer isn't NULL.
3152 3153 3154 3155 3156
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
3157
                  unsigned char *cpumaps, int maplen)
3158
{
3159
    virConnectPtr conn;
3160
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
3161 3162 3163

    if (domain == NULL) {
        TODO
3164
        return (-1);
3165 3166
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3167
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3178

3179 3180
    conn = domain->conn;

3181 3182 3183 3184
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

3185
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3186
    return -1;
3187
}
3188

3189 3190 3191
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
3192
 *
3193 3194 3195 3196 3197
 * Provides the maximum number of virtual CPUs supported for
 * the guest VM. If the guest is inactive, this is basically
 * the same as virConnectGetMaxVcpus. If the guest is running
 * this will reflect the maximum number of virtual CPUs the
 * guest was booted with.
3198 3199 3200 3201
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
3202 3203
virDomainGetMaxVcpus(virDomainPtr domain)
{
3204
    virConnectPtr conn;
3205
    DEBUG("domain=%p", domain);
3206 3207

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3208
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3209 3210 3211 3212 3213
        return (-1);
    }

    conn = domain->conn;

3214 3215 3216
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

3217
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3218
    return -1;
3219 3220 3221
}


3222 3223 3224 3225
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3226
 *
3227 3228 3229 3230 3231
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3232
virDomainAttachDevice(virDomainPtr domain, const char *xml)
3233 3234
{
    virConnectPtr conn;
3235
    DEBUG("domain=%p, xml=%s", domain, xml);
3236 3237

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3238
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3239 3240 3241 3242
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3243
        return (-1);
3244 3245 3246
    }
    conn = domain->conn;

3247 3248 3249
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

3250
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3251
    return -1;
3252 3253 3254 3255 3256 3257
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3258
 *
3259 3260 3261 3262 3263
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3264
virDomainDetachDevice(virDomainPtr domain, const char *xml)
3265 3266
{
    virConnectPtr conn;
3267
    DEBUG("domain=%p, xml=%s", domain, xml);
3268 3269

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3270
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3271 3272 3273 3274
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3275
        return (-1);
3276 3277 3278
    }
    conn = domain->conn;

3279 3280 3281
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

3282
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3283
    return -1;
3284
}
3285

3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307
/**
 * 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
 * with the amount of free memory in kilobytes for each cell requested,
 * 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)
{
3308 3309 3310
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

3311 3312 3313 3314 3315
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
3316
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (conn->driver->nodeGetCellsFreeMemory)
        return conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}

3328 3329 3330 3331
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
3332
 * Provides the connection pointer associated with a network.  The
3333 3334 3335
 * reference counter on the connection is not increased by this
 * call.
 *
3336 3337 3338 3339
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
3340 3341 3342 3343 3344
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
3345 3346
    DEBUG("net=%p", net);

3347
    if (!VIR_IS_NETWORK (net)) {
3348
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3349 3350 3351 3352 3353
        return NULL;
    }
    return net->conn;
}

3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364
/**
 * 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)
{
3365 3366
    DEBUG("conn=%p", conn);

3367
    if (!VIR_IS_CONNECT(conn)) {
3368
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3369 3370 3371
        return (-1);
    }

3372 3373
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
3374

3375
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3376
    return -1;
3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389
}

/**
 * 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
3390
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
3391
{
3392 3393
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3394
    if (!VIR_IS_CONNECT(conn)) {
3395
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3396 3397 3398
        return (-1);
    }

3399
    if ((names == NULL) || (maxnames < 0)) {
3400 3401 3402 3403
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3404 3405
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
3406

3407
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3408
    return -1;
3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421
}

/**
 * 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)
{
3422 3423
    DEBUG("conn=%p", conn);

3424
    if (!VIR_IS_CONNECT(conn)) {
3425
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3426 3427 3428
        return (-1);
    }

3429 3430
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
3431

3432
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3433
    return -1;
3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446
}

/**
 * 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
3447
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
3448 3449
                              int maxnames)
{
3450 3451
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3452
    if (!VIR_IS_CONNECT(conn)) {
3453
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3454 3455 3456
        return (-1);
    }

3457
    if ((names == NULL) || (maxnames < 0)) {
3458 3459 3460 3461
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3462 3463 3464
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
3465

3466
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3467
    return -1;
3468 3469 3470 3471 3472 3473 3474 3475 3476
}

/**
 * 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.
 *
3477 3478
 * 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.
3479 3480 3481 3482
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3483 3484
    DEBUG("conn=%p, name=%s", conn, name);

3485
    if (!VIR_IS_CONNECT(conn)) {
3486
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3487 3488 3489 3490 3491 3492 3493
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3494 3495 3496
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

3497
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3498
    return NULL;
3499 3500 3501 3502 3503 3504 3505 3506 3507
}

/**
 * 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.
 *
3508 3509
 * 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.
3510 3511 3512 3513
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3514 3515
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3516
    if (!VIR_IS_CONNECT(conn)) {
3517
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3518 3519 3520 3521 3522 3523 3524
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3525 3526
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3527

3528
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3529
    return NULL;
3530 3531 3532 3533 3534 3535 3536 3537 3538
}

/**
 * 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.
 *
3539 3540
 * 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.
3541 3542 3543 3544 3545 3546 3547
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3548
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3549 3550

    if (!VIR_IS_CONNECT(conn)) {
3551
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
     */
    ret = sscanf(uuidstr,
                 "%02x%02x%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x-"
                 "%02x%02x%02x%02x%02x%02x",
                 raw + 0, raw + 1, raw + 2, raw + 3,
                 raw + 4, raw + 5, raw + 6, raw + 7,
                 raw + 8, raw + 9, raw + 10, raw + 11,
                 raw + 12, raw + 13, raw + 14, raw + 15);

    if (ret!=VIR_UUID_BUFLEN) {
3574 3575
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

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

/**
 * 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)
{
3596 3597
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3598
    if (!VIR_IS_CONNECT(conn)) {
3599
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3600 3601 3602 3603 3604 3605 3606 3607
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3608
        return (NULL);
3609 3610
    }

3611 3612 3613
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3614
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3615
    return NULL;
3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627
}

/**
 * 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
3628 3629
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3630 3631
    DEBUG("conn=%p, xml=%s", conn, xml);

3632
    if (!VIR_IS_CONNECT(conn)) {
3633
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3634 3635 3636 3637
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3638
        return (NULL);
3639 3640 3641 3642 3643 3644
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3645 3646
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3647

3648
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3649
    return NULL;
3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662
}

/**
 * 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;
3663
    DEBUG("network=%p", network);
3664 3665

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3666
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3667 3668 3669 3670 3671
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3672
        return (-1);
3673 3674
    }

3675 3676
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3677

3678
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3679
    return -1;
3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691
}

/**
 * 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
3692 3693
virNetworkCreate(virNetworkPtr network)
{
3694
    virConnectPtr conn;
3695 3696
    DEBUG("network=%p", network);

3697 3698
    if (network == NULL) {
        TODO
3699
        return (-1);
3700 3701
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3702
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3703 3704 3705 3706 3707
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3708
        return (-1);
3709 3710
    }

3711 3712 3713
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3714
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3715
    return -1;
3716 3717 3718 3719 3720 3721 3722
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
3723 3724 3725
 * 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
3726 3727 3728 3729 3730 3731 3732
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
3733
    DEBUG("network=%p", network);
3734 3735

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3736
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3737 3738 3739 3740 3741 3742
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3743
        return (-1);
3744 3745
    }

3746 3747
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3748

3749
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3750
    return -1;
3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764
}

/**
 * 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)
{
3765 3766
    DEBUG("network=%p", network);

3767
    if (!VIR_IS_NETWORK(network)) {
3768
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3769 3770
        return (-1);
    }
3771
    if (virUnrefNetwork(network) < 0)
3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787
        return (-1);
    return(0);
}

/**
 * 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)
{
3788 3789
    DEBUG("network=%p", network);

3790
    if (!VIR_IS_NETWORK(network)) {
3791
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808
        return (NULL);
    }
    return (network->name);
}

/**
 * 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)
{
3809 3810
    DEBUG("network=%p, uuid=%p", network, uuid);

3811
    if (!VIR_IS_NETWORK(network)) {
3812
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    return (0);
}

/**
 * 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];
3839
    DEBUG("network=%p, buf=%p", network, buf);
3840 3841

    if (!VIR_IS_NETWORK(network)) {
3842
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3843 3844 3845 3846 3847 3848 3849 3850
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
3851
        return (-1);
3852

3853
    virUUIDFormat(uuid, buf);
3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870
    return (0);
}

/**
 * virNetworkGetXMLDesc:
 * @network: a network object
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * 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)
{
3871
    virConnectPtr conn;
3872
    DEBUG("network=%p, flags=%d", network, flags);
3873

3874
    if (!VIR_IS_NETWORK(network)) {
3875
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3876 3877 3878 3879 3880 3881 3882
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3883 3884 3885 3886 3887
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkDumpXML)
        return conn->networkDriver->networkDumpXML (network, flags);

3888
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3889
    return NULL;
3890
}
3891 3892 3893 3894 3895

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
3896
 * Provides a bridge interface name to which a domain may connect
3897 3898 3899 3900 3901 3902 3903 3904
 * 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)
{
3905
    virConnectPtr conn;
3906
    DEBUG("network=%p", network);
3907

3908
    if (!VIR_IS_NETWORK(network)) {
3909
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3910 3911 3912
        return (NULL);
    }

3913 3914 3915 3916 3917
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName)
        return conn->networkDriver->networkGetBridgeName (network);

3918
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3919
    return NULL;
3920
}
3921 3922 3923 3924

/**
 * virNetworkGetAutostart:
 * @network: a network object
3925
 * @autostart: the value returned
3926
 *
3927
 * Provides a boolean value indicating whether the network
3928 3929 3930 3931 3932 3933 3934
 * 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,
3935 3936 3937
                       int *autostart)
{
    virConnectPtr conn;
3938
    DEBUG("network=%p, autostart=%p", network, autostart);
3939 3940

    if (!VIR_IS_NETWORK(network)) {
3941
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3942 3943 3944 3945 3946 3947 3948
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3949 3950 3951 3952 3953
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkGetAutostart)
        return conn->networkDriver->networkGetAutostart (network, autostart);

3954
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3955
    return -1;
3956 3957 3958 3959 3960
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
3961
 * @autostart: whether the network should be automatically started 0 or 1
3962 3963 3964 3965 3966 3967 3968 3969
 *
 * 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,
3970 3971 3972
                       int autostart)
{
    virConnectPtr conn;
3973
    DEBUG("network=%p, autostart=%d", network, autostart);
3974 3975

    if (!VIR_IS_NETWORK(network)) {
3976
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3977 3978 3979
        return (-1);
    }

3980 3981 3982 3983 3984
    conn = network->conn;

    if (conn->networkDriver && conn->networkDriver->networkSetAutostart)
        return conn->networkDriver->networkSetAutostart (network, autostart);

3985
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3986
    return -1;
3987
}
3988

3989 3990 3991

/**
 * virStoragePoolGetConnect:
3992
 * @pool: pointer to a pool
3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141
 *
 * 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)
{
    DEBUG("pool=%p", pool);

    if (!VIR_IS_STORAGE_POOL (pool)) {
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        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)
{
    DEBUG("conn=%p", conn);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->numOfPools)
        return conn->storageDriver->numOfPools (conn);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->listPools)
        return conn->storageDriver->listPools (conn, names, maxnames);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;

}


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

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools)
        return conn->storageDriver->numOfDefinedPools (conn);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->listDefinedPools)
        return conn->storageDriver->listDefinedPools (conn, names, maxnames);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}


4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185
/**
 * 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)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return NULL;
    }

    if (conn->storageDriver && conn->storageDriver->findPoolSources)
        return conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}


4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261
/**
 * 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)
{
    DEBUG("conn=%p, name=%s", conn, name);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->storageDriver && conn->storageDriver->poolLookupByName)
        return conn->storageDriver->poolLookupByName (conn, name);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
    DEBUG("conn=%p, uuid=%s", conn, uuid);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID)
        return conn->storageDriver->poolLookupByUUID (conn, uuid);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;

}


/**
 * 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,
4262
                                                                 const char *uuidstr)
4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    return virStoragePoolLookupByUUID(conn, uuid);
}


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

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume)
        return vol->conn->storageDriver->poolLookupByVolume (vol);

    virLibConnError (vol->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;

}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
4315
 * @flags: future flags, use 0 for now
4316 4317
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
4318
 * pool is not persistent, so its definition will disappear
4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353
 * 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)
{
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (NULL);
    }

    if (conn->storageDriver && conn->storageDriver->poolCreateXML)
        return conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
4354
 * @flags: future flags, use 0 for now
4355 4356
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
4357
 * pool is persistent, until explicitly undefined.
4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
virStoragePoolPtr
virStoragePoolDefineXML(virConnectPtr conn,
                        const char *xml,
                        unsigned int flags)
{
    DEBUG("conn=%p, xml=%s", conn, xml);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (NULL);
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->storageDriver && conn->storageDriver->poolDefineXML)
        return conn->storageDriver->poolDefineXML (conn, xml, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;

}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
4392
 * @flags: future flags, use 0 for now
4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 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 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459
 *
 * Build the underlying storage pool
 *
 * Returns 0 on success, or -1 upon failure
 */
int
virStoragePoolBuild(virStoragePoolPtr pool,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->poolBuild)
        return conn->storageDriver->poolBuild (pool, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;

}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->poolUndefine)
        return conn->storageDriver->poolUndefine (pool);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;

}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
4460
 * @flags: future flags, use 0 for now
4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758
 *
 * 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;
    DEBUG("pool=%p", pool);

    if (pool == NULL) {
        TODO;
        return (-1);
    }
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->poolCreate)
        return conn->storageDriver->poolCreate (pool, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;

}


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

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->poolDestroy)
        return conn->storageDriver->poolDestroy (pool);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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;
    DEBUG("pool=%p, flags=%u", pool, flags);

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->poolDelete)
        return conn->storageDriver->poolDelete (pool, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
    DEBUG("pool=%p", pool);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


/**
 * 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
 *
 * Return 0 if the volume list was refreshed, -1 on failure
 */
int
virStoragePoolRefresh(virStoragePoolPtr pool,
                      unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p flags=%u", pool, flags);

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->poolRefresh)
        return conn->storageDriver->poolRefresh (pool, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}


/**
 * virStoragePoolGetName:
 * @pool: pointer to storage pool
 *
 * Fetch the locally unique name of the storage pool
 *
 * Return the name of the pool, or NULL on error
 */
const char*
virStoragePoolGetName(virStoragePoolPtr pool)
{
    DEBUG("pool=%p", pool);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    return (pool->name);

}


/**
 * virStoragePoolGetUUID:
 * @pool: pointer to storage pool
 * @uuid: buffer of VIR_UUID_BUFLEN bytes in size
 *
 * Fetch the globally unique ID of the storage pool
 *
 * Return 0 on success, or -1 on error;
 */
int
virStoragePoolGetUUID(virStoragePoolPtr pool,
                      unsigned char *uuid)
{
    DEBUG("pool=%p, uuid=%p", pool, uuid);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (uuid == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    return (0);

}

/**
 * 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
 *
 * Return 0 on success, or -1 on error;
 */
int
virStoragePoolGetUUIDString(virStoragePoolPtr pool,
                            char *buf)
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("pool=%p, buf=%p", pool, buf);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (buf == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
        return (-1);

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

}


/**
 * 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
 *
 * returns 0 on success, or -1 on failure.
 */
int
virStoragePoolGetInfo(virStoragePoolPtr pool,
                      virStoragePoolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("pool=%p, info=%p", pool, info);

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (info == NULL) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    conn = pool->conn;

    if (conn->storageDriver->poolGetInfo)
        return conn->storageDriver->poolGetInfo (pool, info);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;

}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
4759
 * @flags: flags for XML format options (set of virDomainXMLFlags)
4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924
 *
 * Fetch an XML document describing all aspects of the
 * storage pool. This is suitable for later feeding back
 * into the virStoragePoolCreateXML method.
 *
 * returns a XML document, or NULL on error
 */
char *
virStoragePoolGetXMLDesc(virStoragePoolPtr pool,
                         unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("pool=%p, flags=%u", pool, flags);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    conn = pool->conn;

    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc)
        return conn->storageDriver->poolGetXMLDesc (pool, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;

}


/**
 * 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
 *
 * return 0 on success, -1 on failure
 */
int
virStoragePoolGetAutostart(virStoragePoolPtr pool,
                           int *autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%p", pool, autostart);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;

    if (conn->storageDriver && conn->storageDriver->poolGetAutostart)
        return conn->storageDriver->poolGetAutostart (pool, autostart);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}


/**
 * virStoragePoolSetAutostart:
 * @pool: pointer to storage pool
 * @autostart: new flag setting
 *
 * Sets the autostart flag
 *
 * returns 0 on success, -1 on failure
 */
int
virStoragePoolSetAutostart(virStoragePoolPtr pool,
                           int autostart)
{
    virConnectPtr conn;
    DEBUG("pool=%p, autostart=%d", pool, autostart);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    conn = pool->conn;

    if (conn->storageDriver && conn->storageDriver->poolSetAutostart)
        return conn->storageDriver->poolSetAutostart (pool, autostart);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
    DEBUG("pool=%p", pool);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes)
        return pool->conn->storageDriver->poolNumOfVolumes (pool);

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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)
{
    DEBUG("pool=%p, names=%p, maxnames=%d", pool, names, maxnames);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

    if ((names == NULL) || (maxnames < 0)) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (pool->conn->storageDriver && pool->conn->storageDriver->poolListVolumes)
        return pool->conn->storageDriver->poolListVolumes (pool, names, maxnames);

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}


/**
 * virStorageVolGetConnect:
4925
 * @vol: pointer to a pool
4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075
 *
 * 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)
{
    DEBUG("vol=%p", vol);

    if (!VIR_IS_STORAGE_VOL (vol)) {
        virLibStoragePoolError (NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        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
 *
 * return a storage volume, or NULL if not found / error
 */
virStorageVolPtr
virStorageVolLookupByName(virStoragePoolPtr pool,
                          const char *name)
{
    DEBUG("pool=%p, name=%s", pool, name);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(pool->conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName)
        return pool->conn->storageDriver->volLookupByName (pool, name);

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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
 *
 * return a storage volume, or NULL if not found / error
 */
virStorageVolPtr
virStorageVolLookupByKey(virConnectPtr conn,
                         const char *key)
{
    DEBUG("conn=%p, key=%s", conn, key);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->storageDriver && conn->storageDriver->volLookupByKey)
        return conn->storageDriver->volLookupByKey (conn, key);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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
 *
 * return a storage volume, or NULL if not found / error
 */
virStorageVolPtr
virStorageVolLookupByPath(virConnectPtr conn,
                          const char *path)
{
    DEBUG("conn=%p, path=%s", conn, path);

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->storageDriver && conn->storageDriver->volLookupByPath)
        return conn->storageDriver->volLookupByPath (conn, path);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}


/**
 * virStorageVolGetName:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume name. This is unique
 * within the scope of a pool
 *
 * return the volume name, or NULL on error
 */
const char*
virStorageVolGetName(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }
    return (vol->name);
}


/**
 * virStorageVolGetKey:
 * @vol: pointer to storage volume
 *
 * Fetch the storage volume key. This is globally
5076
 * unique, so the same volume will have the same
5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133
 * key no matter what host it is accessed from
 *
 * return the volume key, or NULL on error
 */
const char*
virStorageVolGetKey(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }
    return (vol->key);
}


/**
 * 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
 *
 * return the storage volume, or NULL on error
 */
virStorageVolPtr
virStorageVolCreateXML(virStoragePoolPtr pool,
                       const char *xmldesc,
                       unsigned int flags)
{
    DEBUG("pool=%p, flags=%u", pool, flags);

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (NULL);
    }

    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML)
        return pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}


/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
5134
 * @flags: future flags, use 0 for now
5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 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 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295
 *
 * Delete the storage volume from the pool
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolDelete(virStorageVolPtr vol,
                    unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }

    conn = vol->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStorageVolError(vol, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

    if (conn->storageDriver && conn->storageDriver->volDelete)
        return conn->storageDriver->volDelete (vol, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
 * storage volume contains to exist
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


/**
 * 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
 *
 * Return 0 on success, or -1 on failure
 */
int
virStorageVolGetInfo(virStorageVolPtr vol,
                     virStorageVolInfoPtr info)
{
    virConnectPtr conn;
    DEBUG("vol=%p, info=%p", vol, info);

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (info == NULL) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

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

    conn = vol->conn;

    if (conn->storageDriver->volGetInfo)
        return conn->storageDriver->volGetInfo (vol, info);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    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
 *
 * Return the XML document, or NULL on error
 */
char *
virStorageVolGetXMLDesc(virStorageVolPtr vol,
                        unsigned int flags)
{
    virConnectPtr conn;
    DEBUG("vol=%p, flags=%u", vol, flags);

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStorageVolError(vol, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc)
        return conn->storageDriver->volGetXMLDesc (vol, flags);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;

}


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

    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

    if (conn->storageDriver && conn->storageDriver->volGetPath)
        return conn->storageDriver->volGetPath (vol);

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
}
5296 5297 5298



5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363
/*
 * 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
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
                              void *opaque)
{

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if ((conn->driver) && (conn->driver->domainEventRegister))
        return conn->driver->domainEventRegister (conn, cb, opaque);
    return -1;
}

/**
 * virConnectDomainEventDeregister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 *
 * Removes a Domain Event Callback.
 * De-registering for a domain callback will disable
 * delivery of this event type
 *
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventDeregister(virConnectPtr conn,
                                virConnectDomainEventCallback cb)
{

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister))
        return conn->driver->domainEventDeregister (conn, cb);

    return -1;
}

5364