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

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

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

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

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

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

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

44
#ifndef WITH_DRIVER_MODULES
45
#ifdef WITH_TEST
46
#include "test.h"
47 48
#endif
#ifdef WITH_XEN
49
#include "xen_unified.h"
50 51
#endif
#ifdef WITH_REMOTE
52
#include "remote_internal.h"
53
#endif
54 55 56
#ifdef WITH_OPENVZ
#include "openvz_driver.h"
#endif
57
#endif
58

D
Daniel Veillard 已提交
59 60 61
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
D
Daniel Veillard 已提交
62
 * - use reference counting to guarantee coherent pointer state ?
D
Daniel Veillard 已提交
63 64
 */

65 66
#define MAX_DRIVERS 10

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

81 82 83 84 85 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
#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

114 115 116 117 118 119 120 121
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;
122
        size_t len;
123 124

        switch (cred[i].type) {
125 126 127 128
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

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

142 143 144 145
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
146 147 148 149 150
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

151 152 153 154 155 156 157
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
158 159 160
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
161 162 163 164
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
165 166 167 168 169
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

170 171 172 173
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
174 175 176

        default:
            return -1;
177 178
        }

D
Daniel P. Berrange 已提交
179 180 181 182 183 184 185 186 187
        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);
        }
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    }

    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,
203
    VIR_CRED_EXTERNAL,
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
};

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;

225 226 227 228 229 230 231 232 233 234
#if HAVE_WINSOCK2_H
static int
winsock_init (void)
{
    WORD winsock_version, err;
    WSADATA winsock_data;

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

239 240 241 242 243 244 245 246 247 248 249 250
/**
 * 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)
{
251 252 253
#ifdef ENABLE_DEBUG
    char *debugEnv;
#endif
254 255
    if (initialized)
        return(0);
256
    initialized = 1;
257

258 259 260 261 262 263 264 265
#ifdef ENABLE_DEBUG
    debugEnv = getenv("LIBVIRT_DEBUG");
    if (debugEnv && *debugEnv && *debugEnv != '0')
        debugFlag = 1;
#endif

    DEBUG0("register drivers");

266 267 268 269
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

270 271 272
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

273
    /*
274 275
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
276
     */
277 278 279 280 281 282 283 284 285 286 287
#ifdef WITH_DRIVER_MODULES
    /* We don't care if any of these fail, because the whole point
     * is to allow users to only install modules they want to use.
     * If they try to use a open a connection for a module that
     * is not loaded they'll get a suitable error at that point
     */
    virDriverLoadModule("test");
    virDriverLoadModule("xen");
    virDriverLoadModule("openvz");
    virDriverLoadModule("remote");
#else
288
#ifdef WITH_TEST
289
    if (testRegister() == -1) return -1;
290
#endif
291
#ifdef WITH_XEN
292
    if (xenRegister () == -1) return -1;
293
#endif
294 295
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
D
Daniel Veillard 已提交
296
#endif
297 298
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
299
#endif
300
#endif
D
Daniel P. Berrange 已提交
301

302 303 304 305 306
    return(0);
}



D
Daniel Veillard 已提交
307 308 309
/**
 * virLibConnError:
 * @conn: the connection if available
310
 * @error: the error number
D
Daniel Veillard 已提交
311 312 313 314 315
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
316 317
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
318
    const char *errmsg;
319

D
Daniel Veillard 已提交
320 321 322
    if (error == VIR_ERR_OK)
        return;

323 324 325
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
326 327 328
}

/**
329
 * virLibConnWarning:
D
Daniel Veillard 已提交
330
 * @conn: the connection if available
331 332 333 334 335 336 337 338 339 340 341 342 343
 * @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;

344 345 346
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
347 348 349 350 351 352
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
353 354 355 356 357
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
358 359 360
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
361 362
    virConnectPtr conn = NULL;
    const char *errmsg;
363

D
Daniel Veillard 已提交
364 365 366
    if (error == VIR_ERR_OK)
        return;

367
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
368 369 370
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
371 372
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
373 374
}

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

    if (error == VIR_ERR_OK)
        return;

393
    errmsg = virErrorMsg(error, info);
394 395 396
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
397 398
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
399 400
}

401 402 403
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
404
 * @error: the error number
405 406 407 408 409 410 411 412 413 414 415 416 417 418
 * @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;

419
    errmsg = virErrorMsg(error, info);
420 421 422
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

423 424
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
425 426 427 428 429
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
430
 * @error: the error number
431 432 433 434 435 436 437 438 439 440 441 442 443 444
 * @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;

445
    errmsg = virErrorMsg(error, info);
446 447 448
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

449 450
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
451 452
}

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
/**
 * virLibNodeDeviceError:
 * @dev: the device if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the node device level
 */
static void
virLibNodeDeviceError(virNodeDevicePtr dev, 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_NODE_DEVICE)
        conn = dev->conn;

    virRaiseError(conn, NULL, NULL, VIR_FROM_NODEDEV, error, VIR_ERR_ERROR,
                    errmsg, info, NULL, 0, 0, errmsg, info);
}

479 480 481 482 483 484 485 486 487 488 489
/**
 * 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)
{
490 491 492 493 494
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
495
        return(-1);
496 497 498
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
499 500
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
501 502
    }

503 504 505
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

506 507
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
508 509
}

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
/**
 * 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) {
530
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
531 532 533
        return(-1);
    }

534 535 536
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

537 538 539 540
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
/**
 * virRegisterDeviceMonitor:
 * @driver: pointer to a device monitor block
 *
 * Register a device monitor
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterDeviceMonitor(virDeviceMonitorPtr driver)
{
    if (virInitialize() < 0)
      return -1;

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

    if (virDeviceMonitorTabCount >= MAX_DRIVERS) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

569 570 571 572 573 574 575 576 577 578 579
/**
 * 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)
{
580 581 582 583 584
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
585
        return(-1);
586 587 588
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
589 590
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
591 592
    }

593
    if (driver->no < 0) {
594
        virLibConnError
595 596 597 598 599
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

600 601 602
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

603 604
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
605 606
}

A
Atsushi SAKAI 已提交
607
#ifdef WITH_LIBVIRTD
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
/**
 * 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) {
628
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
629 630 631 632 633 634 635
        return(-1);
    }

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

D
Daniel P. Berrange 已提交
636
int virStateInitialize(void) {
637 638 639 640 641 642
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
643 644
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
645 646 647 648 649
            ret = -1;
    }
    return ret;
}

D
Daniel P. Berrange 已提交
650
int virStateCleanup(void) {
651 652 653
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
654 655
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
656 657 658 659 660
            ret = -1;
    }
    return ret;
}

D
Daniel P. Berrange 已提交
661
int virStateReload(void) {
662 663 664
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
665 666
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
667 668 669 670 671
            ret = -1;
    }
    return ret;
}

D
Daniel P. Berrange 已提交
672
int virStateActive(void) {
673 674 675
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
676 677
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
678 679 680 681 682
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
683
#endif
684

685 686


687 688 689
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
690
 * @type: the type of connection/driver looked at
691 692 693 694 695
 * @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 已提交
696
 * @type is unknown or not available, an error code will be returned and
697 698 699 700 701 702
 * @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
703 704 705
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
706
    int i;
707
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
708

709
    if (!initialized)
710
        if (virInitialize() < 0)
711
            return -1;
712

713
    if (libVer == NULL)
714
        return (-1);
715 716 717
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
718
        if (type == NULL)
719 720 721
            type = "Xen";
        for (i = 0;i < virDriverTabCount;i++) {
            if ((virDriverTab[i] != NULL) &&
722
                (STRCASEEQ(virDriverTab[i]->name, type))) {
723 724 725 726
                *typeVer = virDriverTab[i]->ver;
                break;
            }
        }
727
        if (i >= virDriverTabCount) {
728
            *typeVer = 0;
729
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
730 731 732 733
            return (-1);
        }
    }
    return (0);
734 735
}

736
static virConnectPtr
737 738 739
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
740
{
741
    int i, res;
742 743 744 745 746
    virConnectPtr ret;

    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
747

748 749 750 751 752 753 754 755
    /*
     *  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) {
756
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
757 758
            name = defname;
        } else {
759
            name = NULL;
760
        }
761
    }
762

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
    if (name) {
        /* Convert xen -> xen:/// for back compat */
        if (STRCASEEQ(name, "xen"))
            name = "xen:///";

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

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

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
        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,
              ret->uri->scheme, ret->uri->opaque,
              ret->uri->authority, ret->uri->server,
              ret->uri->user, ret->uri->port,
              ret->uri->path);
    } else {
        DEBUG0("no name, allowing driver auto-select");
796 797
    }

