libvirt.c 153.0 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
#include <sys/types.h>
#include <sys/stat.h>
19
#include <sys/poll.h>
20
#include <unistd.h>
21
#include <assert.h>
22 23 24
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h>
#endif
25

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

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

D
Daniel Veillard 已提交
35
#include "internal.h"
36
#include "driver.h"
37

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

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

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

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

83
#ifdef ENABLE_DEBUG
84 85
int debugFlag = 0;
#endif
86

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 241 242 243 244 245
#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);
    if (err != 0)
        return -1;
}
#endif

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

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

    DEBUG0("register drivers");

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

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

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

309 310 311 312 313
    return(0);
}



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

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

    errmsg = __virErrorMsg(error, info);
331
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
332 333 334 335
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
336
 * virLibConnWarning:
D
Daniel Veillard 已提交
337
 * @conn: the connection if available
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
 * @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;

    errmsg = __virErrorMsg(error, info);
    __virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

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

D
Daniel Veillard 已提交
371 372 373 374 375 376 377
    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
378
    __virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
D
Daniel Veillard 已提交
379 380 381
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

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

    if (error == VIR_ERR_OK)
        return;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
404
    __virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
405 406 407
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

408 409 410
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
411
 * @error: the error number
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
 * @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;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

    __virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
437
 * @error: the error number
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
 * @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;

    errmsg = __virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

    __virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

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

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

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

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

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

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

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

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

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

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

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

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

A
Atsushi SAKAI 已提交
554
#ifdef WITH_LIBVIRTD
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
/**
 * 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) {
575
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
576 577 578 579 580 581 582 583 584 585 586 587 588 589
        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++) {
590 591
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
592 593 594 595 596 597 598 599 600
            ret = -1;
    }
    return ret;
}

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

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

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

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

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

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

630 631 632 633 634 635 636 637 638 639
int __virStateSigDispatcher(siginfo_t *siginfo) {
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
        if (virStateDriverTab[i]->sigHandler &&
            virStateDriverTab[i]->sigHandler(siginfo))
            ret = 1;
    }
    return ret;
}
A
Atsushi SAKAI 已提交
640
#endif
641

642 643


644 645 646
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
647
 * @type: the type of connection/driver looked at
648 649 650 651 652
 * @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 已提交
653
 * @type is unknown or not available, an error code will be returned and
654 655 656 657 658 659
 * @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
660 661 662
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
663
    int i;
664
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
665

666
    if (!initialized)
667
        if (virInitialize() < 0)
668
            return -1;
669

670
    if (libVer == NULL)
671
        return (-1);
672 673 674
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
675
        if (type == NULL)
676 677 678
            type = "Xen";
        for (i = 0;i < virDriverTabCount;i++) {
            if ((virDriverTab[i] != NULL) &&
679
                (STRCASEEQ(virDriverTab[i]->name, type))) {
680 681 682 683
                *typeVer = virDriverTab[i]->ver;
                break;
            }
        }
684
        if (i >= virDriverTabCount) {
685
            *typeVer = 0;
686
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
687 688 689 690
            return (-1);
        }
    }
    return (0);
691 692
}

693
static virConnectPtr
694 695 696
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
697
{
698
    int i, res;
699
    virConnectPtr ret = NULL;
700
    xmlURIPtr uri;
701

702 703 704 705 706 707 708 709
    /*
     *  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) {
710
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
711 712
            name = defname;
        } else {
713 714 715
            const char *use = NULL;
            const char *latest;
            int probes = 0;
D
Daniel Veillard 已提交
716
            for (i = 0; i < virDriverTabCount; i++) {
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
                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);
            }
        }
742
    }
743 744

    /* Convert xen -> xen:/// for back compat */
745
    if (STRCASEEQ(name, "xen"))
746 747
        name = "xen:///";

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

754
    ret = virGetConnect();
755
    if (ret == NULL)
756 757 758 759 760 761
        return NULL;

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

765 766 767 768 769 770 771 772 773 774 775
    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);
776

777 778
    ret->name = strdup (name);
    if (!ret->name) {
779
        virLibConnError (ret, VIR_ERR_NO_MEMORY, _("allocating conn->name"));
780 781 782
        goto failed;
    }

783 784 785
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

786
    for (i = 0; i < virDriverTabCount; i++) {
787 788
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
789
        res = virDriverTab[i]->open (ret, uri, auth, flags);
790 791 792 793 794
        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")));
795 796 797 798 799
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
800 801
    }

802
    if (!ret->driver) {
803 804
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
805
        goto failed;
806 807
    }

808
    for (i = 0; i < virNetworkDriverTabCount; i++) {
809
        res = virNetworkDriverTab[i]->open (ret, uri, auth, flags);
810 811 812 813 814
        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")));
815
        if (res == VIR_DRV_OPEN_ERROR) {
816
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
817
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
818 819
                                   "Is the daemon running ?");
            }
820 821
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
822 823 824
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
825
    }
826

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

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

850 851
    xmlFreeURI (uri);

852
    return ret;
853 854

failed:
855
    if (ret->driver) ret->driver->close (ret);
856
    if (uri) xmlFreeURI(uri);
857

858
    /* If no global error was set, copy any error set
859 860 861 862 863 864 865 866 867 868 869 870 871
       in the connection object we're about to dispose of */
    if (__lastErr.code == VIR_ERR_OK) {
        memcpy(&__lastErr, &ret->err, sizeof(ret->err));
        memset(&ret->err, 0, sizeof(ret->err));
    }

    /* Still no error set, then raise a generic error */
    if (__lastErr.code == VIR_ERR_OK)
        virLibConnError (NULL, VIR_ERR_INTERNAL_ERROR,
                         _("unable to open connection"));

    virUnrefConnect(ret);

872
    return NULL;
873 874
}

875 876
/**
 * virConnectOpen:
877
 * @name: URI of the hypervisor
878
 *
879
 * This function should be called first to get a connection to the
880 881 882
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
883 884
 *
 * URIs are documented at http://libvirt.org/uri.html
885 886 887 888
 */
virConnectPtr
virConnectOpen (const char *name)
{
889 890 891 892
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

893
    DEBUG("name=%s", name);
894
    return do_open (name, NULL, 0);
895 896
}

897
/**
898
 * virConnectOpenReadOnly:
899
 * @name: URI of the hypervisor
900
 *
901
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
902
 * library functionalities. The set of APIs usable are then restricted
903
 * on the available methods to control the domains.
904 905
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
906 907
 *
 * URIs are documented at http://libvirt.org/uri.html
908
 */
