libvirt.c 160.6 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
/**
 * 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);
    }

565 566 567
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

568 569 570 571
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

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

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

    if (virDriverTabCount >= MAX_DRIVERS) {
592 593
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
594 595
    }

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

603 604 605
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

606 607
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
608 609
}

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

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

639 640 641 642 643 644 645
/**
 * virStateInitialize:
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
646
int virStateInitialize(void) {
647 648 649 650 651 652
    int i, ret = 0;

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

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

660 661 662 663 664 665 666
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
667
int virStateCleanup(void) {
668 669 670
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
671 672
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
673 674 675 676 677
            ret = -1;
    }
    return ret;
}

678 679 680 681 682 683 684
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
685
int virStateReload(void) {
686 687 688
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
689 690
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
691 692 693 694 695
            ret = -1;
    }
    return ret;
}

696 697 698 699 700 701 702
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
 * Return 0 if none are active, 1 if at least one is.
 */
D
Daniel P. Berrange 已提交
703
int virStateActive(void) {
704 705 706
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
707 708
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
709 710 711 712 713
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
714
#endif
715

716 717


718 719 720
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
721
 * @type: the type of connection/driver looked at
722 723 724 725 726
 * @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 已提交
727
 * @type is unknown or not available, an error code will be returned and
728 729 730 731 732 733
 * @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
734 735 736
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
737
    int i;
738
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
739

740
    if (!initialized)
741
        if (virInitialize() < 0)
742
            return -1;
743

744
    if (libVer == NULL)
745
        return (-1);
746 747 748
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
749
        if (type == NULL)
750 751 752
            type = "Xen";
        for (i = 0;i < virDriverTabCount;i++) {
            if ((virDriverTab[i] != NULL) &&
753
                (STRCASEEQ(virDriverTab[i]->name, type))) {
754 755 756 757
                *typeVer = virDriverTab[i]->ver;
                break;
            }
        }
758
        if (i >= virDriverTabCount) {
759
            *typeVer = 0;
760
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
761 762 763 764
            return (-1);
        }
    }
    return (0);
765 766
}

767
static virConnectPtr
768 769 770
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
771
{
772
    int i, res;
773 774 775 776 777
    virConnectPtr ret;

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

779 780 781 782 783 784 785 786
    /*
     *  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) {
787
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
788 789
            name = defname;
        } else {
790
            name = NULL;
791
        }
792
    }
793

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810
    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;
        }
811

812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
        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");
827 828
    }

829 830 831
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

832
    for (i = 0; i < virDriverTabCount; i++) {
833 834
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
835
        res = virDriverTab[i]->open (ret, auth, flags);
836 837 838 839 840
        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")));
841 842 843 844 845
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
846 847
    }

848
    if (!ret->driver) {
849 850
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
851
        goto failed;
852 853
    }

854
    for (i = 0; i < virNetworkDriverTabCount; i++) {
855
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
856 857 858 859 860
        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")));
861
        if (res == VIR_DRV_OPEN_ERROR) {
862
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
863
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
864 865
                                   "Is the daemon running ?");
            }
866 867
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
868 869 870
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
871
    }
872

873 874 875

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
876
        res = virStorageDriverTab[i]->open (ret, auth, flags);
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
#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;
        }
    }

896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
    /* 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;
        }
    }

923
    return ret;
924 925

failed:
926
    if (ret->driver) ret->driver->close (ret);
927

928
    /* If no global error was set, copy any error set
929
       in the connection object we're about to dispose of */
930 931
    if (virLastErr.code == VIR_ERR_OK) {
        memcpy(&virLastErr, &ret->err, sizeof(ret->err));
932 933 934 935
        memset(&ret->err, 0, sizeof(ret->err));
    }

    /* Still no error set, then raise a generic error */
936
    if (virLastErr.code == VIR_ERR_OK)
937 938 939 940 941
        virLibConnError (NULL, VIR_ERR_INTERNAL_ERROR,
                         _("unable to open connection"));

    virUnrefConnect(ret);

942
    return NULL;
943 944
}

945 946
/**
 * virConnectOpen:
947
 * @name: URI of the hypervisor
948
 *
949
 * This function should be called first to get a connection to the
950 951 952
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
953 954
 *
 * URIs are documented at http://libvirt.org/uri.html
955 956 957 958
 */
virConnectPtr
virConnectOpen (const char *name)
{
959 960 961 962
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

963
    DEBUG("name=%s", name);
964
    return do_open (name, NULL, 0);
965 966
}

967
/**
968
 * virConnectOpenReadOnly:
969
 * @name: URI of the hypervisor
970
 *
971
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
972
 * library functionalities. The set of APIs usable are then restricted
973
 * on the available methods to control the domains.
974 975
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
976 977
 *
 * URIs are documented at http://libvirt.org/uri.html
978
 */
979
virConnectPtr
980 981
virConnectOpenReadOnly(const char *name)
{
982 983 984 985
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

986
    DEBUG("name=%s", name);
987 988 989 990 991 992 993 994 995
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
996
 * This function should be called first to get a connection to the
997
 * Hypervisor. If necessary, authentication will be performed fetching
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
 * 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)
{
1009 1010 1011 1012 1013
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

    DEBUG("name=%s, auth=%p, flags=%d", name, auth, flags);
1014
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1015 1016 1017
}