798 799 800
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

801
    for (i = 0; i < virDriverTabCount; i++) {
802 803
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
804
        res = virDriverTab[i]->open (ret, auth, flags);
805 806 807 808 809
        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")));
810 811 812 813 814
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
815 816
    }

817
    if (!ret->driver) {
818 819
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
820
        goto failed;
821 822
    }

823
    for (i = 0; i < virNetworkDriverTabCount; i++) {
824
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
825 826 827 828 829
        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")));
830
        if (res == VIR_DRV_OPEN_ERROR) {
831
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
832
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
833 834
                                   "Is the daemon running ?");
            }
835 836
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
837 838 839
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
840
    }
841

842 843 844

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
845
        res = virStorageDriverTab[i]->open (ret, auth, flags);
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
#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;
        }
    }

865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
    /* Node driver (optional) */
    for (i = 0; i < virDeviceMonitorTabCount; i++) {
        res = virDeviceMonitorTab[i]->open (ret, auth, flags);
        DEBUG("node driver %d %s returned %s",
              i, virDeviceMonitorTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
        if (res == VIR_DRV_OPEN_ERROR) {
            if (STREQ(virDeviceMonitorTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_NODE,
                                   "Is the libvirtd daemon running ?");
            } else {
                char *msg;
                if (asprintf(&msg, "Is the %s daemon running?",
                             virDeviceMonitorTab[i]->name) > 0) {
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

892
    return ret;
893 894

failed:
895
    if (ret->driver) ret->driver->close (ret);
896

897
    /* If no global error was set, copy any error set
898
       in the connection object we're about to dispose of */
899 900
    if (virLastErr.code == VIR_ERR_OK) {
        memcpy(&virLastErr, &ret->err, sizeof(ret->err));
901 902 903 904
        memset(&ret->err, 0, sizeof(ret->err));
    }

    /* Still no error set, then raise a generic error */
905
    if (virLastErr.code == VIR_ERR_OK)
906 907 908 909 910
        virLibConnError (NULL, VIR_ERR_INTERNAL_ERROR,
                         _("unable to open connection"));

    virUnrefConnect(ret);

911
    return NULL;
912 913
}

914 915
/**
 * virConnectOpen:
916
 * @name: URI of the hypervisor
917
 *
918
 * This function should be called first to get a connection to the
919 920 921
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
922 923
 *
 * URIs are documented at http://libvirt.org/uri.html
924 925 926 927
 */
virConnectPtr
virConnectOpen (const char *name)
{
928 929 930 931
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

932
    DEBUG("name=%s", name);
933
    return do_open (name, NULL, 0);
934 935
}

936
/**
937
 * virConnectOpenReadOnly:
938
 * @name: URI of the hypervisor
939
 *
940
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
941
 * library functionalities. The set of APIs usable are then restricted
942
 * on the available methods to control the domains.
943 944
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
945 946
 *
 * URIs are documented at http://libvirt.org/uri.html
947
 */
948
virConnectPtr
949 950
virConnectOpenReadOnly(const char *name)
{
951 952 953 954
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

955
    DEBUG("name=%s", name);
956 957 958 959 960 961 962 963 964
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
965
 * This function should be called first to get a connection to the
966
 * Hypervisor. If necessary, authentication will be performed fetching
967 968 969 970 971 972 973 974 975 976 977
 * 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)
{
978 979 980 981 982
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

    DEBUG("name=%s, auth=%p, flags=%d", name, auth, flags);
983
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
984 985 986
}

/**
987
 * virConnectClose:
D
Daniel Veillard 已提交
988 989 990 991 992 993 994 995 996 997
 * @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
998 999
virConnectClose(virConnectPtr conn)
{
1000 1001
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
1002
    if (!VIR_IS_CONNECT(conn))
1003
        return (-1);
1004 1005 1006

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
1007 1008
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1009 1010
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1011
    conn->driver->close (conn);
1012

1013
    if (virUnrefConnect(conn) < 0)
1014
        return (-1);
1015
    return (0);
D
Daniel Veillard 已提交
1016 1017
}

1018 1019 1020 1021
/* Not for public use.  This function is part of the internal
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1022
virDrvSupportsFeature (virConnectPtr conn, int feature)
1023 1024 1025 1026 1027 1028 1029 1030 1031
{
    DEBUG("conn=%p, feature=%d", conn, feature);

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

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

1032 1033 1034 1035 1036 1037 1038
/**
 * 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.
1039 1040 1041
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1042 1043
 */
const char *
1044 1045
virConnectGetType(virConnectPtr conn)
{
1046
    const char *ret;
1047
    DEBUG("conn=%p", conn);
1048

D
Daniel Veillard 已提交
1049
    if (!VIR_IS_CONNECT(conn)) {
1050
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1051
        return (NULL);
D
Daniel Veillard 已提交
1052
    }
1053 1054 1055 1056

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1057
    }
1058
    return conn->driver->name;
1059 1060
}

D
Daniel Veillard 已提交
1061
/**
1062
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1063
 * @conn: pointer to the hypervisor connection
1064
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1065
 *
1066
 * Get the version level of the Hypervisor running. This may work only with
1067
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1068
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1069
 *
1070 1071 1072
 * 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 已提交
1073
 */
1074
int
1075 1076
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1077 1078
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
1079
    if (!VIR_IS_CONNECT(conn)) {
1080
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1081
        return (-1);
D
Daniel Veillard 已提交
1082
    }
1083

D
Daniel Veillard 已提交
1084 1085
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1086
        return (-1);
D
Daniel Veillard 已提交
1087
    }
1088

1089 1090
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
1091

1092 1093
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1094 1095
}

1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
/**
 * 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)
{
1111 1112
    DEBUG("conn=%p", conn);

1113
    if (!VIR_IS_CONNECT(conn)) {
1114
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
        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)
{
1143 1144
    char *name;

1145 1146
    DEBUG("conn=%p", conn);

1147
    if (!VIR_IS_CONNECT(conn)) {
1148
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1149 1150 1151
        return NULL;
    }

1152 1153 1154
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
1155 1156 1157
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

1158
    name = (char *)xmlSaveUri(conn->uri);
1159 1160 1161 1162 1163
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
1164 1165
}

1166 1167 1168 1169 1170
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1171
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1172 1173 1174 1175 1176 1177 1178 1179 1180
 * 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)
{
1181 1182
    DEBUG("conn=%p, type=%s", conn, type);

1183
    if (!VIR_IS_CONNECT(conn)) {
1184
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1185 1186 1187
        return (-1);
    }

1188 1189
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
1190

1191 1192
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1193 1194
}

1195
/**
1196
 * virConnectListDomains:
1197 1198 1199 1200 1201 1202 1203 1204 1205
 * @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
1206 1207
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1208 1209
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
1210
    if (!VIR_IS_CONNECT(conn)) {
1211
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1212
        return (-1);
D
Daniel Veillard 已提交
1213
    }
1214

1215
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1216
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1217
        return (-1);
D
Daniel Veillard 已提交
1218
    }
1219

1220 1221
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
1222

1223 1224
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1225 1226
}

K
 
Karel Zak 已提交
1227 1228 1229 1230
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1231 1232
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1233 1234 1235
 * Returns the number of domain found or -1 in case of error
 */
int
1236 1237
virConnectNumOfDomains(virConnectPtr conn)
{
1238 1239
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
1240
    if (!VIR_IS_CONNECT(conn)) {
1241
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1242
        return (-1);
D
Daniel Veillard 已提交
1243
    }
K
Karel Zak 已提交
1244

1245 1246
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
1247

1248 1249
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
1250 1251
}

1252 1253 1254 1255
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1256
 * Provides the connection pointer associated with a domain.  The
1257 1258 1259
 * reference counter on the connection is not increased by this
 * call.
 *
1260 1261 1262 1263
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1264 1265 1266 1267 1268
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1269 1270
    DEBUG("dom=%p", dom);

1271
    if (!VIR_IS_DOMAIN (dom)) {
1272
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1273 1274 1275 1276 1277
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1278
/**
1279
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1280
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1281
 * @xmlDesc: string containing an XML description of the domain
1282
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1283
 *
1284
 * Launch a new guest domain, based on an XML description similar
1285
 * to the one returned by virDomainGetXMLDesc()
1286
 * This function may requires privileged access to the hypervisor.
1287 1288 1289
 * 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).
1290
 *
D
Daniel Veillard 已提交
1291 1292
 * Returns a new domain object or NULL in case of failure
 */
1293
virDomainPtr
1294 1295
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1296
{
1297 1298
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
1299
    if (!VIR_IS_CONNECT(conn)) {
1300
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1301
        return (NULL);
D
Daniel Veillard 已提交
1302 1303 1304
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1305
        return (NULL);
D
Daniel Veillard 已提交
1306
    }
1307 1308
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1309
        return (NULL);
1310
    }
D
Daniel Veillard 已提交
1311

1312 1313
    if (conn->driver->domainCreateXML)
        return conn->driver->domainCreateXML (conn, xmlDesc, flags);
1314 1315 1316

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

1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
/**
 * 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));
}
1337

1338
/**
1339
 * virDomainLookupByID:
1340 1341 1342 1343
 * @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 已提交
1344 1345
 * 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.
1346
 *
1347 1348
 * 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.
1349
 */
1350
virDomainPtr
1351 1352
virDomainLookupByID(virConnectPtr conn, int id)
{
1353 1354
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
1355
    if (!VIR_IS_CONNECT(conn)) {
1356
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1357
        return (NULL);
D
Daniel Veillard 已提交
1358 1359 1360
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1361
        return (NULL);
D
Daniel Veillard 已提交
1362
    }
1363

1364 1365
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1366

1367 1368
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1369 1370 1371 1372 1373
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1374
 * @uuid: the raw UUID for the domain
1375 1376 1377
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1378 1379
 * 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.
1380 1381
 */
virDomainPtr
1382 1383
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1384 1385
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
1386
    if (!VIR_IS_CONNECT(conn)) {
1387
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1388
        return (NULL);
D
Daniel Veillard 已提交
1389 1390 1391
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1392
        return (NULL);
D
Daniel Veillard 已提交
1393
    }
1394

1395 1396
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1397

1398 1399
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1400 1401
}

K
Karel Zak 已提交
1402 1403 1404 1405 1406 1407 1408
/**
 * 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.
 *
1409 1410
 * Returns a new domain object or NULL in case of failure.  If the
 * domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
K
Karel Zak 已提交
1411 1412 1413 1414
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1415 1416
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1417 1418
    int ret;

1419 1420
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1421
    if (!VIR_IS_CONNECT(conn)) {
1422
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1423 1424 1425 1426 1427
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
1428

K
Karel Zak 已提交
1429
    }
1430 1431
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
     */
    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);
1443

1444
    if (ret!=VIR_UUID_BUFLEN) {
1445 1446
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
K
Karel Zak 已提交
1447
    }
1448
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1449
        uuid[i] = raw[i] & 0xFF;
1450

K
Karel Zak 已提交
1451 1452 1453
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1454 1455 1456 1457 1458
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1459
 * Try to lookup a domain on the given hypervisor based on its name.
1460
 *
1461 1462
 * 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.
1463 1464
 */
virDomainPtr
1465 1466
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1467 1468
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1469
    if (!VIR_IS_CONNECT(conn)) {
1470
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1471
        return (NULL);
D
Daniel Veillard 已提交
1472 1473 1474
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1475
        return (NULL);
D
Daniel Veillard 已提交
1476
    }
1477

1478 1479 1480 1481 1482
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

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

D
Daniel Veillard 已提交
1485
/**
1486
 * virDomainDestroy:
D
Daniel Veillard 已提交
1487 1488 1489
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1490 1491 1492
 * 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 已提交
1493 1494
 *
 * Returns 0 in case of success and -1 in case of failure.
1495
 */
D
Daniel Veillard 已提交
1496
int
1497 1498
virDomainDestroy(virDomainPtr domain)
{
1499
    virConnectPtr conn;
1500

1501 1502
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1503
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1504
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1505
        return (-1);
D
Daniel Veillard 已提交
1506
    }
1507

1508
    conn = domain->conn;
1509 1510
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1511
        return (-1);
1512
    }