909
virConnectPtr
910 911
virConnectOpenReadOnly(const char *name)
{
912 913 914 915
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

916
    DEBUG("name=%s", name);
917 918 919 920 921 922 923 924 925
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
926
 * This function should be called first to get a connection to the
927
 * Hypervisor. If necessary, authentication will be performed fetching
928 929 930 931 932 933 934 935 936 937 938
 * 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)
{
939 940 941 942 943
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

    DEBUG("name=%s, auth=%p, flags=%d", name, auth, flags);
944
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
945 946 947
}

/**
948
 * virConnectClose:
D
Daniel Veillard 已提交
949 950 951 952 953 954 955 956 957 958
 * @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
959 960
virConnectClose(virConnectPtr conn)
{
961 962
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
963
    if (!VIR_IS_CONNECT(conn))
964
        return (-1);
965 966 967

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
968 969
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
970
    conn->driver->close (conn);
971

972
    if (virUnrefConnect(conn) < 0)
973
        return (-1);
974
    return (0);
D
Daniel Veillard 已提交
975 976
}

977 978 979 980 981 982 983 984 985 986 987 988 989 990
/* 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);
}

991 992 993 994 995 996 997
/**
 * 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.
998 999 1000
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1001 1002
 */
const char *
1003 1004
virConnectGetType(virConnectPtr conn)
{
1005
    const char *ret;
1006
    DEBUG("conn=%p", conn);
1007

D
Daniel Veillard 已提交
1008
    if (!VIR_IS_CONNECT(conn)) {
1009
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1010
        return (NULL);
D
Daniel Veillard 已提交
1011
    }
1012 1013 1014 1015

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1016
    }
1017
    return conn->driver->name;
1018 1019
}

D
Daniel Veillard 已提交
1020
/**
1021
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1022
 * @conn: pointer to the hypervisor connection
1023
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1024
 *
1025
 * Get the version level of the Hypervisor running. This may work only with
1026
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1027
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1028
 *
1029 1030 1031
 * 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 已提交
1032
 */
1033
int
1034 1035
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1036 1037
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
1038
    if (!VIR_IS_CONNECT(conn)) {
1039
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1040
        return (-1);
D
Daniel Veillard 已提交
1041
    }
1042

D
Daniel Veillard 已提交
1043 1044
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1045
        return (-1);
D
Daniel Veillard 已提交
1046
    }
1047

1048 1049
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
1050

1051 1052
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1053 1054
}

1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
/**
 * 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)
{
1070 1071
    DEBUG("conn=%p", conn);

1072
    if (!VIR_IS_CONNECT(conn)) {
1073
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
        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)
{
1102 1103
    char *name;

1104 1105
    DEBUG("conn=%p", conn);

1106
    if (!VIR_IS_CONNECT(conn)) {
1107
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1108 1109 1110
        return NULL;
    }

1111 1112 1113
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
1114 1115 1116
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

1117 1118 1119 1120 1121 1122
    name = strdup (conn->name);
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
1123 1124
}

1125 1126 1127 1128 1129
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1130
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1131 1132 1133 1134 1135 1136 1137 1138 1139
 * 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)
{
1140 1141
    DEBUG("conn=%p, type=%s", conn, type);

1142
    if (!VIR_IS_CONNECT(conn)) {
1143
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1144 1145 1146
        return (-1);
    }

1147 1148
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
1149

1150 1151
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1152 1153
}

1154
/**
1155
 * virConnectListDomains:
1156 1157 1158 1159 1160 1161 1162 1163 1164
 * @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
1165 1166
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1167 1168
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
1169
    if (!VIR_IS_CONNECT(conn)) {
1170
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1171
        return (-1);
D
Daniel Veillard 已提交
1172
    }
1173

1174
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1175
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1176
        return (-1);
D
Daniel Veillard 已提交
1177
    }
1178

1179 1180
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
1181

1182 1183
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1184 1185
}

K
 
Karel Zak 已提交
1186 1187 1188 1189
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1190 1191
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1192 1193 1194
 * Returns the number of domain found or -1 in case of error
 */
int
1195 1196
virConnectNumOfDomains(virConnectPtr conn)
{
1197 1198
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
1199
    if (!VIR_IS_CONNECT(conn)) {
1200
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1201
        return (-1);
D
Daniel Veillard 已提交
1202
    }
K
Karel Zak 已提交
1203

1204 1205
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
1206

1207 1208
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
1209 1210
}

1211 1212 1213 1214
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1215
 * Provides the connection pointer associated with a domain.  The
1216 1217 1218
 * reference counter on the connection is not increased by this
 * call.
 *
1219 1220 1221 1222
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1223 1224 1225 1226 1227
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1228 1229
    DEBUG("dom=%p", dom);

1230
    if (!VIR_IS_DOMAIN (dom)) {
1231
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1232 1233 1234 1235 1236
        return NULL;
    }
    return dom->conn;
}

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

D
Daniel Veillard 已提交
1258
    if (!VIR_IS_CONNECT(conn)) {
1259
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1260
        return (NULL);
D
Daniel Veillard 已提交
1261 1262 1263
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1264
        return (NULL);
D
Daniel Veillard 已提交
1265
    }
1266 1267
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1268
        return (NULL);
1269
    }
D
Daniel Veillard 已提交
1270

1271 1272
    if (conn->driver->domainCreateXML)
        return conn->driver->domainCreateXML (conn, xmlDesc, flags);
1273 1274 1275

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

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
/**
 * 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));
}
1296

1297
/**
1298
 * virDomainLookupByID:
1299 1300 1301 1302
 * @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 已提交
1303 1304
 * 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.
1305
 *
1306 1307
 * 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.
1308
 */
1309
virDomainPtr
1310 1311
virDomainLookupByID(virConnectPtr conn, int id)
{
1312 1313
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
1314
    if (!VIR_IS_CONNECT(conn)) {
1315
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1316
        return (NULL);
D
Daniel Veillard 已提交
1317 1318 1319
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1320
        return (NULL);
D
Daniel Veillard 已提交
1321
    }
1322

1323 1324
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1325

1326 1327
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1328 1329 1330 1331 1332
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1333
 * @uuid: the raw UUID for the domain
1334 1335 1336
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1337 1338
 * 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.
1339 1340
 */
virDomainPtr
1341 1342
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1343 1344
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
1345
    if (!VIR_IS_CONNECT(conn)) {
1346
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1347
        return (NULL);
D
Daniel Veillard 已提交
1348 1349 1350
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1351
        return (NULL);
D
Daniel Veillard 已提交
1352
    }
1353

1354 1355
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1356

1357 1358
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1359 1360
}

