libvirt.c 163.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
#ifdef ENABLE_DEBUG
    debugEnv = getenv("LIBVIRT_DEBUG");
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    if (debugEnv && *debugEnv && *debugEnv != '0') {
        if (STREQ(debugEnv, "2") || STREQ(debugEnv, "info"))
            virLogSetDefaultPriority(VIR_LOG_INFO);
        else if (STREQ(debugEnv, "3") || STREQ(debugEnv, "warning"))
            virLogSetDefaultPriority(VIR_LOG_WARN);
        else if (STREQ(debugEnv, "4") || STREQ(debugEnv, "error"))
            virLogSetDefaultPriority(VIR_LOG_ERROR);
        else
            virLogSetDefaultPriority(VIR_LOG_DEBUG);
    }
    debugEnv = getenv("LIBVIRT_LOG_FILTERS");
    if (debugEnv)
        virLogParseFilters(debugEnv);
    debugEnv = getenv("LIBVIRT_LOG_OUTPUTS");
    if (debugEnv)
        virLogParseOutputs(debugEnv);
276 277 278 279
#endif

    DEBUG0("register drivers");

280 281 282 283
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

284 285 286
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

287
    /*
288 289
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
290
     */
291 292 293 294 295 296 297 298 299 300 301
#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
302
#ifdef WITH_TEST
303
    if (testRegister() == -1) return -1;
304
#endif
305
#ifdef WITH_XEN
306
    if (xenRegister () == -1) return -1;
307
#endif
308 309
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
D
Daniel Veillard 已提交
310
#endif
311 312
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
313
#endif
314
#endif
D
Daniel P. Berrange 已提交
315

316 317 318 319 320
    return(0);
}



D
Daniel Veillard 已提交
321 322 323
/**
 * virLibConnError:
 * @conn: the connection if available
324
 * @error: the error number
D
Daniel Veillard 已提交
325 326 327 328 329
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
330 331
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
332
    const char *errmsg;
333

D
Daniel Veillard 已提交
334 335 336
    if (error == VIR_ERR_OK)
        return;

337 338 339
    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 已提交
340 341 342
}

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

358 359 360
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
361 362 363 364 365 366
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
367 368 369 370 371
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
372 373 374
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
375 376
    virConnectPtr conn = NULL;
    const char *errmsg;
377

D
Daniel Veillard 已提交
378 379 380
    if (error == VIR_ERR_OK)
        return;

381
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
382 383 384
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
385 386
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
387 388
}

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

    if (error == VIR_ERR_OK)
        return;

407
    errmsg = virErrorMsg(error, info);
408 409 410
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
411 412
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
413 414
}

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

433
    errmsg = virErrorMsg(error, info);
434 435 436
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

437 438
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
439 440 441 442 443
}

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

459
    errmsg = virErrorMsg(error, info);
460 461 462
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

463 464
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
465 466
}

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
/**
 * 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);
}

493 494 495 496 497 498 499 500 501 502 503
/**
 * 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)
{
504 505 506 507 508
    if (virInitialize() < 0)
      return -1;

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

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
513 514
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
515 516
    }

517 518 519
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

520 521
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
522 523
}

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
/**
 * 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) {
544
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
545 546 547
        return(-1);
    }

548 549 550
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

551 552 553 554
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
/**
 * 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);
    }

579 580 581
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

582 583 584 585
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

586 587 588 589 590 591 592 593 594 595 596
/**
 * 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)
{
597 598 599 600 601
    if (virInitialize() < 0)
      return -1;

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

    if (virDriverTabCount >= MAX_DRIVERS) {
606 607
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
608 609
    }

610
    if (driver->no < 0) {
611
        virLibConnError
612 613 614 615 616
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

617 618 619
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

620 621
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
622 623
}

A
Atsushi SAKAI 已提交
624
#ifdef WITH_LIBVIRTD
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
/**
 * 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) {
645
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
646 647 648 649 650 651 652
        return(-1);
    }

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

653 654 655 656 657 658 659
/**
 * virStateInitialize:
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
660
int virStateInitialize(void) {
661 662 663 664 665 666
    int i, ret = 0;

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

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

674 675 676 677 678 679 680
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
681
int virStateCleanup(void) {
682 683 684
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
685 686
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
687 688 689 690 691
            ret = -1;
    }
    return ret;
}

692 693 694 695 696 697 698
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
699
int virStateReload(void) {
700 701 702
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
703 704
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
705 706 707 708 709
            ret = -1;
    }
    return ret;
}

710 711 712 713 714 715 716
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
 * Return 0 if none are active, 1 if at least one is.
 */