1513

1514 1515
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1516

1517 1518
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
}

/**
 * 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
1531 1532
virDomainFree(virDomainPtr domain)
{
1533 1534
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1535
    if (!VIR_IS_DOMAIN(domain)) {
1536
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1537
        return (-1);
D
Daniel Veillard 已提交
1538
    }
1539
    if (virUnrefDomain(domain) < 0)
1540 1541
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1542 1543 1544
}

/**
1545
 * virDomainSuspend:
D
Daniel Veillard 已提交
1546 1547 1548
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1549
 * to CPU resources and I/O but the memory used by the domain at the
1550
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1551
 * the domain.
1552
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1553 1554 1555 1556
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1557 1558
virDomainSuspend(virDomainPtr domain)
{
1559
    virConnectPtr conn;
1560
    DEBUG("domain=%p", domain);
1561

D
Daniel Veillard 已提交
1562
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1563
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1564
        return (-1);
D
Daniel Veillard 已提交
1565
    }
1566 1567
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1568
        return (-1);
1569
    }
D
Daniel Veillard 已提交
1570

1571 1572
    conn = domain->conn;

1573 1574
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1575

1576 1577
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1578 1579 1580
}

/**
1581
 * virDomainResume:
D
Daniel Veillard 已提交
1582 1583 1584
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1585
 * it was frozen by calling virSuspendDomain().
1586
 * This function may requires privileged access
D
Daniel Veillard 已提交
1587 1588 1589 1590
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1591 1592
virDomainResume(virDomainPtr domain)
{
1593
    virConnectPtr conn;
1594
    DEBUG("domain=%p", domain);
1595

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

1605 1606
    conn = domain->conn;

1607 1608
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1609

1610 1611
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1612 1613
}

1614 1615 1616 1617 1618 1619
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1620 1621 1622
 * 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.
1623 1624 1625 1626
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1627 1628
virDomainSave(virDomainPtr domain, const char *to)
{
1629
    char filepath[4096];
1630
    virConnectPtr conn;
1631
    DEBUG("domain=%p, to=%s", domain, to);
1632

D
Daniel Veillard 已提交
1633
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1634
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1635
        return (-1);
D
Daniel Veillard 已提交
1636
    }
1637 1638
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1639
        return (-1);
1640
    }
1641
    conn = domain->conn;
D
Daniel Veillard 已提交
1642 1643
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1644
        return (-1);
D
Daniel Veillard 已提交
1645
    }
1646

1647 1648 1649 1650 1651
    /*
     * 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] != '/') {
1652
        unsigned int len, t;
1653

1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
        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];
1664 1665 1666

    }

1667 1668 1669
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1670
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1671
    return -1;
1672 1673 1674 1675
}

/**
 * virDomainRestore:
1676
 * @conn: pointer to the hypervisor connection
1677
 * @from: path to the
1678 1679 1680 1681 1682 1683
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1684 1685
virDomainRestore(virConnectPtr conn, const char *from)
{
1686
    char filepath[4096];
1687
    DEBUG("conn=%p, from=%s", conn, from);
1688

D
Daniel Veillard 已提交
1689
    if (!VIR_IS_CONNECT(conn)) {
1690
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1691
        return (-1);
D
Daniel Veillard 已提交
1692
    }
1693 1694
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1695
        return (-1);
1696
    }
D
Daniel Veillard 已提交
1697 1698
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1699
        return (-1);
D
Daniel Veillard 已提交
1700 1701
    }

1702 1703 1704 1705 1706
    /*
     * 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] != '/') {
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
        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];
    }

1721 1722 1723
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1724
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1725
    return -1;
D
Daniel Veillard 已提交
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1748
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1749 1750 1751 1752
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1753
        return (-1);
D
Daniel Veillard 已提交
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
    }
    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];

    }

1781 1782 1783
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1784
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1785
    return -1;
1786 1787
}

1788 1789 1790 1791 1792
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1793 1794
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1795 1796 1797 1798 1799 1800 1801
 *
 * 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
1802 1803
virDomainShutdown(virDomainPtr domain)
{
1804
    virConnectPtr conn;
1805
    DEBUG("domain=%p", domain);
1806

D
Daniel Veillard 已提交
1807
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1808
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1809
        return (-1);
D
Daniel Veillard 已提交
1810
    }
1811 1812
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1813
        return (-1);
1814
    }
1815

1816 1817
    conn = domain->conn;

1818 1819
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1820

1821
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1822
    return -1;
1823 1824
}

1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838
/**
 * 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)
{
1839
    virConnectPtr conn;
1840
    DEBUG("domain=%p, flags=%u", domain, flags);
1841 1842

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1843
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1844 1845
        return (-1);
    }
1846 1847
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1848
        return (-1);
1849
    }
1850

1851 1852
    conn = domain->conn;

1853 1854
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1855

1856
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1857
    return -1;
1858 1859
}

1860
/**
1861
 * virDomainGetName:
1862 1863 1864 1865 1866 1867 1868 1869
 * @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 *
1870 1871
virDomainGetName(virDomainPtr domain)
{
1872 1873
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1874
    if (!VIR_IS_DOMAIN(domain)) {
1875
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1876
        return (NULL);
D
Daniel Veillard 已提交
1877
    }
1878
    return (domain->name);
1879 1880
}

1881 1882 1883
/**
 * virDomainGetUUID:
 * @domain: a domain object
1884
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1885 1886 1887 1888 1889 1890
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1891 1892
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1893 1894
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1895
    if (!VIR_IS_DOMAIN(domain)) {
1896
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1897
        return (-1);
D
Daniel Veillard 已提交
1898 1899 1900
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1901
        return (-1);
D
Daniel Veillard 已提交
1902 1903
    }

1904 1905
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

1906
    return (0);
1907 1908
}

K
Karel Zak 已提交
1909 1910 1911
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1912
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1913
 *
1914
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
1915 1916 1917 1918 1919 1920 1921
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
1922
    unsigned char uuid[VIR_UUID_BUFLEN];
1923
    DEBUG("domain=%p, buf=%p", domain, buf);
1924

K
Karel Zak 已提交
1925
    if (!VIR_IS_DOMAIN(domain)) {
1926
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1927 1928 1929 1930 1931 1932
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1933

K
Karel Zak 已提交
1934
    if (virDomainGetUUID(domain, &uuid[0]))
1935
        return (-1);
K
Karel Zak 已提交
1936

1937
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1938 1939 1940
    return (0);
}

1941
/**
1942
 * virDomainGetID:
1943 1944 1945 1946 1947 1948 1949
 * @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
1950 1951
virDomainGetID(virDomainPtr domain)
{
1952 1953
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1954
    if (!VIR_IS_DOMAIN(domain)) {
1955
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1956
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1957
    }
1958
    return (domain->id);
1959 1960
}

1961 1962 1963 1964 1965 1966
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1967 1968
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
1969 1970
 */