K
Karel Zak 已提交
1361 1362 1363 1364 1365 1366 1367
/**
 * 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.
 *
1368 1369
 * 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 已提交
1370 1371 1372 1373
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1374 1375
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1376 1377
    int ret;

1378 1379
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1380
    if (!VIR_IS_CONNECT(conn)) {
1381
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1382 1383 1384 1385 1386
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
1387

K
Karel Zak 已提交
1388
    }
1389 1390
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
     */
    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);
1402

1403
    if (ret!=VIR_UUID_BUFLEN) {
1404 1405
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
K
Karel Zak 已提交
1406
    }
1407
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1408
        uuid[i] = raw[i] & 0xFF;
1409

K
Karel Zak 已提交
1410 1411 1412
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1413 1414 1415 1416 1417
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1418
 * Try to lookup a domain on the given hypervisor based on its name.
1419
 *
1420 1421
 * 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.
1422 1423
 */
virDomainPtr
1424 1425
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1426 1427
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1428
    if (!VIR_IS_CONNECT(conn)) {
1429
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1430
        return (NULL);
D
Daniel Veillard 已提交
1431 1432 1433
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1434
        return (NULL);
D
Daniel Veillard 已提交
1435
    }
1436

1437 1438 1439 1440 1441
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

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

D
Daniel Veillard 已提交
1444
/**
1445
 * virDomainDestroy:
D
Daniel Veillard 已提交
1446 1447 1448
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1449 1450 1451
 * 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 已提交
1452 1453
 *
 * Returns 0 in case of success and -1 in case of failure.
1454
 */
D
Daniel Veillard 已提交
1455
int
1456 1457
virDomainDestroy(virDomainPtr domain)
{
1458
    virConnectPtr conn;
1459

1460 1461
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1462
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1463
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1464
        return (-1);
D
Daniel Veillard 已提交
1465
    }
1466

1467
    conn = domain->conn;
1468 1469
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1470
        return (-1);
1471
    }
1472

1473 1474
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1475

1476 1477
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
}

/**
 * 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
1490 1491
virDomainFree(virDomainPtr domain)
{
1492 1493
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1494
    if (!VIR_IS_DOMAIN(domain)) {
1495
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1496
        return (-1);
D
Daniel Veillard 已提交
1497
    }
1498
    if (virUnrefDomain(domain) < 0)
1499 1500
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1501 1502 1503
}

/**
1504
 * virDomainSuspend:
D
Daniel Veillard 已提交
1505 1506 1507
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1508
 * to CPU resources and I/O but the memory used by the domain at the
1509
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1510
 * the domain.
1511
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1512 1513 1514 1515
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1516 1517
virDomainSuspend(virDomainPtr domain)
{
1518
    virConnectPtr conn;
1519
    DEBUG("domain=%p", domain);
1520

D
Daniel Veillard 已提交
1521
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1522
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1523
        return (-1);
D
Daniel Veillard 已提交
1524
    }
1525 1526
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1527
        return (-1);
1528
    }
D
Daniel Veillard 已提交
1529

1530 1531
    conn = domain->conn;

1532 1533
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1534

1535 1536
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1537 1538 1539
}

/**
1540
 * virDomainResume:
D
Daniel Veillard 已提交
1541 1542 1543
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1544
 * it was frozen by calling virSuspendDomain().
1545
 * This function may requires privileged access
D
Daniel Veillard 已提交
1546 1547 1548 1549
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1550 1551
virDomainResume(virDomainPtr domain)
{
1552
    virConnectPtr conn;
1553
    DEBUG("domain=%p", domain);
1554

D
Daniel Veillard 已提交
1555
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1556
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1557
        return (-1);
D
Daniel Veillard 已提交
1558
    }
1559 1560
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1561
        return (-1);
1562
    }
D
Daniel Veillard 已提交
1563

1564 1565
    conn = domain->conn;

1566 1567
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1568

1569 1570
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1571 1572
}

1573 1574 1575 1576 1577 1578
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1579 1580 1581
 * 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.
1582 1583 1584 1585
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1586 1587
virDomainSave(virDomainPtr domain, const char *to)
{
1588
    char filepath[4096];
1589
    virConnectPtr conn;
1590
    DEBUG("domain=%p, to=%s", domain, to);
1591

D
Daniel Veillard 已提交
1592
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1593
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1594
        return (-1);
D
Daniel Veillard 已提交
1595
    }
1596 1597
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1598
        return (-1);
1599
    }
1600
    conn = domain->conn;
D
Daniel Veillard 已提交
1601 1602
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1603
        return (-1);
D
Daniel Veillard 已提交
1604
    }
1605

1606 1607 1608 1609 1610
    /*
     * 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] != '/') {
1611
        unsigned int len, t;
1612

1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
        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];
1623 1624 1625

    }

1626 1627 1628
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1629
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1630
    return -1;
1631 1632 1633 1634
}

/**
 * virDomainRestore:
1635
 * @conn: pointer to the hypervisor connection
1636
 * @from: path to the
1637 1638 1639 1640 1641 1642
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1643 1644
virDomainRestore(virConnectPtr conn, const char *from)
{
1645
    char filepath[4096];
1646
    DEBUG("conn=%p, from=%s", conn, from);
1647

D
Daniel Veillard 已提交
1648
    if (!VIR_IS_CONNECT(conn)) {
1649
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1650
        return (-1);
D
Daniel Veillard 已提交
1651
    }
1652 1653
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1654
        return (-1);
1655
    }
D
Daniel Veillard 已提交
1656 1657
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1658
        return (-1);
D
Daniel Veillard 已提交
1659 1660
    }

1661 1662 1663 1664 1665
    /*
     * 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] != '/') {
1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
        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];
    }

1680 1681 1682
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1683
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1684
    return -1;
D
Daniel Veillard 已提交
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
}

/**
 * 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;
1704
    DEBUG("domain=%p, to=%s, flags=%d", domain, to, flags);
D
Daniel Veillard 已提交
1705 1706

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1707
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1708 1709 1710 1711
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1712
        return (-1);
D
Daniel Veillard 已提交
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
    }
    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];

    }

1740 1741 1742
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1743
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1744
    return -1;
1745 1746
}

1747 1748 1749 1750 1751
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1752 1753
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1754 1755 1756 1757 1758 1759 1760
 *
 * 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
1761 1762
virDomainShutdown(virDomainPtr domain)
{
1763
    virConnectPtr conn;
1764
    DEBUG("domain=%p", domain);
1765

D
Daniel Veillard 已提交
1766
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1767
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1768
        return (-1);
D
Daniel Veillard 已提交
1769
    }
1770 1771
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1772
        return (-1);
1773
    }
1774

1775 1776
    conn = domain->conn;

1777 1778
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1779

1780
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1781
    return -1;
1782 1783
}

1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
/**
 * 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)
{
1798
    virConnectPtr conn;
1799
    DEBUG("domain=%p, flags=%u", domain, flags);
1800 1801

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1802
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1803 1804
        return (-1);
    }
1805 1806
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1807
        return (-1);
1808
    }
1809

1810 1811
    conn = domain->conn;

1812 1813
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1814

1815
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1816
    return -1;
1817 1818
}

1819
/**
1820
 * virDomainGetName:
1821 1822 1823 1824 1825 1826 1827 1828
 * @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 *
1829 1830
virDomainGetName(virDomainPtr domain)
{
1831 1832
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1833
    if (!VIR_IS_DOMAIN(domain)) {
1834
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1835
        return (NULL);
D
Daniel Veillard 已提交
1836
    }
1837
    return (domain->name);
1838 1839
}

1840 1841 1842
/**
 * virDomainGetUUID:
 * @domain: a domain object
1843
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1844 1845 1846 1847 1848 1849
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1850 1851
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1852 1853
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1854
    if (!VIR_IS_DOMAIN(domain)) {
1855
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1856
        return (-1);
D
Daniel Veillard 已提交
1857 1858 1859
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1860
        return (-1);
D
Daniel Veillard 已提交
1861 1862
    }

1863 1864
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

1865
    return (0);
1866 1867
}

K
Karel Zak 已提交
1868 1869 1870
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1871
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1872
 *
1873
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
1874 1875 1876 1877 1878 1879 1880
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
1881
    unsigned char uuid[VIR_UUID_BUFLEN];
1882
    DEBUG("domain=%p, buf=%p", domain, buf);
1883

K
Karel Zak 已提交
1884
    if (!VIR_IS_DOMAIN(domain)) {
1885
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1886 1887 1888 1889 1890 1891
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1892

K
Karel Zak 已提交
1893
    if (virDomainGetUUID(domain, &uuid[0]))
1894
        return (-1);
K
Karel Zak 已提交
1895

1896
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1897 1898 1899
    return (0);
}

1900
/**
1901
 * virDomainGetID:
1902 1903 1904 1905 1906 1907 1908
 * @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
1909 1910
virDomainGetID(virDomainPtr domain)
{
1911 1912
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1913
    if (!VIR_IS_DOMAIN(domain)) {
1914
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1915
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1916
    }
1917
    return (domain->id);
1918 1919
}

1920 1921 1922 1923 1924 1925
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1926 1927
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1928 1929
 */