D
Daniel P. Berrange 已提交
717
int virStateActive(void) {
718 719 720
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
721 722
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
723 724 725 726 727
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
728
#endif
729

730 731


732 733 734
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
735
 * @type: the type of connection/driver looked at
736 737 738 739 740
 * @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 已提交
741
 * @type is unknown or not available, an error code will be returned and
742 743 744 745 746 747
 * @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
748 749 750
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
751
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
752

753
    if (!initialized)
754
        if (virInitialize() < 0)
755
            return -1;
756

757
    if (libVer == NULL)
758
        return (-1);
759 760 761
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
762
        if (type == NULL)
763
            type = "Xen";
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
        *typeVer = 0;
#if WITH_XEN
        if (STRCASEEQ(type, "Xen"))
            *typeVer = xenUnifiedVersion();
#endif
#if WITH_TEST
        if (STRCASEEQ(type, "Test"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_QEMU
        if (STRCASEEQ(type, "QEMU"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_LXC
        if (STRCASEEQ(type, "LXC"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_OPENVZ
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_UML
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_REMOTE
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
#endif
        if (*typeVer == 0) {
794
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
795 796 797 798
            return (-1);
        }
    }
    return (0);
799 800
}

801
static virConnectPtr
802 803 804
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
805
{
806
    int i, res;
807 808 809 810 811
    virConnectPtr ret;

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

813 814 815 816 817 818 819 820
    /*
     *  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) {
821
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
822 823
            name = defname;
        } else {
824
            name = NULL;
825
        }
826
    }
827

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
    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;
        }
845

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
        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");
861 862
    }

863 864 865
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

866
    for (i = 0; i < virDriverTabCount; i++) {
867 868
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
869
        res = virDriverTab[i]->open (ret, auth, flags);
870 871 872 873 874
        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")));
875 876 877 878 879
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
880 881
    }

882
    if (!ret->driver) {
883 884
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
885
        goto failed;
886 887
    }

888
    for (i = 0; i < virNetworkDriverTabCount; i++) {
889
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
890 891 892 893 894
        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")));
895
        if (res == VIR_DRV_OPEN_ERROR) {
896
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
897
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
898 899
                                   "Is the daemon running ?");
            }
900 901
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
902 903 904
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
905
    }
906

907 908 909

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
910
        res = virStorageDriverTab[i]->open (ret, auth, flags);
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
#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;
        }
    }

930 931 932 933 934 935 936 937 938 939 940 941 942 943
    /* 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;
944 945
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
946 947 948 949 950 951 952 953 954 955 956
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

957
    return ret;
958 959

failed:
960
    if (ret->driver) ret->driver->close (ret);
961

962
    /* If no global error was set, copy any error set
963
       in the connection object we're about to dispose of */
964 965
    if (virLastErr.code == VIR_ERR_OK) {
        memcpy(&virLastErr, &ret->err, sizeof(ret->err));
966 967 968 969
        memset(&ret->err, 0, sizeof(ret->err));
    }

    /* Still no error set, then raise a generic error */
970
    if (virLastErr.code == VIR_ERR_OK)
971 972 973 974 975
        virLibConnError (NULL, VIR_ERR_INTERNAL_ERROR,
                         _("unable to open connection"));

    virUnrefConnect(ret);

976
    return NULL;
977 978
}

979 980
/**
 * virConnectOpen:
981
 * @name: URI of the hypervisor
982
 *
983
 * This function should be called first to get a connection to the
984 985 986
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
987 988
 *
 * URIs are documented at http://libvirt.org/uri.html
989 990 991 992
 */
virConnectPtr
virConnectOpen (const char *name)
{
993 994 995 996
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

997
    DEBUG("name=%s", name);
998
    return do_open (name, NULL, 0);
999 1000
}

1001
/**
1002
 * virConnectOpenReadOnly:
1003
 * @name: URI of the hypervisor
1004
 *
1005
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1006
 * library functionalities. The set of APIs usable are then restricted
1007
 * on the available methods to control the domains.
1008 1009
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1010 1011
 *
 * URIs are documented at http://libvirt.org/uri.html
1012
 */
1013
virConnectPtr
1014 1015
virConnectOpenReadOnly(const char *name)
{
1016 1017 1018 1019
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1020
    DEBUG("name=%s", name);
1021 1022 1023 1024 1025 1026 1027 1028 1029
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1030
 * This function should be called first to get a connection to the
1031
 * Hypervisor. If necessary, authentication will be performed fetching
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
 * 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)
{
1043 1044 1045 1046 1047
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

    DEBUG("name=%s, auth=%p, flags=%d", name, auth, flags);
1048
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1049 1050 1051
}

/**
1052
 * virConnectClose:
D
Daniel Veillard 已提交
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
 * @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
1063 1064
virConnectClose(virConnectPtr conn)
{
1065 1066
    DEBUG("conn=%p", conn);

K
Karel Zak 已提交
1067
    if (!VIR_IS_CONNECT(conn))
1068
        return (-1);
1069 1070 1071

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
1072 1073
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1074 1075
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1076
    conn->driver->close (conn);
1077

1078
    if (virUnrefConnect(conn) < 0)
1079
        return (-1);
1080
    return (0);
D
Daniel Veillard 已提交
1081 1082
}

D
Daniel Veillard 已提交
1083 1084
/*
 * Not for public use.  This function is part of the internal
1085 1086 1087
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1088
virDrvSupportsFeature (virConnectPtr conn, int feature)
1089 1090 1091 1092 1093 1094 1095 1096 1097
{
    DEBUG("conn=%p, feature=%d", conn, feature);

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

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

1098 1099 1100 1101 1102 1103 1104
/**
 * 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.
1105 1106 1107
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1108 1109
 */
const char *
1110 1111
virConnectGetType(virConnectPtr conn)
{
1112
    const char *ret;
1113
    DEBUG("conn=%p", conn);
1114

D
Daniel Veillard 已提交
1115
    if (!VIR_IS_CONNECT(conn)) {
1116
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1117
        return (NULL);
D
Daniel Veillard 已提交
1118
    }
1119 1120 1121 1122

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1123
    }
1124
    return conn->driver->name;
1125 1126
}

D
Daniel Veillard 已提交
1127
/**
1128
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1129
 * @conn: pointer to the hypervisor connection
1130
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1131
 *
1132
 * Get the version level of the Hypervisor running. This may work only with
1133
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1134
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1135
 *
1136 1137 1138
 * 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 已提交
1139
 */
1140
int
1141 1142
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1143 1144
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

D
Daniel Veillard 已提交
1145
    if (!VIR_IS_CONNECT(conn)) {
1146
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1147
        return (-1);
D
Daniel Veillard 已提交
1148
    }
1149

D
Daniel Veillard 已提交
1150 1151
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1152
        return (-1);
D
Daniel Veillard 已提交
1153
    }
1154

1155 1156
    if (conn->driver->version)
        return conn->driver->version (conn, hvVer);
D
Daniel P. Berrange 已提交
1157

1158 1159
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1160 1161
}

1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
/**
 * 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)
{
1177 1178
    DEBUG("conn=%p", conn);

1179
    if (!VIR_IS_CONNECT(conn)) {
1180
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
        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)
{
1209 1210
    char *name;

1211 1212
    DEBUG("conn=%p", conn);

1213
    if (!VIR_IS_CONNECT(conn)) {
1214
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1215 1216 1217
        return NULL;
    }

1218 1219 1220
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
1221 1222 1223
    if (conn->driver->getURI)
        return conn->driver->getURI (conn);

1224
    name = (char *)xmlSaveUri(conn->uri);
1225 1226 1227 1228 1229
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
        return NULL;
    }
    return name;
1230 1231
}

1232 1233 1234 1235 1236
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1237
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1238 1239 1240 1241 1242 1243 1244 1245 1246
 * 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)
{
1247 1248
    DEBUG("conn=%p, type=%s", conn, type);

1249
    if (!VIR_IS_CONNECT(conn)) {
1250
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1251 1252 1253
        return (-1);
    }

1254 1255
    if (conn->driver->getMaxVcpus)
        return conn->driver->getMaxVcpus (conn, type);
1256

1257 1258
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1259 1260
}

1261
/**
1262
 * virConnectListDomains:
1263 1264 1265 1266 1267 1268 1269 1270 1271
 * @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
1272 1273
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1274 1275
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

D
Daniel Veillard 已提交
1276
    if (!VIR_IS_CONNECT(conn)) {
1277
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1278
        return (-1);
D
Daniel Veillard 已提交
1279
    }
1280

1281
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1282
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1283
        return (-1);
D
Daniel Veillard 已提交
1284
    }
1285

1286 1287
    if (conn->driver->listDomains)
        return conn->driver->listDomains (conn, ids, maxids);
1288

1289 1290
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1291 1292
}

K
 
Karel Zak 已提交
1293 1294 1295 1296
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1297 1298
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1299 1300 1301
 * Returns the number of domain found or -1 in case of error
 */
int
1302 1303
virConnectNumOfDomains(virConnectPtr conn)
{
1304 1305
    DEBUG("conn=%p", conn);

D
Daniel Veillard 已提交
1306
    if (!VIR_IS_CONNECT(conn)) {
1307
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1308
        return (-1);
D
Daniel Veillard 已提交
1309
    }
K
Karel Zak 已提交
1310

1311 1312
    if (conn->driver->numOfDomains)
        return conn->driver->numOfDomains (conn);
1313

1314 1315
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
K
 
Karel Zak 已提交
1316 1317
}

1318 1319 1320 1321
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1322
 * Provides the connection pointer associated with a domain.  The
1323 1324 1325
 * reference counter on the connection is not increased by this
 * call.
 *
1326 1327 1328 1329
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1330 1331 1332 1333 1334
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1335 1336
    DEBUG("dom=%p", dom);

1337
    if (!VIR_IS_DOMAIN (dom)) {
1338
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1339 1340 1341 1342 1343
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1344
/**
1345
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1346
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1347
 * @xmlDesc: string containing an XML description of the domain
1348
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1349
 *
1350
 * Launch a new guest domain, based on an XML description similar
1351
 * to the one returned by virDomainGetXMLDesc()
1352
 * This function may requires privileged access to the hypervisor.
1353 1354 1355
 * 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).
1356
 *
D
Daniel Veillard 已提交
1357 1358
 * Returns a new domain object or NULL in case of failure
 */
1359
virDomainPtr
1360 1361
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1362
{
1363 1364
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

D
Daniel Veillard 已提交
1365
    if (!VIR_IS_CONNECT(conn)) {
1366
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1367
        return (NULL);
D
Daniel Veillard 已提交
1368 1369 1370
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1371
        return (NULL);
D
Daniel Veillard 已提交
1372
    }
1373 1374
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1375
        return (NULL);
1376
    }
D
Daniel Veillard 已提交
1377

1378 1379
    if (conn->driver->domainCreateXML)
        return conn->driver->domainCreateXML (conn, xmlDesc, flags);
1380 1381 1382

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

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
/**
 * 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));
}
1403

1404
/**
1405
 * virDomainLookupByID:
1406 1407 1408 1409
 * @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 已提交
1410 1411
 * 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.
1412
 *
1413 1414
 * 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.
1415
 */
1416
virDomainPtr
1417 1418
virDomainLookupByID(virConnectPtr conn, int id)
{
1419 1420
    DEBUG("conn=%p, id=%d", conn, id);

D
Daniel Veillard 已提交
1421
    if (!VIR_IS_CONNECT(conn)) {
1422
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1423
        return (NULL);
D
Daniel Veillard 已提交
1424 1425 1426
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1427
        return (NULL);
D
Daniel Veillard 已提交
1428
    }
1429

1430 1431
    if (conn->driver->domainLookupByID)
        return conn->driver->domainLookupByID (conn, id);
1432

1433 1434
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1435 1436 1437 1438 1439
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1440
 * @uuid: the raw UUID for the domain
1441 1442 1443
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1444 1445
 * 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.
1446 1447
 */
virDomainPtr
1448 1449
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1450 1451
    DEBUG("conn=%p, uuid=%s", conn, uuid);

D
Daniel Veillard 已提交
1452
    if (!VIR_IS_CONNECT(conn)) {
1453
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1454
        return (NULL);
D
Daniel Veillard 已提交
1455 1456 1457
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1458
        return (NULL);
D
Daniel Veillard 已提交
1459
    }
1460

1461 1462
    if (conn->driver->domainLookupByUUID)
        return conn->driver->domainLookupByUUID (conn, uuid);
1463

1464 1465
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
1466 1467
}

K
Karel Zak 已提交
1468 1469 1470 1471 1472 1473 1474
/**
 * 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.
 *
1475 1476
 * 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 已提交
1477 1478 1479 1480
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1481 1482
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1483 1484
    int ret;

1485 1486
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

K
Karel Zak 已提交
1487
    if (!VIR_IS_CONNECT(conn)) {
1488
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1489 1490 1491 1492 1493
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
1494

K
Karel Zak 已提交
1495
    }
1496 1497
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
     */
    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);
1509

1510
    if (ret!=VIR_UUID_BUFLEN) {
1511 1512
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
K
Karel Zak 已提交
1513
    }
1514
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1515
        uuid[i] = raw[i] & 0xFF;
1516

K
Karel Zak 已提交
1517 1518 1519
    return virDomainLookupByUUID(conn, &uuid[0]);
}

1520 1521 1522 1523 1524
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1525
 * Try to lookup a domain on the given hypervisor based on its name.
1526
 *
1527 1528
 * 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.
1529 1530
 */
virDomainPtr
1531 1532
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1533 1534
    DEBUG("conn=%p, name=%s", conn, name);

D
Daniel Veillard 已提交
1535
    if (!VIR_IS_CONNECT(conn)) {
1536
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1537
        return (NULL);
D
Daniel Veillard 已提交
1538 1539 1540
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1541
        return (NULL);
D
Daniel Veillard 已提交
1542
    }
1543

1544 1545 1546 1547 1548
    if (conn->driver->domainLookupByName)
        return conn->driver->domainLookupByName (conn, name);

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

D
Daniel Veillard 已提交
1551
/**
1552
 * virDomainDestroy:
D
Daniel Veillard 已提交
1553 1554 1555
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1556 1557 1558
 * 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 已提交
1559 1560
 *
 * Returns 0 in case of success and -1 in case of failure.
1561
 */
D
Daniel Veillard 已提交
1562
int
1563 1564
virDomainDestroy(virDomainPtr domain)
{
1565
    virConnectPtr conn;
1566

1567 1568
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1569
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1570
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1571
        return (-1);
D
Daniel Veillard 已提交
1572
    }
1573

1574
    conn = domain->conn;
1575 1576
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1577
        return (-1);
1578
    }