char *
1971 1972
virDomainGetOSType(virDomainPtr domain)
{
1973
    virConnectPtr conn;
1974
    DEBUG("domain=%p", domain);
1975

D
Daniel Veillard 已提交
1976
    if (!VIR_IS_DOMAIN(domain)) {
1977
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1978
        return (NULL);
D
Daniel Veillard 已提交
1979
    }
1980

1981 1982 1983 1984
    conn = domain->conn;

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

1986
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1987
    return NULL;
1988 1989
}

1990
/**
1991
 * virDomainGetMaxMemory:
1992
 * @domain: a domain object or NULL
1993
 *
1994 1995 1996 1997 1998 1999 2000
 * 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
2001 2002
virDomainGetMaxMemory(virDomainPtr domain)
{
2003
    virConnectPtr conn;
2004
    DEBUG("domain=%p", domain);
2005

D
Daniel Veillard 已提交
2006
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2007
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2008
        return (0);
D
Daniel Veillard 已提交
2009
    }
2010

2011 2012
    conn = domain->conn;

2013 2014 2015
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

2016
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2017
    return 0;
2018 2019
}

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

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

2056 2057 2058
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

2059
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2060
    return -1;
2061
}
2062

2063 2064 2065 2066
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2067
 *
2068 2069 2070
 * 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.
2071
 * This function may requires privileged access to the hypervisor.
2072 2073 2074 2075 2076 2077 2078
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2079
    DEBUG("domain=%p, memory=%lu", domain, memory);
2080

2081 2082
    if (domain == NULL) {
        TODO
2083
        return (-1);
2084 2085
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2086
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2087
        return (-1);
2088
    }
2089 2090
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2091
        return (-1);
2092 2093 2094
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2095
        return (-1);
2096 2097 2098
    }

    conn = domain->conn;
2099

2100 2101 2102
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

2103
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2104
    return -1;
D
Daniel Veillard 已提交
2105 2106
}

2107 2108
/**
 * virDomainGetInfo:
2109
 * @domain: a domain object
2110
 * @info: pointer to a virDomainInfo structure allocated by the user
2111
 *
2112
 * Extract information about a domain. Note that if the connection
2113
 * used to get the domain is limited only a partial set of the information
2114 2115 2116 2117 2118
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2119 2120
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2121
    virConnectPtr conn;
2122
    DEBUG("domain=%p, info=%p", domain, info);
2123

D
Daniel Veillard 已提交
2124
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2125
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2126
        return (-1);
D
Daniel Veillard 已提交
2127 2128 2129
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2130
        return (-1);
D
Daniel Veillard 已提交
2131
    }
2132

2133
    memset(info, 0, sizeof(virDomainInfo));
2134

2135 2136 2137 2138
    conn = domain->conn;

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

2140
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2141
    return -1;
2142
}
2143

2144 2145 2146
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2147
 * @flags: an OR'ed set of virDomainXMLFlags
2148 2149
 *
 * Provide an XML description of the domain. The description may be reused
2150
 * later to relaunch the domain with virDomainCreateXML().
2151 2152 2153 2154 2155
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2156 2157
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2158
    virConnectPtr conn;
2159
    DEBUG("domain=%p, flags=%d", domain, flags);
2160

D
Daniel Veillard 已提交
2161
    if (!VIR_IS_DOMAIN(domain)) {
2162
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2163
        return (NULL);
D
Daniel Veillard 已提交
2164
    }
2165

2166 2167 2168 2169 2170
    conn = domain->conn;

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

2171
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2172
    return NULL;
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 2199 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 2233 2234
/**
 * 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;
D
Daniel Veillard 已提交
2235 2236
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2237 2238 2239 2240
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
2241
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2242 2243 2244 2245 2246 2247 2248 2249 2250
        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. */