char *
1930 1931
virDomainGetOSType(virDomainPtr domain)
{
1932
    virConnectPtr conn;
1933
    DEBUG("domain=%p", domain);
1934

D
Daniel Veillard 已提交
1935
    if (!VIR_IS_DOMAIN(domain)) {
1936
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1937
        return (NULL);
D
Daniel Veillard 已提交
1938
    }
1939

1940 1941 1942 1943
    conn = domain->conn;

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

1945
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1946
    return NULL;
1947 1948
}

1949
/**
1950
 * virDomainGetMaxMemory:
1951
 * @domain: a domain object or NULL
1952
 *
1953 1954 1955 1956 1957 1958 1959
 * 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
1960 1961
virDomainGetMaxMemory(virDomainPtr domain)
{
1962
    virConnectPtr conn;
1963
    DEBUG("domain=%p", domain);
1964

D
Daniel Veillard 已提交
1965
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1966
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1967
        return (0);
D
Daniel Veillard 已提交
1968
    }
1969

1970 1971
    conn = domain->conn;

1972 1973 1974
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

1975
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1976
    return 0;
1977 1978
}

D
Daniel Veillard 已提交
1979
/**
1980
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
1981 1982
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
1983
 *
D
Daniel Veillard 已提交
1984 1985 1986
 * 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.
1987
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
1988 1989 1990 1991
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1992 1993
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
1994
    virConnectPtr conn;
1995
    DEBUG("domain=%p, memory=%lu", domain, memory);
1996

1997 1998
    if (domain == NULL) {
        TODO
1999
        return (-1);
2000 2001
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2002
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2003
        return (-1);
2004
    }
2005 2006
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2007
        return (-1);
2008 2009 2010 2011 2012
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2013
    conn = domain->conn;
2014

2015 2016 2017
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

2018
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2019
    return -1;
2020
}
2021

2022 2023 2024 2025
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2026
 *
2027 2028 2029
 * 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.
2030
 * This function may requires privileged access to the hypervisor.
2031 2032 2033 2034 2035 2036 2037
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2038
    DEBUG("domain=%p, memory=%lu", domain, memory);
2039

2040 2041
    if (domain == NULL) {
        TODO
2042
        return (-1);
2043 2044
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2045
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2046
        return (-1);
2047
    }
2048 2049
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2050
        return (-1);
2051 2052 2053
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2054
        return (-1);
2055 2056 2057
    }

    conn = domain->conn;
2058

2059 2060 2061
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

2062
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2063
    return -1;
D
Daniel Veillard 已提交
2064 2065
}

2066 2067
/**
 * virDomainGetInfo:
2068
 * @domain: a domain object
2069
 * @info: pointer to a virDomainInfo structure allocated by the user
2070
 *
2071
 * Extract information about a domain. Note that if the connection
2072
 * used to get the domain is limited only a partial set of the information
2073 2074 2075 2076 2077
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2078 2079
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2080
    virConnectPtr conn;
2081
    DEBUG("domain=%p, info=%p", domain, info);
2082

D
Daniel Veillard 已提交
2083
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2084
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2085
        return (-1);
D
Daniel Veillard 已提交
2086 2087 2088
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2089
        return (-1);
D
Daniel Veillard 已提交
2090
    }
2091

2092
    memset(info, 0, sizeof(virDomainInfo));
2093

2094 2095 2096 2097
    conn = domain->conn;

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

2099
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2100
    return -1;
2101
}
2102

2103 2104 2105
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2106
 * @flags: an OR'ed set of virDomainXMLFlags
2107 2108
 *
 * Provide an XML description of the domain. The description may be reused
2109
 * later to relaunch the domain with virDomainCreateXML().
2110 2111 2112 2113 2114
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2115 2116
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2117
    virConnectPtr conn;
2118
    DEBUG("domain=%p, flags=%d", domain, flags);
2119

D
Daniel Veillard 已提交
2120
    if (!VIR_IS_DOMAIN(domain)) {
2121
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2122
        return (NULL);
D
Daniel Veillard 已提交
2123
    }
2124

2125 2126 2127 2128 2129
    conn = domain->conn;

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

2130
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2131
    return NULL;
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 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
/**
 * 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)) {
2199
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232
        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,
2233
                         _("domainMigratePrepare did not set uri"));
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
        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:
2260 2261
    free (uri_out);
    free (cookie);
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
    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)) {
2281
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
        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)) {
2310
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
        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)) {
2338
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
        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;
}


2352 2353 2354 2355
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
2356
 *
2357 2358 2359 2360 2361
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2362 2363
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2364 2365
    DEBUG("conn=%p, info=%p", conn, info);

2366
    if (!VIR_IS_CONNECT(conn)) {
2367
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2368 2369 2370 2371 2372 2373 2374
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2375 2376 2377
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2378
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2379
    return -1;
2380
}
2381

2382 2383 2384 2385 2386 2387
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2388 2389
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2390 2391 2392 2393 2394
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2395 2396
    DEBUG("conn=%p", conn);

2397
    if (!VIR_IS_CONNECT (conn)) {
2398
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2399 2400 2401
        return NULL;
    }

2402 2403
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2404

2405
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2406 2407 2408
    return NULL;
}

2409 2410 2411
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
2412
 *
D
Daniel Veillard 已提交
2413
 * provides the free memory available on the Node
2414 2415 2416 2417 2418 2419
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
2420 2421
    DEBUG("conn=%p", conn);

2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433
    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;
}

2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
/**
 * 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;
2448
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2449 2450

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2451
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2452 2453 2454 2455 2456 2457 2458 2459 2460
        return NULL;
    }
    conn = domain->conn;

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

2461
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481
    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,
2482
                                virSchedParameterPtr params, int *nparams)
2483 2484
{
    virConnectPtr conn;
2485
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2486 2487

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2488
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2489 2490 2491 2492 2493 2494 2495
        return -1;
    }
    conn = domain->conn;

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

2496
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
    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
2513
virDomainSetSchedulerParameters(virDomainPtr domain,
2514
                                virSchedParameterPtr params, int nparams)
2515 2516
{
    virConnectPtr conn;
2517
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2518 2519

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2520
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2521 2522
        return -1;
    }
2523 2524 2525 2526
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }
2527 2528 2529 2530 2531
    conn = domain->conn;

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

2532
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2533 2534 2535 2536
    return -1;
}


2537
/**
2538
 * virDomainBlockStats:
2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572
 * @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)) {
2573
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
        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;
}

/**
2591
 * virDomainInterfaceStats:
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624
 * @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)) {
2625
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
        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 已提交
2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674
/**
 * 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 已提交
2675 2676 2677 2678
 * 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 已提交
2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697
 * 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;
2698

R
Richard W.M. Jones 已提交
2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718
    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)
2719 2720
        return conn->driver->domainBlockPeek (dom, path, offset, size,
                                              buffer, flags);
R
Richard W.M. Jones 已提交
2721 2722 2723 2724

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

R
Richard W.M. Jones 已提交
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 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815
/**
 * 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;
}

2816

2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827
/************************************************************************
 *									*
 *		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
 *
2828 2829 2830
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
 * virDomainUndefine().
2831 2832 2833 2834 2835
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
2836 2837
    DEBUG("conn=%p, xml=%s", conn, xml);

2838
    if (!VIR_IS_CONNECT(conn)) {
2839
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2840 2841
        return (NULL);
    }
2842 2843
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2844
        return (NULL);
2845
    }
2846 2847 2848 2849 2850
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

2851 2852
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
2853

2854
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2855
    return NULL;
2856 2857 2858 2859 2860 2861
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
2862
 * Undefine a domain but does not stop it if it is running
2863 2864 2865 2866 2867
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
2868
    virConnectPtr conn;
2869
    DEBUG("domain=%p", domain);
2870 2871

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2872
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2873 2874
        return (-1);
    }
2875 2876
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2877
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2878
        return (-1);
2879 2880
    }

2881 2882
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
2883

2884
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2885
    return -1;
2886 2887 2888 2889 2890 2891
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
2892
 * Provides the number of defined but inactive domains.
2893 2894 2895 2896 2897 2898
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
2899 2900
    DEBUG("conn=%p", conn);

2901
    if (!VIR_IS_CONNECT(conn)) {
2902
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2903 2904 2905
        return (-1);
    }

2906 2907
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
2908

2909
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2910
    return -1;
2911 2912 2913 2914 2915 2916 2917 2918
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
2919 2920
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
2921
 *
2922 2923 2924
 * Returns the number of names provided in the array or -1 in case of error
 */