1579

1580 1581
    if (conn->driver->domainDestroy)
        return conn->driver->domainDestroy (domain);
1582

1583 1584
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
}

/**
 * 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
1597 1598
virDomainFree(virDomainPtr domain)
{
1599 1600
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1601
    if (!VIR_IS_DOMAIN(domain)) {
1602
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1603
        return (-1);
D
Daniel Veillard 已提交
1604
    }
1605
    if (virUnrefDomain(domain) < 0)
1606 1607
        return (-1);
    return(0);
D
Daniel Veillard 已提交
1608 1609 1610
}

/**
1611
 * virDomainSuspend:
D
Daniel Veillard 已提交
1612 1613 1614
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1615
 * to CPU resources and I/O but the memory used by the domain at the
1616
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1617
 * the domain.
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
virDomainSuspend(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->domainSuspend)
        return conn->driver->domainSuspend (domain);
1641

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

/**
1647
 * virDomainResume:
D
Daniel Veillard 已提交
1648 1649 1650
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1651
 * it was frozen by calling virSuspendDomain().
1652
 * This function may requires privileged access
D
Daniel Veillard 已提交
1653 1654 1655 1656
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1657 1658
virDomainResume(virDomainPtr domain)
{
1659
    virConnectPtr conn;
1660
    DEBUG("domain=%p", domain);
1661

D
Daniel Veillard 已提交
1662
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1663
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1664
        return (-1);
D
Daniel Veillard 已提交
1665
    }
1666 1667
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1668
        return (-1);
1669
    }
D
Daniel Veillard 已提交
1670

1671 1672
    conn = domain->conn;

1673 1674
    if (conn->driver->domainResume)
        return conn->driver->domainResume (domain);
1675

1676 1677
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return -1;
D
Daniel Veillard 已提交
1678 1679
}

1680 1681 1682 1683 1684 1685
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1686 1687 1688
 * 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.
1689 1690 1691 1692
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1693 1694
virDomainSave(virDomainPtr domain, const char *to)
{
1695
    char filepath[4096];
1696
    virConnectPtr conn;
1697
    DEBUG("domain=%p, to=%s", domain, to);
1698

D
Daniel Veillard 已提交
1699
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1700
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1701
        return (-1);
D
Daniel Veillard 已提交
1702
    }
1703 1704
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1705
        return (-1);
1706
    }
1707
    conn = domain->conn;
D
Daniel Veillard 已提交
1708 1709
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1710
        return (-1);
D
Daniel Veillard 已提交
1711
    }
1712

1713 1714 1715 1716 1717
    /*
     * 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] != '/') {
1718
        unsigned int len, t;
1719

1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
        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];
1730 1731 1732

    }

1733 1734 1735
    if (conn->driver->domainSave)
        return conn->driver->domainSave (domain, to);

1736
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1737
    return -1;
1738 1739 1740 1741
}

/**
 * virDomainRestore:
1742
 * @conn: pointer to the hypervisor connection
1743
 * @from: path to the
1744 1745 1746 1747 1748 1749
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1750 1751
virDomainRestore(virConnectPtr conn, const char *from)
{
1752
    char filepath[4096];
1753
    DEBUG("conn=%p, from=%s", conn, from);
1754

D
Daniel Veillard 已提交
1755
    if (!VIR_IS_CONNECT(conn)) {
1756
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1757
        return (-1);
D
Daniel Veillard 已提交
1758
    }
1759 1760
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1761
        return (-1);
1762
    }
D
Daniel Veillard 已提交
1763 1764
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1765
        return (-1);
D
Daniel Veillard 已提交
1766 1767
    }

1768 1769 1770 1771 1772
    /*
     * 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] != '/') {
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
        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];
    }

1787 1788 1789
    if (conn->driver->domainRestore)
        return conn->driver->domainRestore (conn, from);

1790
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1791
    return -1;
D
Daniel Veillard 已提交
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
}

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

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1814
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
1815 1816 1817 1818
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1819
        return (-1);
D
Daniel Veillard 已提交
1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
    }
    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];

    }

1847 1848 1849
    if (conn->driver->domainCoreDump)
        return conn->driver->domainCoreDump (domain, to, flags);

1850
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1851
    return -1;
1852 1853
}

1854 1855 1856 1857 1858
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
1859 1860
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
1861 1862 1863 1864 1865 1866 1867
 *
 * 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
1868 1869
virDomainShutdown(virDomainPtr domain)
{
1870
    virConnectPtr conn;
1871
    DEBUG("domain=%p", domain);
1872

D
Daniel Veillard 已提交
1873
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1874
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1875
        return (-1);
D
Daniel Veillard 已提交
1876
    }
1877 1878
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1879
        return (-1);
1880
    }
1881

1882 1883
    conn = domain->conn;

1884 1885
    if (conn->driver->domainShutdown)
        return conn->driver->domainShutdown (domain);
1886

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

1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
/**
 * 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)
{
1905
    virConnectPtr conn;
1906
    DEBUG("domain=%p, flags=%u", domain, flags);
1907 1908

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1909
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1910 1911
        return (-1);
    }
1912 1913
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1914
        return (-1);
1915
    }
1916

1917 1918
    conn = domain->conn;

1919 1920
    if (conn->driver->domainReboot)
        return conn->driver->domainReboot (domain, flags);
1921

1922
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1923
    return -1;
1924 1925
}

1926
/**
1927
 * virDomainGetName:
1928 1929 1930 1931 1932 1933 1934 1935
 * @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 *
1936 1937
virDomainGetName(virDomainPtr domain)
{
1938 1939
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
1940
    if (!VIR_IS_DOMAIN(domain)) {
1941
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1942
        return (NULL);
D
Daniel Veillard 已提交
1943
    }
1944
    return (domain->name);
1945 1946
}

1947 1948 1949
/**
 * virDomainGetUUID:
 * @domain: a domain object
1950
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
1951 1952 1953 1954 1955 1956
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
1957 1958
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
1959 1960
    DEBUG("domain=%p, uuid=%p", domain, uuid);

D
Daniel Veillard 已提交
1961
    if (!VIR_IS_DOMAIN(domain)) {
1962
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1963
        return (-1);
D
Daniel Veillard 已提交
1964 1965 1966
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1967
        return (-1);
D
Daniel Veillard 已提交
1968 1969
    }

1970 1971
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

1972
    return (0);
1973 1974
}

K
Karel Zak 已提交
1975 1976 1977
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
1978
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
1979
 *
1980
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
1981 1982 1983 1984 1985 1986 1987
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
1988
    unsigned char uuid[VIR_UUID_BUFLEN];
1989
    DEBUG("domain=%p, buf=%p", domain, buf);
1990

K
Karel Zak 已提交
1991
    if (!VIR_IS_DOMAIN(domain)) {
1992
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
1993 1994 1995 1996 1997 1998
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
1999

K
Karel Zak 已提交
2000
    if (virDomainGetUUID(domain, &uuid[0]))
2001
        return (-1);
K
Karel Zak 已提交
2002

2003
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2004 2005 2006
    return (0);
}

2007
/**
2008
 * virDomainGetID:
2009 2010 2011 2012 2013 2014 2015
 * @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
2016 2017
virDomainGetID(virDomainPtr domain)
{
2018 2019
    DEBUG("domain=%p", domain);

D
Daniel Veillard 已提交
2020
    if (!VIR_IS_DOMAIN(domain)) {
2021
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2022
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2023
    }
2024
    return (domain->id);
2025 2026
}

2027 2028 2029 2030 2031 2032
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2033 2034
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2035 2036
 */