/**
1018
 * virConnectClose:
D
Daniel Veillard 已提交
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
 * @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
1029 1030
virConnectClose(virConnectPtr conn)
{
1031 1032
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
1033
    if (!VIR_IS_CONNECT(conn))
1034
        return (-1);
1035 1036 1037

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
1038 1039
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1040 1041
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1042
    conn->driver->close (conn);
1043

1044
    if (virUnrefConnect(conn) < 0)
1045
        return (-1);
1046
    return (0);
D
Daniel Veillard 已提交
1047 1048
}

D
Daniel Veillard 已提交
1049 1050
/*
 * Not for public use.  This function is part of the internal
1051 1052 1053
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1054
virDrvSupportsFeature (virConnectPtr conn, int feature)
1055 1056 1057 1058 1059 1060 1061 1062 1063
{
    DEBUG("conn=%p, feature=%d", conn, feature);

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

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

1064 1065 1066 1067 1068 1069 1070
/**
 * 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.
1071 1072 1073
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1074 1075
 */
const char *
1076 1077
virConnectGetType(virConnectPtr conn)
{
1078
    const char *ret;
1079
    DEBUG("conn=%p", conn);
1080

D
Daniel Veillard 已提交
1081
    if (!VIR_IS_CONNECT(conn)) {
1082
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1083
        return (NULL);
D
Daniel Veillard 已提交
1084
    }
1085 1086 1087 1088

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1089
    }
1090
    return conn->driver->name;
1091 1092
}

D
Daniel Veillard 已提交
1093
/**
1094
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1095
 * @conn: pointer to the hypervisor connection
1096
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1097
 *
1098
 * Get the version level of the Hypervisor running. This may work only with
1099
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1100
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1101
 *
1102 1103 1104
 * 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 已提交
1105
 */
1106
int
1107 1108
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1109 1110
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
1111
    if (!VIR_IS_CONNECT(conn)) {
1112
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1113
        return (-1);
D
Daniel Veillard 已提交
1114
    }
1115

D
Daniel Veillard 已提交
1116 1117
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1118
        return (-1);
D
Daniel Veillard 已提交
1119
    }
1120

1121 1122
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
1123

1124 1125
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1126 1127
}

1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
/**
 * 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)
{
1143 1144
    DEBUG("conn=%p", conn);

1145
    if (!VIR_IS_CONNECT(conn)) {
1146
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
        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)
{
1175 1176
    char *name;

1177 1178
    DEBUG("conn=%p", conn);

1179
    if (!VIR_IS_CONNECT(conn)) {
1180
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1181 1182 1183
        return NULL;
    }

1184 1185 1186
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
1187 1188 1189
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

1190
    name = (char *)xmlSaveUri(conn->uri);
1191 1192 1193 1194 1195
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
1196 1197
}

1198 1199 1200 1201 1202
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1203
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1204 1205 1206 1207 1208 1209 1210 1211 1212
 * 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)
{
1213 1214
    DEBUG("conn=%p, type=%s", conn, type);

1215
    if (!VIR_IS_CONNECT(conn)) {
1216
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1217 1218 1219
        return (-1);
    }

1220 1221
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
1222

1223 1224
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1225 1226
}

1227
/**
1228
 * virConnectListDomains:
1229 1230 1231 1232 1233 1234 1235 1236 1237
 * @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
1238 1239
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1240 1241
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
1242
    if (!VIR_IS_CONNECT(conn)) {
1243
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1244
        return (-1);
D
Daniel Veillard 已提交
1245
    }
1246

1247
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1248
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1249
        return (-1);
D
Daniel Veillard 已提交
1250
    }
1251

1252 1253
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
1254

1255 1256
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1257 1258
}

K
 
Karel Zak 已提交
1259 1260 1261 1262
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1263 1264
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1265 1266 1267
 * Returns the number of domain found or -1 in case of error
 */
int
1268 1269
virConnectNumOfDomains(virConnectPtr conn)
{
1270 1271
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
1272
    if (!VIR_IS_CONNECT(conn)) {
1273
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1274
        return (-1);
D
Daniel Veillard 已提交
1275
    }
K
Karel Zak 已提交
1276

1277 1278
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
1279

1280 1281
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
1282 1283
}

1284 1285 1286 1287
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1288
 * Provides the connection pointer associated with a domain.  The
1289 1290 1291
 * reference counter on the connection is not increased by this
 * call.
 *
1292 1293 1294 1295
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1296 1297 1298 1299 1300
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1301 1302
    DEBUG("dom=%p", dom);