int
2925
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
2926
                             int maxnames) {
2927 2928
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

2929
    if (!VIR_IS_CONNECT(conn)) {
2930
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2931 2932 2933
        return (-1);
    }

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

2939 2940
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
2941

2942
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2943
    return -1;
2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956
}

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

2960 2961
    if (domain == NULL) {
        TODO
2962
        return (-1);
2963
    }
2964
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2965
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2966 2967
        return (-1);
    }
2968 2969
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
2970
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2971
        return (-1);
2972
    }
2973

2974 2975 2976
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

2977
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2978
    return -1;
2979 2980
}

2981 2982 2983
/**
 * virDomainGetAutostart:
 * @domain: a domain object
2984
 * @autostart: the value returned
2985
 *
2986
 * Provides a boolean value indicating whether the domain
2987 2988 2989 2990 2991 2992 2993
 * 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,
2994 2995 2996
                      int *autostart)
{
    virConnectPtr conn;
2997
    DEBUG("domain=%p, autostart=%p", domain, autostart);
2998 2999

    if (!VIR_IS_DOMAIN(domain)) {
3000
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3001 3002 3003 3004 3005 3006 3007
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3008 3009 3010 3011 3012
    conn = domain->conn;

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

3013
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3014
    return -1;
3015 3016 3017 3018 3019
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3020
 * @autostart: whether the domain should be automatically started 0 or 1
3021 3022 3023 3024 3025 3026 3027 3028
 *
 * 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,
3029 3030 3031
                      int autostart)
{
    virConnectPtr conn;
3032
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3033 3034

    if (!VIR_IS_DOMAIN(domain)) {
3035
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3036 3037 3038
        return (-1);
    }

3039 3040 3041 3042 3043
    conn = domain->conn;

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

3044
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3045
    return -1;
3046 3047
}

3048 3049 3050 3051 3052 3053 3054 3055
/**
 * 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.
3056
 * This function requires privileged access to the hypervisor.
3057 3058 3059 3060 3061 3062 3063
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3064
    virConnectPtr conn;
3065
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3066

3067 3068
    if (domain == NULL) {
        TODO
3069
        return (-1);
3070 3071
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3072
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3073 3074
        return (-1);
    }
3075 3076
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3077
        return (-1);
3078
    }
3079

3080 3081 3082 3083
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3084
    conn = domain->conn;
3085

3086 3087
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
3088

3089
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3090
    return -1;
3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104
}

/**
 * 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.
3105
 *
3106
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
3107
 * This function requires privileged access to the hypervisor.
3108 3109 3110 3111 3112 3113 3114
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
3115
    virConnectPtr conn;
3116
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
3117

3118 3119
    if (domain == NULL) {
        TODO
3120
        return (-1);
3121 3122
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3123
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3124 3125
        return (-1);
    }
3126 3127
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3128
        return (-1);
3129
    }
3130

3131
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
3132 3133 3134
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3135

3136 3137
    conn = domain->conn;

3138 3139 3140
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

3141
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3142
    return -1;
3143 3144 3145 3146 3147 3148 3149 3150 3151
}

/**
 * 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 已提交
3152
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
3153 3154 3155 3156 3157 3158 3159
 *	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...).
3160
 *
3161
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
3162
 * and also in cpumaps if this pointer isn't NULL.
3163 3164 3165 3166 3167
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
3168
                  unsigned char *cpumaps, int maplen)
3169
{
3170
    virConnectPtr conn;
3171
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
3172 3173 3174

    if (domain == NULL) {
        TODO
3175
        return (-1);
3176 3177
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3178
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3179 3180 3181 3182 3183 3184 3185 3186 3187 3188
        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);
    }
3189

3190 3191
    conn = domain->conn;

3192 3193 3194 3195
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

3196
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3197
    return -1;
3198
}
3199

3200 3201 3202
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
3203
 *
3204 3205 3206 3207 3208
 * 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.
3209 3210 3211 3212
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
3213 3214
virDomainGetMaxVcpus(virDomainPtr domain)
{
3215
    virConnectPtr conn;
3216
    DEBUG("domain=%p", domain);
3217 3218

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3219
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3220 3221 3222 3223 3224
        return (-1);
    }

    conn = domain->conn;

3225 3226 3227
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

3228
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3229
    return -1;
3230 3231 3232
}


3233 3234 3235 3236
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3237
 *
3238 3239 3240 3241 3242
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3243
virDomainAttachDevice(virDomainPtr domain, const char *xml)
3244 3245
{
    virConnectPtr conn;
3246
    DEBUG("domain=%p, xml=%s", domain, xml);
3247 3248

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3249
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3250 3251 3252 3253
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3254
        return (-1);
3255 3256 3257
    }
    conn = domain->conn;

3258 3259 3260
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

3261
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3262
    return -1;
3263 3264 3265 3266 3267 3268
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3269
 *
3270 3271 3272 3273 3274
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3275
virDomainDetachDevice(virDomainPtr domain, const char *xml)
3276 3277
{
    virConnectPtr conn;
3278
    DEBUG("domain=%p, xml=%s", domain, xml);
3279 3280

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3281
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3282 3283 3284 3285
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3286
        return (-1);
3287 3288 3289
    }
    conn = domain->conn;

3290 3291 3292
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

3293
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3294
    return -1;
3295
}
3296

3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318
/**
 * 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)
{
3319 3320 3321
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

3322 3323 3324 3325 3326
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
3327
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338
        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;
}

3339 3340 3341 3342
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
3343
 * Provides the connection pointer associated with a network.  The
3344 3345 3346
 * reference counter on the connection is not increased by this
 * call.
 *
3347 3348 3349 3350
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
3351 3352 3353 3354 3355
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
3356 3357
    DEBUG("net=%p", net);

3358
    if (!VIR_IS_NETWORK (net)) {
3359
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3360 3361 3362 3363 3364
        return NULL;
    }
    return net->conn;
}

3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375
/**
 * 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)
{
3376 3377
    DEBUG("conn=%p", conn);

3378
    if (!VIR_IS_CONNECT(conn)) {
3379
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3380 3381 3382
        return (-1);
    }

3383 3384
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
3385

3386
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3387
    return -1;
3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
}

/**
 * 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
3401
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
3402
{
3403 3404
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3405
    if (!VIR_IS_CONNECT(conn)) {
3406
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3407 3408 3409
        return (-1);
    }

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

3415 3416
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
3417

3418
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3419
    return -1;
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432
}

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

3435
    if (!VIR_IS_CONNECT(conn)) {
3436
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3437 3438 3439
        return (-1);
    }

3440 3441
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
3442

3443
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3444
    return -1;
3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457
}

/**
 * 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
3458
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
3459 3460
                              int maxnames)
{
3461 3462
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3463
    if (!VIR_IS_CONNECT(conn)) {
3464
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3465 3466 3467
        return (-1);
    }

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

3473 3474 3475
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
3476

3477
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3478
    return -1;
3479 3480 3481 3482 3483 3484 3485 3486 3487
}

/**
 * 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.
 *
3488 3489
 * 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.
3490 3491 3492 3493
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3494 3495
    DEBUG("conn=%p, name=%s", conn, name);

3496
    if (!VIR_IS_CONNECT(conn)) {
3497
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3498 3499 3500 3501 3502 3503 3504
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3505 3506 3507
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

3508
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3509
    return NULL;
3510 3511 3512 3513 3514 3515 3516 3517 3518
}

/**
 * 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.
 *
3519 3520
 * 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.
3521 3522 3523 3524
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3525 3526
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3527
    if (!VIR_IS_CONNECT(conn)) {
3528
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3529 3530 3531 3532 3533 3534 3535
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3536 3537
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3538

3539
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3540
    return NULL;
3541 3542 3543 3544 3545 3546 3547 3548 3549
}

/**
 * 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.
 *
3550 3551
 * 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.
3552 3553 3554 3555 3556 3557 3558
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3559
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3560 3561

    if (!VIR_IS_CONNECT(conn)) {
3562
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584
        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) {
3585 3586
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606
    }
    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)
{
3607 3608
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3609
    if (!VIR_IS_CONNECT(conn)) {
3610
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3611 3612 3613 3614 3615 3616 3617 3618
        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__);
3619
        return (NULL);
3620 3621
    }

3622 3623 3624
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3625
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3626
    return NULL;
3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638
}

/**
 * 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
3639 3640
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3641 3642
    DEBUG("conn=%p, xml=%s", conn, xml);

3643
    if (!VIR_IS_CONNECT(conn)) {
3644
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3645 3646 3647 3648
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3649
        return (NULL);
3650 3651 3652 3653 3654 3655
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3656 3657
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3658

3659
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3660
    return NULL;
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673
}

/**
 * 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;
3674
    DEBUG("network=%p", network);
3675 3676

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3677
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3678 3679 3680 3681 3682
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3683
        return (-1);
3684 3685
    }

3686 3687
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3688

3689
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3690
    return -1;
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702
}

/**
 * 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
3703 3704
virNetworkCreate(virNetworkPtr network)
{
3705
    virConnectPtr conn;
3706 3707
    DEBUG("network=%p", network);

3708 3709
    if (network == NULL) {
        TODO
3710
        return (-1);
3711 3712
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3713
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3714 3715 3716 3717 3718
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3719
        return (-1);
3720 3721
    }

3722 3723 3724
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3725
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3726
    return -1;
3727 3728 3729 3730 3731 3732 3733
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
3734 3735 3736
 * 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
3737 3738 3739 3740 3741 3742 3743
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
3744
    DEBUG("network=%p", network);
3745 3746

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3747
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3748 3749 3750 3751 3752 3753
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3754
        return (-1);
3755 3756
    }

3757 3758
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3759

3760
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3761
    return -1;
3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
}

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

3778
    if (!VIR_IS_NETWORK(network)) {
3779
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3780 3781
        return (-1);
    }
3782
    if (virUnrefNetwork(network) < 0)
3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798
        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)
{
3799 3800
    DEBUG("network=%p", network);

3801
    if (!VIR_IS_NETWORK(network)) {
3802
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819
        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)
{
3820 3821
    DEBUG("network=%p, uuid=%p", network, uuid);

3822
    if (!VIR_IS_NETWORK(network)) {
3823
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849
        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];
3850
    DEBUG("network=%p, buf=%p", network, buf);
3851 3852

    if (!VIR_IS_NETWORK(network)) {
3853
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3854 3855 3856 3857 3858 3859 3860 3861
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
3862
        return (-1);
3863

3864
    virUUIDFormat(uuid, buf);
3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881
    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)
{
3882
    virConnectPtr conn;
3883
    DEBUG("network=%p, flags=%d", network, flags);
3884

3885
    if (!VIR_IS_NETWORK(network)) {
3886
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3887 3888 3889 3890 3891 3892 3893
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3894 3895 3896 3897 3898
    conn = network->conn;

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

3899
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3900
    return NULL;
3901
}
3902 3903 3904 3905 3906

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
3907
 * Provides a bridge interface name to which a domain may connect
3908 3909 3910 3911 3912 3913 3914 3915
 * 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)
{
3916
    virConnectPtr conn;
3917
    DEBUG("network=%p", network);
3918

3919
    if (!VIR_IS_NETWORK(network)) {
3920
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3921 3922 3923
        return (NULL);
    }

3924 3925 3926 3927 3928
    conn = network->conn;

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

3929
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3930
    return NULL;
3931
}
3932 3933 3934 3935

/**
 * virNetworkGetAutostart:
 * @network: a network object
3936
 * @autostart: the value returned
3937
 *
3938
 * Provides a boolean value indicating whether the network
3939 3940 3941 3942 3943 3944 3945
 * 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,
3946 3947 3948
                       int *autostart)
{
    virConnectPtr conn;
3949
    DEBUG("network=%p, autostart=%p", network, autostart);
3950 3951

    if (!VIR_IS_NETWORK(network)) {
3952
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3953 3954 3955 3956 3957 3958 3959
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3960 3961 3962 3963 3964
    conn = network->conn;

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

3965
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3966
    return -1;
3967 3968 3969 3970 3971
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
3972
 * @autostart: whether the network should be automatically started 0 or 1
3973 3974 3975 3976 3977 3978 3979 3980
 *
 * 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,
3981 3982 3983
                       int autostart)
{
    virConnectPtr conn;
3984
    DEBUG("network=%p, autostart=%d", network, autostart);
3985 3986

    if (!VIR_IS_NETWORK(network)) {
3987
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3988 3989 3990
        return (-1);
    }

3991 3992 3993 3994 3995
    conn = network->conn;

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

3996
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3997
    return -1;
3998
}
3999

4000 4001 4002

/**
 * virStoragePoolGetConnect:
4003
 * @pool: pointer to a pool
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 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152
 *
 * 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;
}


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 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196
/**
 * 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;
}


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 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272
/**
 * 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,
4273
                                                                 const char *uuidstr)
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 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325
{
    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
4326
 * @flags: future flags, use 0 for now
4327 4328
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
4329
 * pool is not persistent, so its definition will disappear
4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364
 * 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
4365
 * @flags: future flags, use 0 for now
4366 4367
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
4368
 * pool is persistent, until explicitly undefined.
4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402
 *
 * 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
4403
 * @flags: future flags, use 0 for now
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 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470
 *
 * 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
4471
 * @flags: future flags, use 0 for now
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 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769
 *
 * 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
4770
 * @flags: flags for XML format options (set of virDomainXMLFlags)
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 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935
 *
 * 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:
4936
 * @vol: pointer to a pool
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 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086
 *
 * 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
5087
 * unique, so the same volume will have the same
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 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144
 * 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
5145
 * @flags: future flags, use 0 for now
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 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306
 *
 * 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;
}
5307 5308 5309 5310 5311 5312 5313




/* Not for public use.  Combines the elements of a virStringList
 * into a single string.
 */