char *
2037 2038
virDomainGetOSType(virDomainPtr domain)
{
2039
    virConnectPtr conn;
2040
    DEBUG("domain=%p", domain);
2041

D
Daniel Veillard 已提交
2042
    if (!VIR_IS_DOMAIN(domain)) {
2043
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2044
        return (NULL);
D
Daniel Veillard 已提交
2045
    }
2046

2047 2048 2049 2050
    conn = domain->conn;

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

2052
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2053
    return NULL;
2054 2055
}

2056
/**
2057
 * virDomainGetMaxMemory:
2058
 * @domain: a domain object or NULL
2059
 *
2060 2061 2062 2063 2064 2065 2066
 * 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
2067 2068
virDomainGetMaxMemory(virDomainPtr domain)
{
2069
    virConnectPtr conn;
2070
    DEBUG("domain=%p", domain);
2071

D
Daniel Veillard 已提交
2072
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2073
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2074
        return (0);
D
Daniel Veillard 已提交
2075
    }
2076

2077 2078
    conn = domain->conn;

2079 2080 2081
    if (conn->driver->domainGetMaxMemory)
        return conn->driver->domainGetMaxMemory (domain);

2082
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2083
    return 0;
2084 2085
}

D
Daniel Veillard 已提交
2086
/**
2087
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2088 2089
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2090
 *
D
Daniel Veillard 已提交
2091 2092 2093
 * 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.
2094
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2095 2096 2097 2098
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2099 2100
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2101
    virConnectPtr conn;
2102
    DEBUG("domain=%p, memory=%lu", domain, memory);
2103

2104 2105
    if (domain == NULL) {
        TODO
2106
        return (-1);
2107 2108
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2109
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2110
        return (-1);
2111
    }
2112 2113
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2114
        return (-1);
2115 2116 2117 2118 2119
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
2120
    conn = domain->conn;
2121

2122 2123 2124
    if (conn->driver->domainSetMaxMemory)
        return conn->driver->domainSetMaxMemory (domain, memory);

2125
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2126
    return -1;
2127
}
2128

2129 2130 2131 2132
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2133
 *
2134 2135 2136
 * 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.
2137
 * This function may requires privileged access to the hypervisor.
2138 2139 2140 2141 2142 2143 2144
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2145
    DEBUG("domain=%p, memory=%lu", domain, memory);
2146

2147 2148
    if (domain == NULL) {
        TODO
2149
        return (-1);
2150 2151
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2152
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2153
        return (-1);
2154
    }
2155 2156
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2157
        return (-1);
2158 2159 2160
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2161
        return (-1);
2162 2163 2164
    }

    conn = domain->conn;
2165

2166 2167 2168
    if (conn->driver->domainSetMemory)
        return conn->driver->domainSetMemory (domain, memory);

2169
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2170
    return -1;
D
Daniel Veillard 已提交
2171 2172
}

2173 2174
/**
 * virDomainGetInfo:
2175
 * @domain: a domain object
2176
 * @info: pointer to a virDomainInfo structure allocated by the user
2177
 *
2178
 * Extract information about a domain. Note that if the connection
2179
 * used to get the domain is limited only a partial set of the information
2180 2181 2182 2183 2184
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2185 2186
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2187
    virConnectPtr conn;
2188
    DEBUG("domain=%p, info=%p", domain, info);
2189

D
Daniel Veillard 已提交
2190
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2191
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2192
        return (-1);
D
Daniel Veillard 已提交
2193 2194 2195
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2196
        return (-1);
D
Daniel Veillard 已提交
2197
    }
2198

2199
    memset(info, 0, sizeof(virDomainInfo));
2200

2201 2202 2203 2204
    conn = domain->conn;

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

2206
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2207
    return -1;
2208
}
2209

2210 2211 2212
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2213
 * @flags: an OR'ed set of virDomainXMLFlags
2214 2215
 *
 * Provide an XML description of the domain. The description may be reused
2216
 * later to relaunch the domain with virDomainCreateXML().
2217 2218 2219 2220 2221
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2222 2223
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2224
    virConnectPtr conn;
2225
    DEBUG("domain=%p, flags=%d", domain, flags);
2226

D
Daniel Veillard 已提交
2227
    if (!VIR_IS_DOMAIN(domain)) {
2228
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2229
        return (NULL);
D
Daniel Veillard 已提交
2230
    }
2231

2232 2233 2234 2235 2236
    conn = domain->conn;

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

2237
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2238
    return NULL;
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 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300
/**
 * 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 已提交
2301 2302
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2303 2304 2305 2306
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

    if (!VIR_IS_DOMAIN (domain)) {
2307
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2308 2309 2310 2311 2312 2313 2314 2315
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return NULL;
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, delibrately report error against source object, not dest here */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return NULL;
    }