D
Daniel Veillard 已提交
2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261
    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))
        version = 1;
    else if (VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn,
                                       VIR_DRV_FEATURE_MIGRATION_V2) &&
             VIR_DRV_SUPPORTS_FEATURE (dconn->driver, dconn,
                                       VIR_DRV_FEATURE_MIGRATION_V2))
        version = 2;
    else {
2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
        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.
     */
D
Daniel Veillard 已提交
2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289
    if (version == 1) {
        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,
                             _("domainMigratePrepare did not set uri"));
            goto done;
        }
        if (uri_out) uri = uri_out; /* Did domainMigratePrepare change URI? */

        assert (uri != NULL);
2290
    }
D
Daniel Veillard 已提交
2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301
    else /* if (version == 2) */ {
        /* In version 2 of the protocol, the prepare step is slightly
         * different.  We fetch the domain XML of the source domain
         * and pass it to Prepare2.
         */
        if (!conn->driver->domainDumpXML) {
            virLibConnError (conn, VIR_ERR_INTERNAL_ERROR, __FUNCTION__);
            return NULL;
        }
        dom_xml = conn->driver->domainDumpXML (domain,
                                               VIR_DOMAIN_XML_SECURE);
2302

D
Daniel Veillard 已提交
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319
        if (!dom_xml)
            return NULL;

        ret = dconn->driver->domainMigratePrepare2
            (dconn, &cookie, &cookielen, uri, &uri_out, flags, dname,
             bandwidth, dom_xml);
        free (dom_xml);
        if (ret == -1) goto done;
        if (uri == NULL && uri_out == NULL) {
            virLibConnError (conn, VIR_ERR_INTERNAL_ERROR,
                             _("domainMigratePrepare2 did not set uri"));
            goto done;
        }
        if (uri_out) uri = uri_out; /* Did domainMigratePrepare2 change URI? */

        assert (uri != NULL);
    }
2320 2321 2322 2323 2324 2325 2326

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

D
Daniel Veillard 已提交
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
    if (version == 1) {
        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);
    } else /* if (version == 2) */ {
        /* In version 2 of the migration protocol, we pass the
         * status code from the sender to the destination host,
         * so it can do any cleanup if the migration failed.
         */
        dname = dname ? dname : domain->name;
        ddomain = dconn->driver->domainMigrateFinish2
            (dconn, dname, cookie, cookielen, uri, flags, ret);
    }
2349 2350

 done:
2351 2352
    free (uri_out);
    free (cookie);
2353 2354 2355 2356 2357 2358 2359
    return ddomain;
}

/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2360
virDomainMigratePrepare (virConnectPtr dconn,
2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
                           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)) {
2372
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388
        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
D
Daniel P. Berrange 已提交
2389
virDomainMigratePerform (virDomainPtr domain,
2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400
                           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)) {
2401
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418
        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
D
Daniel P. Berrange 已提交
2419
virDomainMigrateFinish (virConnectPtr dconn,
2420 2421 2422 2423 2424 2425 2426 2427 2428
                          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)) {
2429
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
        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;
D
Daniel Veillard 已提交
2440 2441 2442 2443 2444 2445 2446
}