5314
char *__virStringListJoin(const virStringList *list, const char *pre,
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
                        const char *post, const char *sep)
{
    size_t pre_len = strlen(pre);
    size_t sep_len = strlen(sep);
    size_t len = pre_len + strlen(post);
    const virStringList *p;
    char *retval;

    for (p = list; p; p = p->next)
        len += p->len + sep_len;
    if (VIR_ALLOC_N(retval, len+1) < 0)
        return NULL;
    strcpy(retval, pre);
    len = pre_len;
    for (p = list; p; p = p->next) {
        strcpy(retval + len, p->val);
        len += p->len;
        strcpy(retval + len, sep);
        len += sep_len;
    }
    strcpy(retval + len, post);

    return retval;
}


5341
void __virStringListFree(virStringList *list)
5342 5343 5344 5345 5346 5347 5348
{
    while (list) {
        virStringList *p = list->next;
        VIR_FREE(list);
        list = p;
    }
}
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614

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

/**
 * __virDomainEventCallbackListFree:
 * @list: event callback list head
 *
 * Free the memory in the domain event callback list
 */
void
__virDomainEventCallbackListFree(virDomainEventCallbackListPtr list)
{
    int i;
    for (i=0; i<list->count; i++) {
        VIR_FREE(list->callbacks[i]);
    }
    VIR_FREE(list);
}
/**
 * __virDomainEventCallbackListRemove:
 * @conn: pointer to the connection
 * @cbList: the list
 * @callback: the callback to remove
 *
 * Internal function to remove a callback from a virDomainEventCallbackListPtr
 */