1303
    if (!VIR_IS_DOMAIN (dom)) {
1304
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1305 1306 1307 1308 1309
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1310
/**
1311
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1312
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1313
 * @xmlDesc: string containing an XML description of the domain
1314
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1315
 *
1316
 * Launch a new guest domain, based on an XML description similar
1317
 * to the one returned by virDomainGetXMLDesc()
1318
 * This function may requires privileged access to the hypervisor.
1319 1320 1321
 * 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).
1322
 *
D
Daniel Veillard 已提交
1323 1324
 * Returns a new domain object or NULL in case of failure
 */
1325
virDomainPtr
1326 1327
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1328
{
1329 1330
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
1331
    if (!VIR_IS_CONNECT(conn)) {
1332
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1333
        return (NULL);
D
Daniel Veillard 已提交
1334 1335 1336
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1337
        return (NULL);
D
Daniel Veillard 已提交
1338
    }
1339 1340
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1341
        return (NULL);
1342
    }
D
Daniel Veillard 已提交
1343

1344 1345
    if (conn->driver->domainCreateXML)
        return conn->driver->domainCreateXML (conn, xmlDesc, flags);
1346 1347 1348

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

1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368
/**
 * 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));
}
1369

1370
/**
1371
 * virDomainLookupByID:
1372 1373 1374 1375
 * @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 已提交
1376 1377
 * 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.
1378
 *
1379 1380
 * 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.
1381
 */
1382
virDomainPtr
1383 1384
virDomainLookupByID(virConnectPtr conn, int id)
{
1385 1386
    DEBUG("conn=%p, id=%d", conn, id);

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

1396 1397
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1398

1399 1400
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1401 1402 1403 1404 1405
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1406
 * @uuid: the raw UUID for the domain
1407 1408 1409
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1410 1411
 * 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.
1412 1413
 */
virDomainPtr
1414 1415
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1416 1417
    DEBUG("conn=%p, uuid=%s", conn, uuid);

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

1427 1428
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1429

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

K
Karel Zak 已提交
1434 1435 1436 1437 1438 1439 1440
/**
 * 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.
 *
1441 1442
 * 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 已提交
1443 1444 1445 1446
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1447 1448
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1449 1450
    int ret;

1451 1452
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1453
    if (!VIR_IS_CONNECT(conn)) {
1454
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1455 1456 1457 1458 1459
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
1460

K
Karel Zak 已提交
1461
    }
1462 1463
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
     */
    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);
1475

1476
    if (ret!=VIR_UUID_BUFLEN) {
1477 1478
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
K
Karel Zak 已提交
1479
    }
1480
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1481
        uuid[i] = raw[i] & 0xFF;
1482

K
Karel Zak 已提交
1483 1484 1485
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1486 1487 1488 1489 1490
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1491
 * Try to lookup a domain on the given hypervisor based on its name.
1492
 *
1493 1494
 * 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.
1495 1496
 */
virDomainPtr
1497 1498
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1499 1500
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1501
    if (!VIR_IS_CONNECT(conn)) {
1502
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1503
        return (NULL);
D
Daniel Veillard 已提交
1504 1505 1506
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1507
        return (NULL);
D
Daniel Veillard 已提交
1508
    }
1509

1510 1511 1512 1513 1514
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

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

D
Daniel Veillard 已提交
1517
/**
1518
 * virDomainDestroy:
D
Daniel Veillard 已提交
1519 1520 1521
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1522 1523 1524
 * 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 已提交
1525 1526
 *
 * Returns 0 in case of success and -1 in case of failure.
1527
 */
D
Daniel Veillard 已提交
1528
int
1529 1530
virDomainDestroy(virDomainPtr domain)
{
1531
    virConnectPtr conn;
1532

1533 1534
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1535
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1536
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1537
        return (-1);
D
Daniel Veillard 已提交
1538
    }
1539

1540
    conn = domain->conn;
1541 1542
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1543
        return (-1);
1544
    }
1545

1546 1547
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1548

1549 1550
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
}