2326
    /* Check that migration is supported by both drivers. */
D
Daniel Veillard 已提交
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337
    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 {
2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
        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 已提交
2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365
    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);
2366
    }
D
Daniel Veillard 已提交
2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377
    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);
2378

D
Daniel Veillard 已提交
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395
        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);
    }
2396 2397 2398 2399 2400 2401 2402

    /* 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 已提交
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
    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);
    }
2425 2426

 done:
2427 2428
    free (uri_out);
    free (cookie);
2429 2430 2431
    return ddomain;
}

D
Daniel Veillard 已提交
2432 2433
/*
 * Not for public use.  This function is part of the internal
2434 2435 2436
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2437
virDomainMigratePrepare (virConnectPtr dconn,
2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448
                           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)) {
2449
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2450 2451 2452
        return -1;
    }

2453 2454 2455 2456 2457
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }

2458 2459 2460 2461 2462 2463 2464 2465 2466
    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 已提交
2467 2468
/*
 * Not for public use.  This function is part of the internal
2469 2470 2471
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2472
virDomainMigratePerform (virDomainPtr domain,
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483
                           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)) {
2484
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2485 2486 2487 2488
        return -1;
    }
    conn = domain->conn;

2489 2490 2491 2492 2493
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }

2494 2495 2496 2497 2498 2499 2500 2501 2502
    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 已提交
2503 2504
/*
 * Not for public use.  This function is part of the internal
2505 2506 2507
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2508
virDomainMigrateFinish (virConnectPtr dconn,
2509 2510 2511 2512 2513 2514 2515 2516 2517
                          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)) {
2518
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2519 2520 2521
        return NULL;
    }

2522 2523 2524 2525 2526
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return NULL;
    }

2527 2528 2529 2530 2531 2532 2533
    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 已提交
2534 2535 2536
}


D
Daniel Veillard 已提交
2537 2538
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2539 2540 2541
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2542 2543 2544 2545 2546 2547 2548 2549 2550
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 已提交
2551 2552 2553 2554 2555 2556 2557 2558
{
    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;
    }

2559 2560 2561 2562 2563
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }

D
Daniel Veillard 已提交
2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
    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 已提交
2574 2575
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2576 2577 2578
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2579 2580 2581 2582 2583 2584 2585
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
2586 2587 2588 2589 2590 2591 2592 2593
{
    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;
    }

2594 2595 2596 2597 2598
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return NULL;
    }

D
Daniel Veillard 已提交
2599 2600 2601 2602 2603 2604 2605 2606
    if (dconn->driver->domainMigrateFinish2)
        return dconn->driver->domainMigrateFinish2 (dconn, dname,
                                                    cookie, cookielen,
                                                    uri, flags,
                                                    retcode);

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
    return NULL;
2607 2608 2609
}


2610 2611 2612 2613
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
2614
 *
2615 2616 2617 2618 2619
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2620 2621
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
2622 2623
    DEBUG("conn=%p, info=%p", conn, info);

2624
    if (!VIR_IS_CONNECT(conn)) {
2625
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2626 2627 2628 2629 2630 2631 2632
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

2633 2634 2635
    if (conn->driver->nodeGetInfo)
        return conn->driver->nodeGetInfo (conn, info);

2636
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2637
    return -1;
2638
}
2639

2640 2641 2642 2643 2644 2645
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
2646 2647
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
2648 2649 2650 2651 2652
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
2653 2654
    DEBUG("conn=%p", conn);

2655
    if (!VIR_IS_CONNECT (conn)) {
2656
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2657 2658 2659
        return NULL;
    }

2660 2661
    if (conn->driver->getCapabilities)
        return conn->driver->getCapabilities (conn);
2662

2663
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2664 2665 2666
    return NULL;
}

2667 2668 2669
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
2670
 *
D
Daniel Veillard 已提交
2671
 * provides the free memory available on the Node
2672 2673 2674 2675 2676 2677
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
2678 2679
    DEBUG("conn=%p", conn);

2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691
    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;
}

2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
/**
 * 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;
2706
    DEBUG("domain=%p, nparams=%p", domain, nparams);
2707 2708

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

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

2719
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
    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,
2740
                                virSchedParameterPtr params, int *nparams)
2741 2742
{
    virConnectPtr conn;
2743
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
2744 2745

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2746
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2747 2748 2749 2750 2751 2752 2753
        return -1;
    }
    conn = domain->conn;

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

2754
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770
    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
2771
virDomainSetSchedulerParameters(virDomainPtr domain,
2772
                                virSchedParameterPtr params, int nparams)
2773 2774
{
    virConnectPtr conn;
2775
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
2776 2777

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2778
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2779 2780
        return -1;
    }
2781 2782 2783 2784
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return -1;
    }
2785 2786 2787 2788 2789
    conn = domain->conn;

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

2790
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2791 2792 2793 2794
    return -1;
}


2795
/**
2796
 * virDomainBlockStats:
2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
 * @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)) {
2831
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848
        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;
}

/**
2849
 * virDomainInterfaceStats:
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882
 * @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)) {
2883
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899
        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 已提交
2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932
/**
 * 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 已提交
2933 2934 2935 2936
 * 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 已提交
2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
 * 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;
2956

2957 2958 2959 2960 2961
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

R
Richard W.M. Jones 已提交
2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
    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)
2982 2983
        return conn->driver->domainBlockPeek (dom, path, offset, size,
                                              buffer, flags);
R
Richard W.M. Jones 已提交
2984 2985 2986 2987

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

R
Richard W.M. Jones 已提交
2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
/**
 * 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;

3037 3038 3039 3040 3041
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

R
Richard W.M. Jones 已提交
3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
    /* 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;
}

3084

3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095
/************************************************************************
 *									*
 *		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
 *
3096 3097 3098
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
 * virDomainUndefine().
3099 3100 3101 3102 3103
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3104 3105
    DEBUG("conn=%p, xml=%s", conn, xml);

3106
    if (!VIR_IS_CONNECT(conn)) {
3107
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3108 3109
        return (NULL);
    }
3110 3111
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3112
        return (NULL);
3113
    }
3114 3115 3116 3117 3118
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3119 3120
    if (conn->driver->domainDefineXML)
        return conn->driver->domainDefineXML (conn, xml);
3121

3122
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3123
    return NULL;
3124 3125 3126 3127 3128 3129
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3130
 * Undefine a domain but does not stop it if it is running
3131 3132 3133 3134 3135
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3136
    virConnectPtr conn;
3137
    DEBUG("domain=%p", domain);
3138 3139

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3140
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3141 3142
        return (-1);
    }
3143 3144
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3145
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3146
        return (-1);
3147 3148
    }

3149 3150
    if (conn->driver->domainUndefine)
        return conn->driver->domainUndefine (domain);
3151

3152
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3153
    return -1;
3154 3155 3156 3157 3158 3159
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3160
 * Provides the number of defined but inactive domains.
3161 3162 3163 3164 3165 3166
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3167 3168
    DEBUG("conn=%p", conn);

3169
    if (!VIR_IS_CONNECT(conn)) {
3170
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3171 3172 3173
        return (-1);
    }

3174 3175
    if (conn->driver->numOfDefinedDomains)
        return conn->driver->numOfDefinedDomains (conn);
3176

3177
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3178
    return -1;
3179 3180 3181 3182 3183 3184 3185 3186
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
3187 3188
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
3189
 *
3190 3191 3192
 * Returns the number of names provided in the array or -1 in case of error
 */