int
__virDomainEventCallbackListRemove(virConnectPtr conn,
                                   virDomainEventCallbackListPtr cbList,
                                   virConnectDomainEventCallback callback)
{
    int i;
    for (i = 0 ; i < cbList->count ; i++) {
        if(cbList->callbacks[i]->cb == callback &&
           cbList->callbacks[i]->conn == conn) {
            virUnrefConnect(cbList->callbacks[i]->conn);
            VIR_FREE(cbList->callbacks[i]);

            if (i < (cbList->count - 1))
                memmove(cbList->callbacks + i,
                        cbList->callbacks + i + 1,
                        sizeof(*(cbList->callbacks)) *
                                (cbList->count - (i + 1)));

            if (VIR_REALLOC_N(cbList->callbacks,
                              cbList->count - 1) < 0) {
                ; /* Failure to reduce memory allocation isn't fatal */
            }
            cbList->count--;

            return 0;
        }
    }
    return -1;
}

/**
 * __virDomainEventCallbackListAdd:
 * @conn: pointer to the connection
 * @cbList: the list
 * @callback: the callback to add
 * @opaque: opaque data tio pass to callback
 *
 * Internal function to add a callback from a virDomainEventCallbackListPtr
 */
int
__virDomainEventCallbackListAdd(virConnectPtr conn,
                                virDomainEventCallbackListPtr cbList,
                                virConnectDomainEventCallback callback,
                                void *opaque)
{
    virDomainEventCallbackPtr event;
    int n;

    /* Check incoming */
    if ( !cbList ) {
        return -1;
    }

    /* check if we already have this callback on our list */
    for (n=0; n < cbList->count; n++) {
        if(cbList->callbacks[n]->cb == callback &&
           conn == cbList->callbacks[n]->conn) {
            DEBUG0("WARNING: Callback already tracked");
            return -1;
        }
    }
    /* Allocate new event */
    if (VIR_ALLOC(event) < 0) {
        DEBUG0("Error allocating event");
        return -1;
    }
    event->conn = conn;
    event->cb = callback;
    event->opaque = opaque;

    /* Make space on list */
    n = cbList->count;
    if (VIR_REALLOC_N(cbList->callbacks, n + 1) < 0) {
        DEBUG0("Error reallocating list");
        VIR_FREE(event);
        return -1;
    }

    event->conn->refs++;

    cbList->callbacks[n] = event;
    cbList->count++;
    return 0;
}