/* Not for public use.  This function is part of the internal
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2447 2448 2449 2450 2451 2452 2453 2454 2455
virDomainMigratePrepare2 (virConnectPtr dconn,
                          char **cookie,
                          int *cookielen,
                          const char *uri_in,
                          char **uri_out,
                          unsigned long flags,
                          const char *dname,
                          unsigned long bandwidth,
                          const char *dom_xml)
D
Daniel Veillard 已提交
2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477
{
    DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, flags=%lu, dname=%s, bandwidth=%lu, dom_xml=%s", dconn, cookie, cookielen, uri_in, uri_out, flags, dname, bandwidth, dom_xml);

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

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

    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.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2478 2479 2480 2481 2482 2483 2484
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500
{
    DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, flags=%lu, retcode=%d", dconn, dname, cookie, cookielen, uri, flags, retcode);

    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

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

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
2501 2502 2503
}


2504 2505 2506 2507
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
2508
 *
2509 2510 2511 2512 2513
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2514 2515
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2516 2517
    DEBUG("conn=%p, info=%p", conn, info);

2518
    if (!VIR_IS_CONNECT(conn)) {
2519
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2520 2521 2522 2523 2524 2525 2526
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2527 2528 2529
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2530
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2531
    return -1;
2532
}
2533

2534 2535 2536 2537 2538 2539
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2540 2541
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2542 2543 2544 2545 2546
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2547 2548
    DEBUG("conn=%p", conn);

2549
    if (!VIR_IS_CONNECT (conn)) {
2550
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2551 2552 2553
        return NULL;
    }

2554 2555
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2556

2557
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2558 2559 2560
    return NULL;
}

2561 2562 2563
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
2564
 *
D
Daniel Veillard 已提交
2565
 * provides the free memory available on the Node
2566 2567 2568 2569 2570 2571
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
2572 2573
    DEBUG("conn=%p", conn);

2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585
    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;
}

2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599
/**
 * 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;
2600
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2601 2602

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2603
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2604 2605 2606 2607 2608 2609 2610 2611 2612
        return NULL;
    }
    conn = domain->conn;

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

2613
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633
    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,
2634
                                virSchedParameterPtr params, int *nparams)
2635 2636
{
    virConnectPtr conn;
2637
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2638 2639

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2640
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2641 2642 2643 2644 2645 2646 2647
        return -1;
    }
    conn = domain->conn;

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

2648
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664
    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
2665
virDomainSetSchedulerParameters(virDomainPtr domain,
2666
                                virSchedParameterPtr params, int nparams)
2667 2668
{
    virConnectPtr conn;
2669
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2670 2671

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2672
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2673 2674
        return -1;
    }
2675 2676 2677 2678
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }
2679 2680 2681 2682 2683
    conn = domain->conn;

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

2684
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2685 2686 2687 2688
    return -1;
}


2689
/**
2690
 * virDomainBlockStats:
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724
 * @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)) {
2725
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742
        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;
}

/**
2743
 * virDomainInterfaceStats:
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
 * @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)) {
2777
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793
        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 已提交
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
/**
 * 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 已提交
2827 2828 2829 2830
 * 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 已提交
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849
 * 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;
2850

R
Richard W.M. Jones 已提交
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
    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)
2871 2872
        return conn->driver->domainBlockPeek (dom, path, offset, size,
                                              buffer, flags);
R
Richard W.M. Jones 已提交
2873 2874 2875 2876

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

R
Richard W.M. Jones 已提交
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967
/**
 * 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;
}

2968

2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979
/************************************************************************
 *									*
 *		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
 *
2980 2981 2982
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
 * virDomainUndefine().
2983 2984 2985 2986 2987
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
2988 2989
    DEBUG("conn=%p, xml=%s", conn, xml);

2990
    if (!VIR_IS_CONNECT(conn)) {
2991
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2992 2993
        return (NULL);
    }
2994 2995
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2996
        return (NULL);
2997
    }
2998 2999 3000 3001 3002
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3003 3004
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
3005

3006
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3007
    return NULL;
3008 3009 3010 3011 3012 3013
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3014
 * Undefine a domain but does not stop it if it is running
3015 3016 3017 3018 3019
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3020
    virConnectPtr conn;
3021
    DEBUG("domain=%p", domain);
3022 3023

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3024
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3025 3026
        return (-1);
    }
3027 3028
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3029
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3030
        return (-1);
3031 3032
    }

3033 3034
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
3035

3036
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3037
    return -1;
3038 3039 3040 3041 3042 3043
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3044
 * Provides the number of defined but inactive domains.
3045 3046 3047 3048 3049 3050
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3051 3052
    DEBUG("conn=%p", conn);

3053
    if (!VIR_IS_CONNECT(conn)) {
3054
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3055 3056 3057
        return (-1);
    }

3058 3059
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
3060

3061
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3062
    return -1;
3063 3064 3065 3066 3067 3068 3069 3070
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
3071 3072
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
3073
 *
3074 3075 3076
 * Returns the number of names provided in the array or -1 in case of error
 */
int
3077
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
3078
                             int maxnames) {
3079 3080
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3081
    if (!VIR_IS_CONNECT(conn)) {
3082
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3083 3084 3085
        return (-1);
    }

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

3091 3092
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
3093

3094
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3095
    return -1;
3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108
}

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

3112 3113
    if (domain == NULL) {
        TODO
3114
        return (-1);
3115
    }
3116
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3117
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3118 3119
        return (-1);
    }
3120 3121
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3122
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3123
        return (-1);
3124
    }
3125

3126 3127 3128
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

3129
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3130
    return -1;
3131 3132
}