/**
 * 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
1563 1564
virDomainFree(virDomainPtr domain)
{
1565 1566
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1567
    if (!VIR_IS_DOMAIN(domain)) {
1568
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1569
        return (-1);
D
Daniel Veillard 已提交
1570
    }
1571
    if (virUnrefDomain(domain) < 0)
1572 1573
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1574 1575 1576
}

/**
1577
 * virDomainSuspend:
D
Daniel Veillard 已提交
1578 1579 1580
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1581
 * to CPU resources and I/O but the memory used by the domain at the
1582
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1583
 * the domain.
1584
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1585 1586 1587 1588
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1589 1590
virDomainSuspend(virDomainPtr domain)
{
1591
    virConnectPtr conn;
1592
    DEBUG("domain=%p", domain);
1593

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

1603 1604
    conn = domain->conn;

1605 1606
    if (conn->driver->domainSuspend)
        return conn->driver->domainSuspend (domain);
1607

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

/**
1613
 * virDomainResume:
D
Daniel Veillard 已提交
1614 1615 1616
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1617
 * it was frozen by calling virSuspendDomain().
1618
 * This function may requires privileged access
D
Daniel Veillard 已提交
1619 1620 1621 1622
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1623 1624
virDomainResume(virDomainPtr domain)
{
1625
    virConnectPtr conn;
1626
    DEBUG("domain=%p", domain);
1627

D
Daniel Veillard 已提交
1628
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1629
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1630
        return (-1);
D
Daniel Veillard 已提交
1631
    }
1632 1633
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1634
        return (-1);
1635
    }
D
Daniel Veillard 已提交
1636

1637 1638
    conn = domain->conn;

1639 1640
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1641

1642 1643
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1644 1645
}

1646 1647 1648 1649 1650 1651
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1652 1653 1654
 * 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.
1655 1656 1657 1658
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1659 1660
virDomainSave(virDomainPtr domain, const char *to)
{
1661
    char filepath[4096];
1662
    virConnectPtr conn;
1663
    DEBUG("domain=%p, to=%s", domain, to);
1664

D
Daniel Veillard 已提交
1665
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1666
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1667
        return (-1);
D
Daniel Veillard 已提交
1668
    }
1669 1670
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1671
        return (-1);
1672
    }
1673
    conn = domain->conn;
D
Daniel Veillard 已提交
1674 1675
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1676
        return (-1);
D
Daniel Veillard 已提交
1677
    }
1678

1679 1680 1681 1682 1683
    /*
     * 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] != '/') {
1684
        unsigned int len, t;
1685

1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
        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];
1696 1697 1698

    }

1699 1700 1701
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1702
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1703
    return -1;
1704 1705 1706 1707
}

/**
 * virDomainRestore:
1708
 * @conn: pointer to the hypervisor connection
1709
 * @from: path to the
1710 1711 1712 1713 1714 1715
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1716 1717
virDomainRestore(virConnectPtr conn, const char *from)
{
1718
    char filepath[4096];
1719
    DEBUG("conn=%p, from=%s", conn, from);
1720

D
Daniel Veillard 已提交
1721
    if (!VIR_IS_CONNECT(conn)) {
1722
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1723
        return (-1);
D
Daniel Veillard 已提交
1724
    }
1725 1726
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1727
        return (-1);
1728
    }
D
Daniel Veillard 已提交
1729 1730
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1731
        return (-1);
D
Daniel Veillard 已提交
1732 1733
    }

1734 1735 1736 1737 1738
    /*
     * 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] != '/') {
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
        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];
    }

1753 1754 1755
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1756
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1757
    return -1;
D
Daniel Veillard 已提交
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1780
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1781 1782 1783 1784
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1785
        return (-1);
D
Daniel Veillard 已提交
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812
    }
    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];

    }

1813 1814 1815
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

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

1820 1821 1822 1823 1824
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1825 1826
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1827 1828 1829 1830 1831 1832 1833
 *
 * 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
1834 1835
virDomainShutdown(virDomainPtr domain)
{
1836
    virConnectPtr conn;
1837
    DEBUG("domain=%p", domain);
1838

D
Daniel Veillard 已提交
1839
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1840
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1841
        return (-1);
D
Daniel Veillard 已提交
1842
    }
1843 1844
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1845
        return (-1);
1846
    }
1847

1848 1849
    conn = domain->conn;

1850 1851
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1852

1853
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1854
    return -1;
1855 1856
}

1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
/**
 * 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)
{
1871
    virConnectPtr conn;
1872
    DEBUG("domain=%p, flags=%u", domain, flags);
1873 1874

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1875
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1876 1877
        return (-1);
    }
1878 1879
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1880
        return (-1);
1881
    }
1882

1883 1884
    conn = domain->conn;

1885 1886
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1887

1888
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1889
    return -1;
1890 1891
}

1892
/**
1893
 * virDomainGetName:
1894 1895 1896 1897 1898 1899 1900 1901
 * @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 *
1902 1903
virDomainGetName(virDomainPtr domain)
{
1904 1905
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1906
    if (!VIR_IS_DOMAIN(domain)) {
1907
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1908
        return (NULL);
D
Daniel Veillard 已提交
1909
    }
1910
    return (domain->name);
1911 1912
}

1913 1914 1915
/**
 * virDomainGetUUID:
 * @domain: a domain object
1916
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1917 1918 1919 1920 1921 1922
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1923 1924
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1925 1926
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1927
    if (!VIR_IS_DOMAIN(domain)) {
1928
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1929
        return (-1);
D
Daniel Veillard 已提交
1930 1931 1932
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1933
        return (-1);
D
Daniel Veillard 已提交
1934 1935
    }

1936 1937
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

1938
    return (0);
1939 1940
}

K
Karel Zak 已提交
1941 1942 1943
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1944
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1945
 *
1946
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
1947 1948 1949 1950 1951 1952 1953
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
1954
    unsigned char uuid[VIR_UUID_BUFLEN];
1955
    DEBUG("domain=%p, buf=%p", domain, buf);
1956

K
Karel Zak 已提交
1957
    if (!VIR_IS_DOMAIN(domain)) {
1958
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1959 1960 1961 1962 1963 1964
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1965

K
Karel Zak 已提交
1966
    if (virDomainGetUUID(domain, &uuid[0]))
1967
        return (-1);
K
Karel Zak 已提交
1968

1969
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
1970 1971 1972
    return (0);
}

1973
/**
1974
 * virDomainGetID:
1975 1976 1977 1978 1979 1980 1981
 * @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
1982 1983
virDomainGetID(virDomainPtr domain)
{
1984 1985
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1986
    if (!VIR_IS_DOMAIN(domain)) {
1987
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1988
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
1989
    }
1990
    return (domain->id);
1991 1992
}

1993 1994 1995 1996 1997 1998
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
1999 2000
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2001 2002
 */