/**
 * __virDomainEventQueueFree:
 * @queue: pointer to the queue
 *
 * Free the memory in the queue. We process this like a list here
 */
void
__virDomainEventQueueFree(virDomainEventQueuePtr queue)
{
    int i;
    for ( i=0 ; i<queue->count ; i++ ) {
        VIR_FREE(queue->events[i]);
    }
    VIR_FREE(queue);
}

/**
 * __virDomainEventCallbackQueuePop:
 * @evtQueue: the queue of events
 *
 * Internal function to pop off, and return the front of the queue
 * NOTE: The caller is responsible for freeing the returned object
 *
 * Returns: virDomainEventPtr on success NULL on failure.
 */
virDomainEventPtr
__virDomainEventCallbackQueuePop(virDomainEventQueuePtr evtQueue)
{
    virDomainEventPtr ret;

    if(!evtQueue || evtQueue->count == 0 )
        return NULL;

    ret = evtQueue->events[0];

    memmove(evtQueue->events,
            evtQueue->events + 1,
            sizeof(*(evtQueue->events)) *
                    (evtQueue->count - 1));

    if (VIR_REALLOC_N(evtQueue->events,
                        evtQueue->count - 1) < 0) {
        ; /* Failure to reduce memory allocation isn't fatal */
    }
    evtQueue->count--;

    return ret;
}

/**
 * __virDomainEventCallbackQueuePush:
 * @evtQueue: the dom event queue
 * @dom: the domain to add
 * @event: the event to add
 *
 * Internal function to push onto the back of an virDomainEventQueue
 *
 * Returns: 0 on success, -1 on failure
 */
int
__virDomainEventCallbackQueuePush(virDomainEventQueuePtr evtQueue,
                                  virDomainPtr dom,
                                  virDomainEventType event)
{
    virDomainEventPtr domEvent;

    /* Check incoming */
    if ( !evtQueue ) {
        return -1;
    }

    /* Allocate new event */
    if (VIR_ALLOC(domEvent) < 0) {
        DEBUG0("Error allocating event");
        return -1;
    }
    domEvent->dom = dom;
    domEvent->event = event;

    /* Make space on queue */
    if (VIR_REALLOC_N(evtQueue->events,
                      evtQueue->count + 1) < 0) {
        DEBUG0("Error reallocating queue");
        VIR_FREE(domEvent);
        return -1;
    }

    evtQueue->events[evtQueue->count] = domEvent;
    evtQueue->count++;
    return 0;
}