3133 3134 3135
/**
 * virDomainGetAutostart:
 * @domain: a domain object
3136
 * @autostart: the value returned
3137
 *
3138
 * Provides a boolean value indicating whether the domain
3139 3140 3141 3142 3143 3144 3145
 * 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,
3146 3147 3148
                      int *autostart)
{
    virConnectPtr conn;
3149
    DEBUG("domain=%p, autostart=%p", domain, autostart);
3150 3151

    if (!VIR_IS_DOMAIN(domain)) {
3152
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3153 3154 3155 3156 3157 3158 3159
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3160 3161 3162 3163 3164
    conn = domain->conn;

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

3165
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3166
    return -1;
3167 3168 3169 3170 3171
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3172
 * @autostart: whether the domain should be automatically started 0 or 1
3173 3174 3175 3176 3177 3178 3179 3180
 *
 * 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,
3181 3182 3183
                      int autostart)
{
    virConnectPtr conn;
3184
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3185 3186

    if (!VIR_IS_DOMAIN(domain)) {
3187
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3188 3189 3190
        return (-1);
    }

3191 3192 3193 3194 3195
    conn = domain->conn;

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

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

3200 3201 3202 3203 3204 3205 3206 3207
/**
 * 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.
3208
 * This function requires privileged access to the hypervisor.
3209 3210 3211 3212 3213 3214 3215
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3216
    virConnectPtr conn;
3217
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3218

3219 3220
    if (domain == NULL) {
        TODO
3221
        return (-1);
3222 3223
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3224
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3225 3226
        return (-1);
    }
3227 3228
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3229
        return (-1);
3230
    }
3231

3232 3233 3234 3235
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3236
    conn = domain->conn;
3237

3238 3239
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
3240

3241
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3242
    return -1;
3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256
}

/**
 * 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.
3257
 *
3258
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
3259
 * This function requires privileged access to the hypervisor.
3260 3261 3262 3263 3264 3265 3266
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
3267
    virConnectPtr conn;
3268
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
3269

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

3283
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
3284 3285 3286
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3287

3288 3289
    conn = domain->conn;

3290 3291 3292
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

3293
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3294
    return -1;
3295 3296 3297 3298 3299 3300 3301 3302 3303
}

/**
 * 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 已提交
3304
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
3305 3306 3307 3308 3309 3310 3311
 *	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...).
3312
 *
3313
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
3314
 * and also in cpumaps if this pointer isn't NULL.
3315 3316 3317 3318 3319
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
3320
                  unsigned char *cpumaps, int maplen)
3321
{
3322
    virConnectPtr conn;
3323
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
3324 3325 3326

    if (domain == NULL) {
        TODO
3327
        return (-1);
3328 3329
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3330
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3331 3332 3333 3334 3335 3336 3337 3338 3339 3340
        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);
    }
3341

3342 3343
    conn = domain->conn;

3344 3345 3346 3347
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

3348
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3349
    return -1;
3350
}
3351

3352 3353 3354
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
3355
 *
3356 3357 3358 3359 3360
 * 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.
3361 3362 3363 3364
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
3365 3366
virDomainGetMaxVcpus(virDomainPtr domain)
{
3367
    virConnectPtr conn;
3368
    DEBUG("domain=%p", domain);
3369 3370

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3371
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3372 3373 3374 3375 3376
        return (-1);
    }

    conn = domain->conn;

3377 3378 3379
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

3380
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3381
    return -1;
3382 3383 3384
}


3385 3386 3387 3388
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3389
 *
3390 3391 3392 3393 3394
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3395
virDomainAttachDevice(virDomainPtr domain, const char *xml)
3396 3397
{
    virConnectPtr conn;
3398
    DEBUG("domain=%p, xml=%s", domain, xml);
3399 3400

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3401
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3402 3403 3404 3405
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3406
        return (-1);
3407 3408 3409
    }
    conn = domain->conn;

3410 3411 3412
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

3413
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3414
    return -1;
3415 3416 3417 3418 3419 3420
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3421
 *
3422 3423 3424 3425 3426
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3427
virDomainDetachDevice(virDomainPtr domain, const char *xml)
3428 3429
{
    virConnectPtr conn;
3430
    DEBUG("domain=%p, xml=%s", domain, xml);
3431 3432

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3433
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3434 3435 3436 3437
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3438
        return (-1);
3439 3440 3441
    }
    conn = domain->conn;

3442 3443 3444
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

3445
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3446
    return -1;
3447
}
3448

3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470
/**
 * 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)
{
3471 3472 3473
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

3474 3475 3476 3477 3478
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
3479
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490
        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;
}

3491 3492 3493 3494
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
3495
 * Provides the connection pointer associated with a network.  The
3496 3497 3498
 * reference counter on the connection is not increased by this
 * call.
 *
3499 3500 3501 3502
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
3503 3504 3505 3506 3507
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
3508 3509
    DEBUG("net=%p", net);

3510
    if (!VIR_IS_NETWORK (net)) {
3511
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3512 3513 3514 3515 3516
        return NULL;
    }
    return net->conn;
}

3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527
/**
 * 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)
{
3528 3529
    DEBUG("conn=%p", conn);

3530
    if (!VIR_IS_CONNECT(conn)) {
3531
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3532 3533 3534
        return (-1);
    }

3535 3536
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
3537

3538
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3539
    return -1;
3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552
}

/**
 * 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
3553
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
3554
{
3555 3556
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3557
    if (!VIR_IS_CONNECT(conn)) {
3558
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3559 3560 3561
        return (-1);
    }

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

3567 3568
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
3569

3570
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3571
    return -1;
3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584
}

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

3587
    if (!VIR_IS_CONNECT(conn)) {
3588
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3589 3590 3591
        return (-1);
    }

3592 3593
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
3594

3595
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3596
    return -1;
3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609
}

/**
 * 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
3610
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
3611 3612
                              int maxnames)
{
3613 3614
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3615
    if (!VIR_IS_CONNECT(conn)) {
3616
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3617 3618 3619
        return (-1);
    }

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

3625 3626 3627
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
3628

3629
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3630
    return -1;
3631 3632 3633 3634 3635 3636 3637 3638 3639
}

/**
 * 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.
 *
3640 3641
 * 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.
3642 3643 3644 3645
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3646 3647
    DEBUG("conn=%p, name=%s", conn, name);

3648
    if (!VIR_IS_CONNECT(conn)) {
3649
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3650 3651 3652 3653 3654 3655 3656
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3657 3658 3659
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

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

/**
 * 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.
 *
3671 3672
 * 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.
3673 3674 3675 3676
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3677 3678
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3679
    if (!VIR_IS_CONNECT(conn)) {
3680
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3681 3682 3683 3684 3685 3686 3687
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3688 3689
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3690

3691
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3692
    return NULL;
3693 3694 3695 3696 3697 3698 3699 3700 3701
}

/**
 * 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.
 *
3702 3703
 * 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.
3704 3705 3706 3707 3708 3709 3710
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3711
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3712 3713

    if (!VIR_IS_CONNECT(conn)) {
3714
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736
        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) {
3737 3738
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758
    }
    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)
{
3759 3760
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3761
    if (!VIR_IS_CONNECT(conn)) {
3762
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3763 3764 3765 3766 3767 3768 3769 3770
        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__);
3771
        return (NULL);
3772 3773
    }

3774 3775 3776
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3777
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3778
    return NULL;
3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790
}

/**
 * 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
3791 3792
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3793 3794
    DEBUG("conn=%p, xml=%s", conn, xml);

3795
    if (!VIR_IS_CONNECT(conn)) {
3796
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3797 3798 3799 3800
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3801
        return (NULL);
3802 3803 3804 3805 3806 3807
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3808 3809
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3810

3811
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3812
    return NULL;
3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825
}

/**
 * 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;
3826
    DEBUG("network=%p", network);
3827 3828

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3829
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3830 3831 3832 3833 3834
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3835
        return (-1);
3836 3837
    }

3838 3839
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3840

3841
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3842
    return -1;
3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854
}

/**
 * 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
3855 3856
virNetworkCreate(virNetworkPtr network)
{
3857
    virConnectPtr conn;
3858 3859
    DEBUG("network=%p", network);

3860 3861
    if (network == NULL) {
        TODO
3862
        return (-1);
3863 3864
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3865
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3866 3867 3868 3869 3870
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3871
        return (-1);
3872 3873
    }

3874 3875 3876
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3877
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3878
    return -1;
3879 3880 3881 3882 3883 3884 3885
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
3886 3887 3888
 * 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
3889 3890 3891 3892 3893 3894 3895
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
3896
    DEBUG("network=%p", network);
3897 3898

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3899
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3900 3901 3902 3903 3904 3905
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3906
        return (-1);
3907 3908
    }

3909 3910
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3911

3912
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3913
    return -1;
3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927
}

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

3930
    if (!VIR_IS_NETWORK(network)) {
3931
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3932 3933
        return (-1);
    }
3934
    if (virUnrefNetwork(network) < 0)
3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950
        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)
{
3951 3952
    DEBUG("network=%p", network);

3953
    if (!VIR_IS_NETWORK(network)) {
3954
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971
        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)
{
3972 3973
    DEBUG("network=%p, uuid=%p", network, uuid);

3974
    if (!VIR_IS_NETWORK(network)) {
3975
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
        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];
4002
    DEBUG("network=%p, buf=%p", network, buf);
4003 4004

    if (!VIR_IS_NETWORK(network)) {
4005
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4006 4007 4008 4009 4010 4011 4012 4013
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
4014
        return (-1);
4015

4016
    virUUIDFormat(uuid, buf);
4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033
    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)
{
4034
    virConnectPtr conn;
4035
    DEBUG("network=%p, flags=%d", network, flags);
4036

4037
    if (!VIR_IS_NETWORK(network)) {
4038
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4039 4040 4041 4042 4043 4044 4045
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

4046 4047 4048 4049 4050
    conn = network->conn;

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

4051
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4052
    return NULL;
4053
}
4054 4055 4056 4057 4058

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
4059
 * Provides a bridge interface name to which a domain may connect
4060 4061 4062 4063 4064 4065 4066 4067
 * 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)
{
4068
    virConnectPtr conn;
4069
    DEBUG("network=%p", network);
4070

4071
    if (!VIR_IS_NETWORK(network)) {
4072
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4073 4074 4075
        return (NULL);
    }

4076 4077 4078 4079 4080
    conn = network->conn;

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

4081
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4082
    return NULL;
4083
}
4084 4085 4086 4087

/**
 * virNetworkGetAutostart:
 * @network: a network object
4088
 * @autostart: the value returned
4089
 *
4090
 * Provides a boolean value indicating whether the network
4091 4092 4093 4094 4095 4096 4097
 * 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,
4098 4099 4100
                       int *autostart)
{
    virConnectPtr conn;
4101
    DEBUG("network=%p, autostart=%p", network, autostart);
4102 4103

    if (!VIR_IS_NETWORK(network)) {
4104
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4105 4106 4107 4108 4109 4110 4111
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

4112 4113 4114 4115 4116
    conn = network->conn;

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

4117
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4118
    return -1;
4119 4120 4121 4122 4123
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
4124
 * @autostart: whether the network should be automatically started 0 or 1
4125 4126 4127 4128 4129 4130 4131 4132
 *
 * 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,
4133 4134 4135
                       int autostart)
{
    virConnectPtr conn;
4136
    DEBUG("network=%p, autostart=%d", network, autostart);
4137 4138

    if (!VIR_IS_NETWORK(network)) {
4139
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4140 4141 4142
        return (-1);
    }

4143 4144 4145 4146 4147
    conn = network->conn;

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

4148
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4149
    return -1;
4150
}
4151

4152 4153 4154

/**
 * virStoragePoolGetConnect:
4155
 * @pool: pointer to a pool
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 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 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304
 *
 * 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;
}


4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348
/**
 * 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;
}


4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424
/**
 * 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,
4425
                                                                 const char *uuidstr)
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 4471 4472 4473 4474 4475 4476 4477
{
    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
4478
 * @flags: future flags, use 0 for now
4479 4480
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
4481
 * pool is not persistent, so its definition will disappear
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
 * 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
4517
 * @flags: future flags, use 0 for now
4518 4519
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
4520
 * pool is persistent, until explicitly undefined.
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
 *
 * 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
4555
 * @flags: future flags, use 0 for now
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
 *
 * 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
4623
 * @flags: future flags, use 0 for now
4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 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
 *
 * 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
4922
 * @flags: flags for XML format options (set of virDomainXMLFlags)
4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087
 *
 * 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:
5088
 * @vol: pointer to a pool
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 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238
 *
 * 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
5239
 * unique, so the same volume will have the same
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
 * 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
5297
 * @flags: future flags, use 0 for now
5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 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
 *
 * 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;
}
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 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712

/**
 * virNodeNumOfDevices:
 * @conn: pointer to the hypervisor connection
 * @cap: capability name
 * @flags: flags (unused, pass 0)
 *
 * Provides the number of node devices.
 *
 * If the optional 'cap'  argument is non-NULL, then the count
 * will be restricted to devices with the specified capability
 *
 * Returns the number of node devices or -1 in case of error
 */