char *
2003 2004
virDomainGetOSType(virDomainPtr domain)
{
2005
    virConnectPtr conn;
2006
    DEBUG("domain=%p", domain);
2007

D
Daniel Veillard 已提交
2008
    if (!VIR_IS_DOMAIN(domain)) {
2009
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2010
        return (NULL);
D
Daniel Veillard 已提交
2011
    }
2012

2013 2014 2015 2016
    conn = domain->conn;

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

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

2022
/**
2023
 * virDomainGetMaxMemory:
2024
 * @domain: a domain object or NULL
2025
 *
2026 2027 2028 2029 2030 2031 2032
 * 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
2033 2034
virDomainGetMaxMemory(virDomainPtr domain)
{
2035
    virConnectPtr conn;
2036
    DEBUG("domain=%p", domain);
2037

D
Daniel Veillard 已提交
2038
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2039
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2040
        return (0);
D
Daniel Veillard 已提交
2041
    }
2042

2043 2044
    conn = domain->conn;

2045 2046 2047
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

2048
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2049
    return 0;
2050 2051
}

D
Daniel Veillard 已提交
2052
/**
2053
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2054 2055
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2056
 *
D
Daniel Veillard 已提交
2057 2058 2059
 * 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.
2060
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2061 2062 2063 2064
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2065 2066
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2067
    virConnectPtr conn;
2068
    DEBUG("domain=%p, memory=%lu", domain, memory);
2069

2070 2071
    if (domain == NULL) {
        TODO
2072
        return (-1);
2073 2074
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2075
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2076
        return (-1);
2077
    }
2078 2079
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2080
        return (-1);
2081 2082 2083 2084 2085
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2086
    conn = domain->conn;
2087

2088 2089 2090
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

2091
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2092
    return -1;
2093
}
2094

2095 2096 2097 2098
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2099
 *
2100 2101 2102
 * 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.
2103
 * This function may requires privileged access to the hypervisor.
2104 2105 2106 2107 2108 2109 2110
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2111
    DEBUG("domain=%p, memory=%lu", domain, memory);
2112

2113 2114
    if (domain == NULL) {
        TODO
2115
        return (-1);
2116 2117
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2118
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2119
        return (-1);
2120
    }
2121 2122
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2123
        return (-1);
2124 2125 2126
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2127
        return (-1);
2128 2129 2130
    }

    conn = domain->conn;
2131

2132 2133 2134
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

2135
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2136
    return -1;
D
Daniel Veillard 已提交
2137 2138
}

2139 2140
/**
 * virDomainGetInfo:
2141
 * @domain: a domain object
2142
 * @info: pointer to a virDomainInfo structure allocated by the user
2143
 *
2144
 * Extract information about a domain. Note that if the connection
2145
 * used to get the domain is limited only a partial set of the information
2146 2147 2148 2149 2150
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2151 2152
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2153
    virConnectPtr conn;
2154
    DEBUG("domain=%p, info=%p", domain, info);
2155

D
Daniel Veillard 已提交
2156
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2157
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2158
        return (-1);
D
Daniel Veillard 已提交
2159 2160 2161
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2162
        return (-1);
D
Daniel Veillard 已提交
2163
    }
2164

2165
    memset(info, 0, sizeof(virDomainInfo));
2166

2167 2168 2169 2170
    conn = domain->conn;

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

2172
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2173
    return -1;
2174
}
2175

2176 2177 2178
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2179
 * @flags: an OR'ed set of virDomainXMLFlags
2180 2181
 *
 * Provide an XML description of the domain. The description may be reused
2182
 * later to relaunch the domain with virDomainCreateXML().
2183 2184 2185 2186 2187
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2188 2189
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2190
    virConnectPtr conn;
2191
    DEBUG("domain=%p, flags=%d", domain, flags);
2192

D
Daniel Veillard 已提交
2193
    if (!VIR_IS_DOMAIN(domain)) {
2194
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2195
        return (NULL);
D
Daniel Veillard 已提交
2196
    }
2197

2198 2199 2200 2201 2202
    conn = domain->conn;

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

2203
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2204
    return NULL;
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 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
/**
 * 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 已提交
2267 2268
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2269 2270 2271 2272
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
2273
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2274 2275 2276 2277 2278 2279 2280 2281 2282
        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 已提交
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293
    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 {
2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
        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 已提交
2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
    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);
2322
    }
D
Daniel Veillard 已提交
2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333
    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);
2334

D
Daniel Veillard 已提交
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351
        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);
    }
2352 2353 2354 2355 2356 2357 2358

    /* 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 已提交
2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
    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);
    }
2381 2382

 done:
2383 2384
    free (uri_out);
    free (cookie);
2385 2386 2387
    return ddomain;
}

D
Daniel Veillard 已提交
2388 2389
/*
 * Not for public use.  This function is part of the internal
2390 2391 2392
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2393
virDomainMigratePrepare (virConnectPtr dconn,
2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404
                           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)) {
2405
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417
        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;
}

D
Daniel Veillard 已提交
2418 2419
/*
 * Not for public use.  This function is part of the internal
2420 2421 2422
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2423
virDomainMigratePerform (virDomainPtr domain,
2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
                           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)) {
2435
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
        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;
}

D
Daniel Veillard 已提交
2449 2450
/*
 * Not for public use.  This function is part of the internal
2451 2452 2453
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2454
virDomainMigrateFinish (virConnectPtr dconn,
2455 2456 2457 2458 2459 2460 2461 2462 2463
                          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)) {
2464
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2465 2466 2467 2468 2469 2470 2471 2472 2473 2474
        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 已提交
2475 2476 2477
}


D
Daniel Veillard 已提交
2478 2479
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2480 2481 2482
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2483 2484 2485 2486 2487 2488 2489 2490 2491
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 已提交
2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509
{
    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;
}

D
Daniel Veillard 已提交
2510 2511
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2512 2513 2514
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2515 2516 2517 2518 2519 2520 2521
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537
{
    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;
2538 2539 2540
}


2541 2542 2543 2544
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
2545
 *
2546 2547 2548 2549 2550
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2551 2552
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2553 2554
    DEBUG("conn=%p, info=%p", conn, info);

2555
    if (!VIR_IS_CONNECT(conn)) {
2556
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2557 2558 2559 2560 2561 2562 2563
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2564 2565 2566
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2567
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2568
    return -1;
2569
}
2570

2571 2572 2573 2574 2575 2576
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2577 2578
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2579 2580 2581 2582 2583
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2584 2585
    DEBUG("conn=%p", conn);

2586
    if (!VIR_IS_CONNECT (conn)) {
2587
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2588 2589 2590
        return NULL;
    }

2591 2592
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2593

2594
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2595 2596 2597
    return NULL;
}

2598 2599 2600
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
2601
 *
D
Daniel Veillard 已提交
2602
 * provides the free memory available on the Node
2603 2604 2605 2606 2607 2608
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
2609 2610
    DEBUG("conn=%p", conn);

2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
    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;
}

2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
/**
 * 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;
2637
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2638 2639

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

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

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2677
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2678 2679 2680 2681 2682 2683 2684
        return -1;
    }
    conn = domain->conn;

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

2685
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
    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
2702
virDomainSetSchedulerParameters(virDomainPtr domain,
2703
                                virSchedParameterPtr params, int nparams)
2704 2705
{
    virConnectPtr conn;
2706
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2707 2708

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2709
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2710 2711
        return -1;
    }
2712 2713 2714 2715
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }
2716 2717 2718 2719 2720
    conn = domain->conn;

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

2721
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2722 2723 2724 2725
    return -1;
}


2726
/**
2727
 * virDomainBlockStats:
2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761
 * @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)) {
2762
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779
        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;
}

/**
2780
 * virDomainInterfaceStats:
2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813
 * @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)) {
2814
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
        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 已提交
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
/**
 * 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 已提交
2864 2865 2866 2867
 * 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 已提交
2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886
 * 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;
2887

R
Richard W.M. Jones 已提交
2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907
    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)
2908 2909
        return conn->driver->domainBlockPeek (dom, path, offset, size,
                                              buffer, flags);
R
Richard W.M. Jones 已提交
2910 2911 2912 2913

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

R
Richard W.M. Jones 已提交
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 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004
/**
 * 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;
}

3005

3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016
/************************************************************************
 *									*
 *		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
 *
3017 3018 3019
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
 * virDomainUndefine().
3020 3021 3022 3023 3024
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3025 3026
    DEBUG("conn=%p, xml=%s", conn, xml);

3027
    if (!VIR_IS_CONNECT(conn)) {
3028
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3029 3030
        return (NULL);
    }
3031 3032
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3033
        return (NULL);
3034
    }
3035 3036 3037 3038 3039
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3040 3041
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
3042

3043
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3044
    return NULL;
3045 3046 3047 3048 3049 3050
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3051
 * Undefine a domain but does not stop it if it is running
3052 3053 3054 3055 3056
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3057
    virConnectPtr conn;
3058
    DEBUG("domain=%p", domain);
3059 3060

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

3070 3071
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
3072

3073
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3074
    return -1;
3075 3076 3077 3078 3079 3080
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3081
 * Provides the number of defined but inactive domains.
3082 3083 3084 3085 3086 3087
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3088 3089
    DEBUG("conn=%p", conn);

3090
    if (!VIR_IS_CONNECT(conn)) {
3091
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3092 3093 3094
        return (-1);
    }

3095 3096
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
3097

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

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
3108 3109
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
3110
 *
3111 3112 3113
 * Returns the number of names provided in the array or -1 in case of error
 */
int
3114
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
3115
                             int maxnames) {
3116 3117
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3118
    if (!VIR_IS_CONNECT(conn)) {
3119
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3120 3121 3122
        return (-1);
    }

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

3128 3129
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
3130

3131
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3132
    return -1;
3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145
}

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