int
3193
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
3194
                             int maxnames) {
3195 3196
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3197
    if (!VIR_IS_CONNECT(conn)) {
3198
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3199 3200 3201
        return (-1);
    }

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

3207 3208
    if (conn->driver->listDefinedDomains)
        return conn->driver->listDefinedDomains (conn, names, maxnames);
3209

3210
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3211
    return -1;
3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224
}

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

3228 3229
    if (domain == NULL) {
        TODO
3230
        return (-1);
3231
    }
3232
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3233
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3234 3235
        return (-1);
    }
3236 3237
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3238
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3239
        return (-1);
3240
    }
3241

3242 3243 3244
    if (conn->driver->domainCreate)
        return conn->driver->domainCreate (domain);

3245
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3246
    return -1;
3247 3248
}

3249 3250 3251
/**
 * virDomainGetAutostart:
 * @domain: a domain object
3252
 * @autostart: the value returned
3253
 *
3254
 * Provides a boolean value indicating whether the domain
3255 3256 3257 3258 3259 3260 3261
 * 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,
3262 3263 3264
                      int *autostart)
{
    virConnectPtr conn;
3265
    DEBUG("domain=%p, autostart=%p", domain, autostart);
3266 3267

    if (!VIR_IS_DOMAIN(domain)) {
3268
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3269 3270 3271 3272 3273 3274 3275
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

3276 3277 3278 3279 3280
    conn = domain->conn;

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

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

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3288
 * @autostart: whether the domain should be automatically started 0 or 1
3289 3290 3291 3292 3293 3294 3295 3296
 *
 * 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,
3297 3298 3299
                      int autostart)
{
    virConnectPtr conn;
3300
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3301 3302

    if (!VIR_IS_DOMAIN(domain)) {
3303
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3304 3305 3306
        return (-1);
    }

3307 3308
    conn = domain->conn;

3309 3310 3311 3312 3313
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

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

3317
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3318
    return -1;
3319 3320
}

3321 3322 3323 3324 3325 3326 3327 3328
/**
 * 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.
3329
 * This function requires privileged access to the hypervisor.
3330 3331 3332 3333 3334 3335 3336
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3337
    virConnectPtr conn;
3338
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3339

3340 3341
    if (domain == NULL) {
        TODO
3342
        return (-1);
3343 3344
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3345
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3346 3347
        return (-1);
    }
3348 3349
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3350
        return (-1);
3351
    }
3352

3353 3354 3355 3356
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3357
    conn = domain->conn;
3358

3359 3360
    if (conn->driver->domainSetVcpus)
        return conn->driver->domainSetVcpus (domain, nvcpus);
3361

3362
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3363
    return -1;
3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377
}

/**
 * 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.
3378
 *
3379
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
3380
 * This function requires privileged access to the hypervisor.
3381 3382 3383 3384 3385 3386 3387
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
3388
    virConnectPtr conn;
3389
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
3390

3391 3392
    if (domain == NULL) {
        TODO
3393
        return (-1);
3394 3395
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3396
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3397 3398
        return (-1);
    }
3399 3400
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3401
        return (-1);
3402
    }
3403

3404
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
3405 3406 3407
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }
3408

3409 3410
    conn = domain->conn;

3411 3412 3413
    if (conn->driver->domainPinVcpu)
        return conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);

3414
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3415
    return -1;
3416 3417 3418 3419 3420 3421 3422 3423 3424
}

/**
 * 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 已提交
3425
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
3426 3427 3428 3429 3430 3431 3432
 *	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...).
3433
 *
3434
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
3435
 * and also in cpumaps if this pointer isn't NULL.
3436 3437 3438 3439 3440
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
3441
                  unsigned char *cpumaps, int maplen)
3442
{
3443
    virConnectPtr conn;
3444
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
3445 3446 3447

    if (domain == NULL) {
        TODO
3448
        return (-1);
3449 3450
    }
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3451
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3452 3453 3454 3455 3456 3457 3458 3459 3460 3461
        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);
    }
3462

3463 3464
    conn = domain->conn;

3465 3466 3467 3468
    if (conn->driver->domainGetVcpus)
        return conn->driver->domainGetVcpus (domain, info, maxinfo,
                                             cpumaps, maplen);

3469
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3470
    return -1;
3471
}
3472

3473 3474 3475
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
3476
 *
3477 3478 3479 3480 3481
 * 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.
3482 3483 3484 3485
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
3486 3487
virDomainGetMaxVcpus(virDomainPtr domain)
{
3488
    virConnectPtr conn;
3489
    DEBUG("domain=%p", domain);
3490 3491

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3492
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3493 3494 3495 3496 3497
        return (-1);
    }

    conn = domain->conn;

3498 3499 3500
    if (conn->driver->domainGetMaxVcpus)
        return conn->driver->domainGetMaxVcpus (domain);

3501
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3502
    return -1;
3503 3504 3505
}


3506 3507 3508 3509
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3510
 *
3511 3512 3513 3514 3515
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3516
virDomainAttachDevice(virDomainPtr domain, const char *xml)
3517 3518
{
    virConnectPtr conn;
3519
    DEBUG("domain=%p, xml=%s", domain, xml);
3520 3521

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3522
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3523 3524 3525 3526
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3527
        return (-1);
3528 3529 3530
    }
    conn = domain->conn;

3531 3532 3533
    if (conn->driver->domainAttachDevice)
        return conn->driver->domainAttachDevice (domain, xml);

3534
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3535
    return -1;
3536 3537 3538 3539 3540 3541
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
3542
 *
3543 3544 3545 3546 3547
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
3548
virDomainDetachDevice(virDomainPtr domain, const char *xml)
3549 3550
{
    virConnectPtr conn;
3551
    DEBUG("domain=%p, xml=%s", domain, xml);
3552 3553

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3554
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3555 3556 3557 3558
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3559
        return (-1);
3560 3561 3562
    }
    conn = domain->conn;

3563 3564 3565
    if (conn->driver->domainDetachDevice)
        return conn->driver->domainDetachDevice (domain, xml);

3566
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3567
    return -1;
3568
}
3569

3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591
/**
 * 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)
{
3592 3593 3594
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

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

D
Daniel Veillard 已提交
3600
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611
        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;
}

3612 3613 3614 3615
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
3616
 * Provides the connection pointer associated with a network.  The
3617 3618 3619
 * reference counter on the connection is not increased by this
 * call.
 *
3620 3621 3622 3623
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
3624 3625 3626 3627 3628
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
3629 3630
    DEBUG("net=%p", net);

3631
    if (!VIR_IS_NETWORK (net)) {
3632
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3633 3634 3635 3636 3637
        return NULL;
    }
    return net->conn;
}

3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648
/**
 * 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)
{
3649 3650
    DEBUG("conn=%p", conn);

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

3656 3657
    if (conn->networkDriver && conn->networkDriver->numOfNetworks)
        return conn->networkDriver->numOfNetworks (conn);
3658

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

/**
 * 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
3674
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
3675
{
3676 3677
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3678
    if (!VIR_IS_CONNECT(conn)) {
3679
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3680 3681 3682
        return (-1);
    }

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

3688 3689
    if (conn->networkDriver && conn->networkDriver->listNetworks)
        return conn->networkDriver->listNetworks (conn, names, maxnames);
3690

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

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

3708
    if (!VIR_IS_CONNECT(conn)) {
3709
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3710 3711 3712
        return (-1);
    }

3713 3714
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks)
        return conn->networkDriver->numOfDefinedNetworks (conn);
3715

3716
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3717
    return -1;
3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730
}

/**
 * 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
3731
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
3732 3733
                              int maxnames)
{
3734 3735
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3736
    if (!VIR_IS_CONNECT(conn)) {
3737
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3738 3739 3740
        return (-1);
    }

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

3746 3747 3748
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks)
        return conn->networkDriver->listDefinedNetworks (conn,
                                                         names, maxnames);
3749

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

/**
 * 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.
 *
3761 3762
 * 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.
3763 3764 3765 3766
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
3767 3768
    DEBUG("conn=%p, name=%s", conn, name);

3769
    if (!VIR_IS_CONNECT(conn)) {
3770
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3771 3772 3773 3774 3775 3776 3777
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3778 3779 3780
    if (conn->networkDriver && conn->networkDriver->networkLookupByName)
        return conn->networkDriver->networkLookupByName (conn, name);

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

/**
 * 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.
 *
3792 3793
 * 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.
3794 3795 3796 3797
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
3798 3799
    DEBUG("conn=%p, uuid=%s", conn, uuid);

3800
    if (!VIR_IS_CONNECT(conn)) {
3801
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3802 3803 3804 3805 3806 3807 3808
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3809 3810
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID)
        return conn->networkDriver->networkLookupByUUID (conn, uuid);
3811

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

/**
 * 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.
 *
3823 3824
 * 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.
3825 3826 3827 3828 3829 3830 3831
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
3832
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
3833 3834

    if (!VIR_IS_CONNECT(conn)) {
3835
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857
        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) {
3858 3859
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879
    }
    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)
{
3880 3881
    DEBUG("conn=%p, xmlDesc=%s", conn, xmlDesc);

3882
    if (!VIR_IS_CONNECT(conn)) {
3883
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3884 3885 3886 3887 3888 3889 3890 3891
        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__);
3892
        return (NULL);
3893 3894
    }

3895 3896 3897
    if (conn->networkDriver && conn->networkDriver->networkCreateXML)
        return conn->networkDriver->networkCreateXML (conn, xmlDesc);

3898
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3899
    return NULL;
3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911
}

/**
 * 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
3912 3913
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
3914 3915
    DEBUG("conn=%p, xml=%s", conn, xml);

3916
    if (!VIR_IS_CONNECT(conn)) {
3917
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3918 3919 3920 3921
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3922
        return (NULL);
3923 3924 3925 3926 3927 3928
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

3929 3930
    if (conn->networkDriver && conn->networkDriver->networkDefineXML)
        return conn->networkDriver->networkDefineXML (conn, xml);
3931

3932
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3933
    return NULL;
3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946
}

/**
 * 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;
3947
    DEBUG("network=%p", network);
3948 3949

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3950
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3951 3952 3953 3954 3955
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3956
        return (-1);
3957 3958
    }

3959 3960
    if (conn->networkDriver && conn->networkDriver->networkUndefine)
        return conn->networkDriver->networkUndefine (network);
3961

3962
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3963
    return -1;
3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975
}

/**
 * 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
3976 3977
virNetworkCreate(virNetworkPtr network)
{
3978
    virConnectPtr conn;
3979 3980
    DEBUG("network=%p", network);

3981 3982
    if (network == NULL) {
        TODO
3983
        return (-1);
3984 3985
    }
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
3986
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
3987 3988 3989 3990 3991
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3992
        return (-1);
3993 3994
    }

3995 3996 3997
    if (conn->networkDriver && conn->networkDriver->networkCreate)
        return conn->networkDriver->networkCreate (network);

3998
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3999
    return -1;
4000 4001 4002 4003 4004 4005 4006
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
4007 4008 4009
 * 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
4010 4011 4012 4013 4014 4015 4016
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
4017
    DEBUG("network=%p", network);
4018 4019

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4020
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4021 4022 4023 4024 4025 4026
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4027
        return (-1);
4028 4029
    }

4030 4031
    if (conn->networkDriver && conn->networkDriver->networkDestroy)
        return conn->networkDriver->networkDestroy (network);
4032

4033
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4034
    return -1;
4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048
}

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

4051
    if (!VIR_IS_NETWORK(network)) {
4052
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4053 4054
        return (-1);
    }
4055
    if (virUnrefNetwork(network) < 0)
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071
        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)
{
4072 4073
    DEBUG("network=%p", network);

4074
    if (!VIR_IS_NETWORK(network)) {
4075
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092
        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)
{
4093 4094
    DEBUG("network=%p, uuid=%p", network, uuid);

4095
    if (!VIR_IS_NETWORK(network)) {
4096
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122
        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];
4123
    DEBUG("network=%p, buf=%p", network, buf);
4124 4125

    if (!VIR_IS_NETWORK(network)) {
4126
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4127 4128 4129 4130 4131 4132 4133 4134
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

    if (virNetworkGetUUID(network, &uuid[0]))
4135
        return (-1);
4136

4137
    virUUIDFormat(uuid, buf);
4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154
    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)
{
4155
    virConnectPtr conn;
4156
    DEBUG("network=%p, flags=%d", network, flags);
4157

4158
    if (!VIR_IS_NETWORK(network)) {
4159
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4160 4161 4162 4163 4164 4165 4166
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

4167 4168 4169 4170 4171
    conn = network->conn;

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

4172
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4173
    return NULL;
4174
}
4175 4176 4177 4178 4179

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
4180
 * Provides a bridge interface name to which a domain may connect
4181 4182 4183 4184 4185 4186 4187 4188
 * 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)
{
4189
    virConnectPtr conn;
4190
    DEBUG("network=%p", network);
4191

4192
    if (!VIR_IS_NETWORK(network)) {
4193
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4194 4195 4196
        return (NULL);
    }

4197 4198 4199 4200 4201
    conn = network->conn;

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

4202
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4203
    return NULL;
4204
}
4205 4206 4207 4208

/**
 * virNetworkGetAutostart:
 * @network: a network object
4209
 * @autostart: the value returned
4210
 *
4211
 * Provides a boolean value indicating whether the network
4212 4213 4214 4215 4216 4217 4218
 * 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,
4219 4220 4221
                       int *autostart)
{
    virConnectPtr conn;
4222
    DEBUG("network=%p, autostart=%p", network, autostart);
4223 4224

    if (!VIR_IS_NETWORK(network)) {
4225
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4226 4227 4228 4229 4230 4231 4232
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (-1);
    }

4233 4234 4235 4236 4237
    conn = network->conn;

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

4238
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4239
    return -1;
4240 4241 4242 4243 4244
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
4245
 * @autostart: whether the network should be automatically started 0 or 1
4246 4247 4248 4249 4250 4251 4252 4253
 *
 * 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,
4254 4255 4256
                       int autostart)
{
    virConnectPtr conn;
4257
    DEBUG("network=%p, autostart=%d", network, autostart);
4258 4259

    if (!VIR_IS_NETWORK(network)) {
4260
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4261 4262 4263
        return (-1);
    }

4264 4265 4266 4267 4268
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

4269 4270 4271 4272 4273
    conn = network->conn;

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

4274
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4275
    return -1;
4276
}
4277

4278 4279 4280

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


4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466
/**
 * 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;
    }

4467 4468 4469 4470 4471
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return NULL;
    }

4472 4473 4474 4475 4476 4477 4478 4479
    if (conn->storageDriver && conn->storageDriver->findPoolSources)
        return conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);

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


4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555
/**
 * 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,
4556
                                                                 const char *uuidstr)
4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608
{
    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
4609
 * @flags: future flags, use 0 for now
4610 4611
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
4612
 * pool is not persistent, so its definition will disappear
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
 * 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
4648
 * @flags: future flags, use 0 for now
4649 4650
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
4651
 * pool is persistent, until explicitly undefined.
4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685
 *
 * 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
4686
 * @flags: future flags, use 0 for now
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
 *
 * 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
4754
 * @flags: future flags, use 0 for now
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 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052
 *
 * 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
5053
 * @flags: flags for XML format options (set of virDomainXMLFlags)
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 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144
 *
 * 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);
    }

5145 5146 5147 5148 5149
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        return (-1);
    }

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
    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:
5224
 * @vol: pointer to a pool
5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374
 *
 * 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
5375
 * unique, so the same volume will have the same
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
 * 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
5433
 * @flags: future flags, use 0 for now
5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594
 *
 * 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;
}
5595 5596 5597



5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736

/**
 * 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 已提交
5737 5738 5739
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756
 */
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 已提交
5757 5758
 * Accessor for the parent of the device
 *
5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770
 * 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;
    }

5771 5772 5773 5774 5775 5776 5777 5778 5779
    if (!dev->parent) {
        if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceGetParent) {
            dev->parent = dev->conn->deviceMonitor->deviceGetParent (dev);
        } else {
            virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
            return NULL;
        }
    }
    return dev->parent;
5780 5781 5782 5783 5784 5785
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
5786 5787
 * Accessor for the number of capabilities supported by the device.
 *
5788 5789 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 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858
 * 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);
}


5859 5860 5861 5862 5863 5864 5865 5866 5867
/*
 * 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 已提交
5868
 * @freecb: optional function to deallocate opaque when not used anymore
5869 5870 5871 5872 5873 5874 5875 5876 5877
 *
 * 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,
5878 5879
                              void *opaque,
                              virFreeCallback freecb)
5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891
{

    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))
5892
        return conn->driver->domainEventRegister (conn, cb, opaque, freecb);
5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925
    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;
}

5926