int
virNodeNumOfDevices(virConnectPtr conn, const char *cap, unsigned int flags)
{
    DEBUG("conn=%p, cap=%s, flags=%d", conn, cap, flags);

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

    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices)
        return conn->deviceMonitor->numOfDevices (conn, cap, flags);

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


/**
 * virNodeListDevices:
 * @conn: pointer to the hypervisor connection
 * @cap: capability name
 * @names: array to collect the list of node device names
 * @maxnames: size of @names
 * @flags: flags (unused, pass 0)
 *
 * Collect the list of node devices, and store their names in @names
 *
 * If the optional 'cap'  argument is non-NULL, then the count
 * will be restricted to devices with the specified capability
 *
 * Returns the number of node devices found or -1 in case of error
 */
int
virNodeListDevices(virConnectPtr conn,
                   const char *cap,
                   char **const names, int maxnames,
                   unsigned int flags)
{
    DEBUG("conn=%p, cap=%s, names=%p, maxnames=%d, flags=%d",
          conn, cap, names, maxnames, flags);

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

    if (conn->deviceMonitor && conn->deviceMonitor->listDevices)
        return conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);

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


/**
 * virNodeDeviceLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: unique device name
 *
 * Lookup a node device by its name.
 *
 * Returns a virNodeDevicePtr if found, NULL otherwise.
 */
virNodeDevicePtr virNodeDeviceLookupByName(virConnectPtr conn, const char *name)
{
    DEBUG("conn=%p, name=%p", 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->deviceMonitor && conn->deviceMonitor->deviceLookupByName)
        return conn->deviceMonitor->deviceLookupByName (conn, name);

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


/**
 * virNodeDeviceGetXMLDesc:
 * @dev: pointer to the node device
 * @flags: flags for XML generation (unused, pass 0)
 *
 * Fetch an XML document describing all aspects of
 * the device.
 *
 * Return the XML document, or NULL on error
 */
char *virNodeDeviceGetXMLDesc(virNodeDevicePtr dev, unsigned int flags)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML)
        return dev->conn->deviceMonitor->deviceDumpXML (dev, flags);

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


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
 * Returns the device name.
 */
const char *virNodeDeviceGetName(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

    return dev->name;
}

/**
 * virNodeDeviceGetParent:
 * @dev: the device
 *
 * Returns the name of the device's parent, or NULL if the
 * device has no parent.
 */
const char *virNodeDeviceGetParent(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent)
        return dev->conn->deviceMonitor->deviceGetParent (dev);

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

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps)
        return dev->conn->deviceMonitor->deviceNumOfCaps (dev);

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

/**
 * virNodeDeviceListCaps:
 * @dev: the device
 * @names: array to collect the list of capability names
 * @maxnames: size of @names
 *
 * Lists the names of the capabilities supported by the device.
 *
 * Returns the number of capability names listed in @names.
 */
int virNodeDeviceListCaps(virNodeDevicePtr dev,
                          char **const names,
                          int maxnames)
{
    DEBUG("dev=%p, conn=%p, names=%p, maxnames=%d",
          dev, dev ? dev->conn : NULL, names, maxnames);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceListCaps)
        return dev->conn->deviceMonitor->deviceListCaps (dev, names, maxnames);

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


/**
 * virNodeDeviceFree:
 * @dev: pointer to the node device
 *
 * Drops a reference to the node device, freeing it if
 * this was the last reference.
 *
 * Returns the 0 for success, -1 for error.
 */
int virNodeDeviceFree(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return (-1);
    }
    if (virUnrefNodeDevice(dev) < 0)
        return (-1);
    return(0);
}


5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730
/*
 * 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,
5731 5732
                              void *opaque,
                              virFreeCallback freecb)
5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744
{

    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))
5745
        return conn->driver->domainEventRegister (conn, cb, opaque, freecb);
5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778
    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;
}

5779