3149 3150
    if (domain == NULL) {
        TODO
3151
        return (-1);
3152
    }
3153
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3154
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3155 3156
        return (-1);
    }
3157 3158
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3159
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3160
        return (-1);
3161
    }
3162

3163 3164 3165
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

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

3170 3171 3172
/**
 * virDomainGetAutostart:
 * @domain: a domain object
3173
 * @autostart: the value returned
3174
 *
3175
 * Provides a boolean value indicating whether the domain
3176 3177 3178 3179 3180 3181 3182
 * 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,
3183 3184 3185
                      int *autostart)
{
    virConnectPtr conn;
3186
    DEBUG("domain=%p, autostart=%p", domain, autostart);
3187 3188

    if (!VIR_IS_DOMAIN(domain)) {
3189
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3190 3191 3192 3193 3194 3195 3196
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3197 3198 3199 3200 3201
    conn = domain->conn;

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

3202
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3203
    return -1;
3204 3205 3206 3207 3208
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3209
 * @autostart: whether the domain should be automatically started 0 or 1
3210 3211 3212 3213 3214 3215 3216 3217
 *
 * 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,
3218 3219 3220
                      int autostart)
{
    virConnectPtr conn;
3221
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3222 3223

    if (!VIR_IS_DOMAIN(domain)) {
3224
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3225 3226 3227
        return (-1);
    }

3228 3229 3230 3231 3232
    conn = domain->conn;

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

3233
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3234
    return -1;
3235 3236
}

3237 3238 3239 3240 3241 3242 3243 3244
/**
 * 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.
3245
 * This function requires privileged access to the hypervisor.
3246 3247 3248 3249 3250 3251 3252
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3253
    virConnectPtr conn;
3254
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3255

3256 3257
    if (domain == NULL) {
        TODO
3258
        return (-1);
3259 3260
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3261
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3262 3263
        return (-1);
    }
3264 3265
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3266
        return (-1);
3267
    }
3268

3269 3270 3271 3272
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3273
    conn = domain->conn;
3274

3275 3276
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
3277

3278
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3279
    return -1;
3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293
}

/**
 * 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.
3294
 *
3295
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
3296
 * This function requires privileged access to the hypervisor.
3297 3298 3299 3300 3301 3302 3303
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
3304
    virConnectPtr conn;
3305
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
3306

3307 3308
    if (domain == NULL) {
        TODO
3309
        return (-1);
3310 3311
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3312
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3313 3314
        return (-1);
    }
3315 3316
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3317
        return (-1);
3318
    }
3319

3320
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
3321 3322 3323
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3324

3325 3326
    conn = domain->conn;

3327 3328 3329
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

3330
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3331
    return -1;
3332 3333 3334 3335 3336 3337 3338 3339 3340
}

/**
 * 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 已提交
3341
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
3342 3343 3344 3345 3346 3347 3348
 *	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...).
3349
 *
3350
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
3351
 * and also in cpumaps if this pointer isn't NULL.
3352 3353 3354 3355 3356
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
3357
                  unsigned char *cpumaps, int maplen)
3358
{
3359
    virConnectPtr conn;
3360
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
3361 3362 3363

    if (domain == NULL) {
        TODO
3364
        return (-1);
3365 3366
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3367
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3368 3369 3370 3371 3372 3373 3374 3375 3376 3377
        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);
    }
3378

3379 3380
    conn = domain->conn;

3381 3382 3383 3384
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

3385
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3386
    return -1;
3387
}
3388

3389 3390 3391
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
3392
 *
3393 3394 3395 3396 3397
 * 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.
3398 3399 3400 3401
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
3402 3403
virDomainGetMaxVcpus(virDomainPtr domain)
{
3404
    virConnectPtr conn;
3405
    DEBUG("domain=%p", domain);
3406 3407

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3408
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3409 3410 3411 3412 3413
        return (-1);
    }

    conn = domain->conn;

3414 3415 3416
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

3417
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3418
    return -1;
3419 3420 3421
}


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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3438
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3439 3440 3441 3442
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3443
        return (-1);
3444 3445 3446
    }
    conn = domain->conn;

3447 3448 3449
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

3450
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3451
    return -1;
3452 3453 3454 3455 3456 3457
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3458
 *
3459 3460 3461 3462 3463
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3464
virDomainDetachDevice(virDomainPtr domain, const char *xml)
3465 3466
{
    virConnectPtr conn;
3467
    DEBUG("domain=%p, xml=%s", domain, xml);
3468 3469

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3470
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3471 3472 3473 3474
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3475
        return (-1);
3476 3477 3478
    }
    conn = domain->conn;

3479 3480 3481
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

3482
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3483
    return -1;
3484
}
3485

3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507
/**
 * 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)
{
3508 3509 3510
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

3511 3512 3513 3514 3515
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
3516
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527
        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;
}

3528 3529 3530 3531
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
3532
 * Provides the connection pointer associated with a network.  The
3533 3534 3535
 * reference counter on the connection is not increased by this
 * call.
 *
3536 3537 3538 3539
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
3540 3541 3542 3543 3544
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
3545 3546
    DEBUG("net=%p", net);

3547
    if (!VIR_IS_NETWORK (net)) {
3548
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3549 3550 3551 3552 3553
        return NULL;
    }
    return net->conn;
}

3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564
/**
 * 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)
{
3565 3566
    DEBUG("conn=%p", conn);

3567
    if (!VIR_IS_CONNECT(conn)) {
3568
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3569 3570 3571
        return (-1);
    }

3572 3573
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
3574

3575
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3576
    return -1;
3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589
}

/**
 * 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
3590
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
3591
{
3592 3593
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3594
    if (!VIR_IS_CONNECT(conn)) {
3595
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3596 3597 3598
        return (-1);
    }

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

3604 3605
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
3606

3607
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3608
    return -1;
3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621
}

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

3624
    if (!VIR_IS_CONNECT(conn)) {
3625
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3626 3627 3628
        return (-1);
    }

3629 3630
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
3631

3632
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3633
    return -1;
3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646
}

/**
 * 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
3647
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
3648 3649
                              int maxnames)
{
3650 3651
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3652
    if (!VIR_IS_CONNECT(conn)) {
3653
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3654 3655 3656
        return (-1);
    }

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

3662 3663 3664
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
3665

3666
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3667
    return -1;
3668 3669 3670 3671 3672 3673 3674 3675 3676
}

/**
 * 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.
 *
3677 3678
 * 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.
3679 3680 3681 3682
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3683 3684
    DEBUG("conn=%p, name=%s", conn, name);

3685
    if (!VIR_IS_CONNECT(conn)) {
3686
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3687 3688 3689 3690 3691 3692 3693
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3694 3695 3696
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

3697
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3698
    return NULL;
3699 3700 3701 3702 3703 3704 3705 3706 3707
}

/**
 * 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.
 *
3708 3709
 * 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.
3710 3711 3712 3713
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3714 3715
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3716
    if (!VIR_IS_CONNECT(conn)) {
3717
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3718 3719 3720 3721 3722 3723 3724
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3725 3726
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3727

3728
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3729
    return NULL;
3730 3731 3732 3733 3734 3735 3736 3737 3738
}

/**
 * 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.
 *
3739 3740
 * 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.
3741 3742 3743 3744 3745 3746 3747
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3748
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3749 3750

    if (!VIR_IS_CONNECT(conn)) {
3751
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773
        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) {
3774 3775
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
    }
    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)
{
3796 3797
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3798
    if (!VIR_IS_CONNECT(conn)) {
3799
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3800 3801 3802 3803 3804 3805 3806 3807
        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__);
3808
        return (NULL);
3809 3810
    }

3811 3812 3813
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

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

/**
 * 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
3828 3829
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3830 3831
    DEBUG("conn=%p, xml=%s", conn, xml);

3832
    if (!VIR_IS_CONNECT(conn)) {
3833
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3834 3835 3836 3837
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3838
        return (NULL);
3839 3840 3841 3842 3843 3844
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3845 3846
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3847

3848
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3849
    return NULL;
3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
}

/**
 * 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;
3863
    DEBUG("network=%p", network);
3864 3865

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

3875 3876
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3877

3878
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3879
    return -1;
3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891
}

/**
 * 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
3892 3893
virNetworkCreate(virNetworkPtr network)
{
3894
    virConnectPtr conn;
3895 3896
    DEBUG("network=%p", network);

3897 3898
    if (network == NULL) {
        TODO
3899
        return (-1);
3900 3901
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3902
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3903 3904 3905 3906 3907
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3908
        return (-1);
3909 3910
    }

3911 3912 3913
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3914
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3915
    return -1;
3916 3917 3918 3919 3920 3921 3922
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
3923 3924 3925
 * 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
3926 3927 3928 3929 3930 3931 3932
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
3933
    DEBUG("network=%p", network);
3934 3935

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3936
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3937 3938 3939 3940 3941 3942
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3943
        return (-1);
3944 3945
    }

3946 3947
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
3948

3949
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3950
    return -1;
3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964
}

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

3967
    if (!VIR_IS_NETWORK(network)) {
3968
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3969 3970
        return (-1);
    }
3971
    if (virUnrefNetwork(network) < 0)
3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987
        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)
{
3988 3989
    DEBUG("network=%p", network);

3990
    if (!VIR_IS_NETWORK(network)) {
3991
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008
        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)
{
4009 4010
    DEBUG("network=%p, uuid=%p", network, uuid);

4011
    if (!VIR_IS_NETWORK(network)) {
4012
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
        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];
4039
    DEBUG("network=%p, buf=%p", network, buf);
4040 4041

    if (!VIR_IS_NETWORK(network)) {
4042
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4043 4044 4045 4046 4047 4048 4049 4050
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
4051
        return (-1);
4052

4053
    virUUIDFormat(uuid, buf);
4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070
    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)
{
4071
    virConnectPtr conn;
4072
    DEBUG("network=%p, flags=%d", network, flags);
4073

4074
    if (!VIR_IS_NETWORK(network)) {
4075
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4076 4077 4078 4079 4080 4081 4082
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

4083 4084 4085 4086 4087
    conn = network->conn;

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

4088
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4089
    return NULL;
4090
}
4091 4092 4093 4094 4095

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
4096
 * Provides a bridge interface name to which a domain may connect
4097 4098 4099 4100 4101 4102 4103 4104
 * 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)
{
4105
    virConnectPtr conn;
4106
    DEBUG("network=%p", network);
4107

4108
    if (!VIR_IS_NETWORK(network)) {
4109
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4110 4111 4112
        return (NULL);
    }

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

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

4118
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4119
    return NULL;
4120
}
4121 4122 4123 4124

/**
 * virNetworkGetAutostart:
 * @network: a network object
4125
 * @autostart: the value returned
4126
 *
4127
 * Provides a boolean value indicating whether the network
4128 4129 4130 4131 4132 4133 4134
 * 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,
4135 4136 4137
                       int *autostart)
{
    virConnectPtr conn;
4138
    DEBUG("network=%p, autostart=%p", network, autostart);
4139 4140

    if (!VIR_IS_NETWORK(network)) {
4141
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4142 4143 4144 4145 4146 4147 4148
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

4149 4150 4151 4152 4153
    conn = network->conn;

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

4154
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4155
    return -1;
4156 4157 4158 4159 4160
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
4161
 * @autostart: whether the network should be automatically started 0 or 1
4162 4163 4164 4165 4166 4167 4168 4169
 *
 * 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,
4170 4171 4172
                       int autostart)
{
    virConnectPtr conn;
4173
    DEBUG("network=%p, autostart=%d", network, autostart);
4174 4175

    if (!VIR_IS_NETWORK(network)) {
4176
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4177 4178 4179
        return (-1);
    }

4180 4181 4182 4183 4184
    conn = network->conn;

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

4185
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4186
    return -1;
4187
}
4188

4189 4190 4191

/**
 * virStoragePoolGetConnect:
4192
 * @pool: pointer to a pool
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 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
 *
 * 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;
}


4342 4343 4344 4345 4346 4347 4348 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
/**
 * 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;
}


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 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461
/**
 * 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,
4462
                                                                 const char *uuidstr)
4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514
{
    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
4515
 * @flags: future flags, use 0 for now
4516 4517
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
4518
 * pool is not persistent, so its definition will disappear
4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553
 * 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
4554
 * @flags: future flags, use 0 for now
4555 4556
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
4557
 * pool is persistent, until explicitly undefined.
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
 *
 * 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
4592
 * @flags: future flags, use 0 for now
4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659
 *
 * 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
4660
 * @flags: future flags, use 0 for now
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 4922 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
 *
 * 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
4959
 * @flags: flags for XML format options (set of virDomainXMLFlags)
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 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124
 *
 * 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:
5125
 * @vol: pointer to a pool
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 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275
 *
 * 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
5276
 * unique, so the same volume will have the same
5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 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
 * 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
5334
 * @flags: future flags, use 0 for now
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 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
 *
 * 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;
}
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

/**
 * 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
 *
D
Daniel Veillard 已提交
5638 5639 5640
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657
 */
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
 *
D
Daniel Veillard 已提交
5658 5659
 * Accessor for the parent of the device
 *
5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682
 * 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
 *
D
Daniel Veillard 已提交
5683 5684
 * Accessor for the number of capabilities supported by the device.
 *
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 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755
 * 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);
}


5756 5757 5758 5759 5760 5761 5762 5763 5764
/*
 * Domain Event Notification
 */

/**
 * virConnectDomainEventRegister:
 * @conn: pointer to the connection
 * @cb: callback to the function handling domain events
 * @opaque: opaque data to pass on to the callback
D
Daniel Veillard 已提交
5765
 * @freecb: optional function to deallocate opaque when not used anymore
5766 5767 5768 5769 5770 5771 5772 5773 5774
 *
 * 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,
5775 5776
                              void *opaque,
                              virFreeCallback freecb)
5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788
{

    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))
5789
        return conn->driver->domainEventRegister (conn, cb, opaque, freecb);
5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822
    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;
}

5823