libvirt.c 195.2 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,2009 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
#include <time.h>
25

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

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

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

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

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

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

66 67
#define MAX_DRIVERS 10

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

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 114
#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

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

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

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

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

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

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

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

        default:
            return -1;
178 179
        }

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

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

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;

226 227 228 229 230 231 232 233 234 235
#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 已提交
236
    return err == 0 ? 0 : -1;
237 238 239
}
#endif

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

258
    initialized = 1;
259

260
    if (virThreadInitialize() < 0 ||
261 262
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
263 264
        return -1;

265 266
#ifdef ENABLE_DEBUG
    debugEnv = getenv("LIBVIRT_DEBUG");
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
    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);
283 284 285 286
#endif

    DEBUG0("register drivers");

287 288 289 290
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

291 292 293
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

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

323 324 325
    return(0);
}

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
#ifdef WIN32
BOOL WINAPI
DllMain (HINSTANCE instance, DWORD reason, LPVOID ignore);

BOOL WINAPI
DllMain (HINSTANCE instance ATTRIBUTE_UNUSED,
         DWORD reason,
         LPVOID ignore ATTRIBUTE_UNUSED)
{
    switch (reason) {
    case DLL_PROCESS_ATTACH:
        virInitialize();
        break;

    case DLL_THREAD_ATTACH:
        /* Nothing todo in libvirt yet */
        break;

    case DLL_THREAD_DETACH:
        /* Release per-thread local data */
        virThreadOnExit();
        break;

    case DLL_PROCESS_DETACH:
        /* Don't bother releasing per-thread data
           since (hopefully) windows cleans up
           everything on process exit */
        break;
    }

    return TRUE;
}
#endif
359 360


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

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

377 378 379
    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 已提交
380 381 382
}

/**
383
 * virLibConnWarning:
D
Daniel Veillard 已提交
384
 * @conn: the connection if available
385 386 387 388 389 390 391 392 393 394 395 396 397
 * @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;

398 399 400
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
401 402 403 404 405 406
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
407 408 409 410 411
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
412 413 414
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
415 416
    virConnectPtr conn = NULL;
    const char *errmsg;
417

D
Daniel Veillard 已提交
418 419 420
    if (error == VIR_ERR_OK)
        return;

421
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
422 423 424
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
425 426
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
427 428
}

429
/**
430 431
 * virLibNetworkError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
432
 * @error: the error number
433
 * @info: extra information string
434
 *
435
 * Handle an error at the connection level
436
 */
437 438 439 440 441 442 443 444 445 446
static void
virLibNetworkError(virNetworkPtr network, virErrorNumber error,
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

447
    errmsg = virErrorMsg(error, info);
448 449 450
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
451 452
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
453 454
}

455 456 457
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
458
 * @error: the error number
459 460 461 462 463 464 465 466 467 468 469 470 471 472
 * @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;

473
    errmsg = virErrorMsg(error, info);
474 475 476
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

477 478
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
479 480 481 482 483
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
484
 * @error: the error number
485 486 487 488 489 490 491 492 493 494 495 496 497 498
 * @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;

499
    errmsg = virErrorMsg(error, info);
500 501 502
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

503 504
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
505 506
}

507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
/**
 * 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);
}

533 534 535 536 537 538 539 540 541 542 543
/**
 * 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)
{
544 545 546 547 548
    if (virInitialize() < 0)
      return -1;

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

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
553 554
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
555 556
    }

557 558 559
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

560 561
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
562 563
}

564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
/**
 * 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) {
584
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
585 586 587
        return(-1);
    }

588 589 590
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

591 592 593 594
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
/**
 * 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);
    }

619 620 621
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

622 623 624 625
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

626 627 628 629 630 631 632 633 634 635 636
/**
 * 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)
{
637 638 639 640 641
    if (virInitialize() < 0)
      return -1;

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

    if (virDriverTabCount >= MAX_DRIVERS) {
646 647
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
648 649
    }

650
    if (driver->no < 0) {
651
        virLibConnError
652 653 654 655 656
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

657 658 659
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

660 661
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
662 663
}

A
Atsushi SAKAI 已提交
664
#ifdef WITH_LIBVIRTD
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
/**
 * 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) {
685
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
686 687 688 689 690 691 692
        return(-1);
    }

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

693 694 695 696 697 698 699
/**
 * virStateInitialize:
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
700
int virStateInitialize(void) {
701 702 703 704 705 706
    int i, ret = 0;

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

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

714 715 716 717 718 719 720
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
721
int virStateCleanup(void) {
722 723 724
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
725 726
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
727 728 729 730 731
            ret = -1;
    }
    return ret;
}

732 733 734 735 736 737 738
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
739
int virStateReload(void) {
740 741 742
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
743 744
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
745 746 747 748 749
            ret = -1;
    }
    return ret;
}

750 751 752 753 754 755 756
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
 * Return 0 if none are active, 1 if at least one is.
 */
D
Daniel P. Berrange 已提交
757
int virStateActive(void) {
758 759 760
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
761 762
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
763 764 765 766 767
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
768
#endif
769

770 771


772 773 774
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
775
 * @type: the type of connection/driver looked at
776 777 778 779 780
 * @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 已提交
781
 * @type is unknown or not available, an error code will be returned and
782 783 784 785 786 787
 * @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
788 789 790
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
791
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
792

793
    if (!initialized)
794
        if (virInitialize() < 0)
795
            return -1;
796

797
    if (libVer == NULL)
798
        return (-1);
799 800 801
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
802
        if (type == NULL)
803
            type = "Xen";
804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
        *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) {
834
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
835 836 837 838
            return (-1);
        }
    }
    return (0);
839 840
}

841
static virConnectPtr
842 843 844
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
845
{
846
    int i, res;
847 848
    virConnectPtr ret;

849 850
    virResetLastError();

851 852 853
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
854

855 856 857 858 859 860 861 862
    /*
     *  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) {
863
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
864 865
            name = defname;
        } else {
866
            name = NULL;
867
        }
868
    }
869

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
    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;
        }
887

888 889 890 891 892 893 894 895 896
        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,
897 898 899 900
              NULLSTR(ret->uri->scheme), NULLSTR(ret->uri->opaque),
              NULLSTR(ret->uri->authority), NULLSTR(ret->uri->server),
              NULLSTR(ret->uri->user), ret->uri->port,
              NULLSTR(ret->uri->path));
901 902
    } else {
        DEBUG0("no name, allowing driver auto-select");
903 904
    }

905 906 907
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

908
    for (i = 0; i < virDriverTabCount; i++) {
909 910
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
911
        res = virDriverTab[i]->open (ret, auth, flags);
912 913 914 915 916
        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")));
917 918 919 920 921
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
922 923
    }

924
    if (!ret->driver) {
925 926
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
927
        goto failed;
928 929
    }

930
    for (i = 0; i < virNetworkDriverTabCount; i++) {
931
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
932 933 934 935 936
        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")));
937
        if (res == VIR_DRV_OPEN_ERROR) {
938
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
939
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
940 941
                                   "Is the daemon running ?");
            }
942 943
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
944 945 946
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
947
    }
948

949 950 951

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
952
        res = virStorageDriverTab[i]->open (ret, auth, flags);
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
#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;
        }
    }

972 973 974 975 976 977 978 979 980 981 982 983 984 985
    /* 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;
986 987
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
988 989 990 991 992 993 994 995 996 997 998
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

999
    return ret;
1000 1001

failed:
1002
    if (ret->driver) ret->driver->close (ret);
1003

1004 1005
    /* Ensure a global error is set in case driver forgot */
    virSetGlobalError();
1006 1007 1008

    virUnrefConnect(ret);

1009
    return NULL;
1010 1011
}

1012 1013
/**
 * virConnectOpen:
1014
 * @name: URI of the hypervisor
1015
 *
1016
 * This function should be called first to get a connection to the
1017 1018 1019
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1020 1021
 *
 * URIs are documented at http://libvirt.org/uri.html
1022 1023 1024 1025
 */
virConnectPtr
virConnectOpen (const char *name)
{
1026 1027 1028 1029
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1030
    DEBUG("name=%s", name);
1031
    return do_open (name, NULL, 0);
1032 1033
}

1034
/**
1035
 * virConnectOpenReadOnly:
1036
 * @name: URI of the hypervisor
1037
 *
1038
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1039
 * library functionalities. The set of APIs usable are then restricted
1040
 * on the available methods to control the domains.
1041 1042
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1043 1044
 *
 * URIs are documented at http://libvirt.org/uri.html
1045
 */
1046
virConnectPtr
1047 1048
virConnectOpenReadOnly(const char *name)
{
1049 1050 1051 1052
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1053
    DEBUG("name=%s", name);
1054 1055 1056 1057 1058 1059 1060 1061 1062
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1063
 * This function should be called first to get a connection to the
1064
 * Hypervisor. If necessary, authentication will be performed fetching
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
 * 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)
{
1076 1077 1078 1079
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1080
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1081
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1082 1083 1084
}

/**
1085
 * virConnectClose:
D
Daniel Veillard 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
 * @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
1096 1097
virConnectClose(virConnectPtr conn)
{
1098 1099
    DEBUG("conn=%p", conn);

1100 1101 1102 1103
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1104
        return (-1);
1105
    }
1106 1107 1108

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
1109 1110
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1111 1112
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1113
    conn->driver->close (conn);
1114

1115
    if (virUnrefConnect(conn) < 0)
1116
        return (-1);
1117
    return (0);
D
Daniel Veillard 已提交
1118 1119
}

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
/**
 * virConnectRef:
 * @conn: the connection to hold a reference on
 *
 * Increment the reference count on the connection. For each
 * additional call to this method, there shall be a corresponding
 * call to virConnectClose to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a connection would increment
 * the reference count.
 */
int
virConnectRef(virConnectPtr conn)
{
    if ((!VIR_IS_CONNECT(conn))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&conn->lock);
    DEBUG("conn=%p refs=%d", conn, conn->refs);
    conn->refs++;
    virMutexUnlock(&conn->lock);
    return 0;
}

D
Daniel Veillard 已提交
1149 1150
/*
 * Not for public use.  This function is part of the internal
1151 1152 1153
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1154
virDrvSupportsFeature (virConnectPtr conn, int feature)
1155
{
1156
    int ret;
1157 1158
    DEBUG("conn=%p, feature=%d", conn, feature);

1159 1160 1161 1162
    virResetLastError();

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

1166 1167 1168 1169
    ret = VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return ret;
1170 1171
}

1172 1173 1174 1175 1176 1177 1178
/**
 * 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.
1179 1180 1181
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1182 1183
 */
const char *
1184 1185
virConnectGetType(virConnectPtr conn)
{
1186
    const char *ret;
1187
    DEBUG("conn=%p", conn);
1188

1189 1190
    virResetLastError();

D
Daniel Veillard 已提交
1191
    if (!VIR_IS_CONNECT(conn)) {
1192
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1193
        return (NULL);
D
Daniel Veillard 已提交
1194
    }
1195 1196 1197 1198

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1199
    }
1200
    return conn->driver->name;
1201 1202
}

D
Daniel Veillard 已提交
1203
/**
1204
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1205
 * @conn: pointer to the hypervisor connection
1206
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1207
 *
1208
 * Get the version level of the Hypervisor running. This may work only with
1209
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1210
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1211
 *
1212 1213 1214
 * 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 已提交
1215
 */
1216
int
1217 1218
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1219 1220
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

1221 1222
    virResetLastError();

D
Daniel Veillard 已提交
1223
    if (!VIR_IS_CONNECT(conn)) {
1224
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1225
        return -1;
D
Daniel Veillard 已提交
1226
    }
1227

D
Daniel Veillard 已提交
1228 1229
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1230
        goto error;
D
Daniel Veillard 已提交
1231
    }
1232

1233 1234 1235 1236 1237 1238
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1239

1240
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1241 1242 1243 1244

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1245
    return -1;
1246 1247
}

1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
/**
 * 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)
{
1263 1264
    DEBUG("conn=%p", conn);

1265 1266
    virResetLastError();

1267
    if (!VIR_IS_CONNECT(conn)) {
1268
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1269 1270 1271
        return NULL;
    }

1272 1273 1274 1275 1276 1277
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1278 1279

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1280 1281 1282 1283

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
    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)
{
1305
    char *name;
1306 1307
    DEBUG("conn=%p", conn);

1308 1309
    virResetLastError();

1310
    if (!VIR_IS_CONNECT(conn)) {
1311
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1312 1313 1314
        return NULL;
    }

1315 1316 1317
    /* Drivers may override getURI, but if they don't then
     * we provide a default implementation.
     */
1318 1319 1320 1321 1322
    if (conn->driver->getURI) {
        name = conn->driver->getURI (conn);
        if (!name)
            goto error;
    }
1323

1324
    name = (char *)xmlSaveUri(conn->uri);
1325 1326
    if (!name) {
        virLibConnError (conn, VIR_ERR_NO_MEMORY, __FUNCTION__);
1327
        goto error;
1328 1329
    }
    return name;
1330 1331 1332 1333 1334

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
1335 1336
}

1337 1338 1339 1340 1341
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1342
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1343 1344 1345 1346 1347 1348 1349 1350 1351
 * 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)
{
1352 1353
    DEBUG("conn=%p, type=%s", conn, type);

1354 1355
    virResetLastError();

1356
    if (!VIR_IS_CONNECT(conn)) {
1357
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1358
        return -1;
1359 1360
    }

1361 1362 1363 1364 1365 1366
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1367

1368
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1369 1370 1371
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1372
    return -1;
1373 1374
}

1375
/**
1376
 * virConnectListDomains:
1377 1378 1379 1380 1381 1382 1383 1384 1385
 * @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
1386 1387
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1388 1389
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1390 1391
    virResetLastError();

D
Daniel Veillard 已提交
1392
    if (!VIR_IS_CONNECT(conn)) {
1393
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1394
        return -1;
D
Daniel Veillard 已提交
1395
    }
1396

1397
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1398
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1399
        goto error;
D
Daniel Veillard 已提交
1400
    }
1401

1402 1403 1404 1405 1406 1407
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1408

1409
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1410 1411 1412
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1413
    return -1;
D
Daniel Veillard 已提交
1414 1415
}

K
 
Karel Zak 已提交
1416 1417 1418 1419
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1420 1421
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1422 1423 1424
 * Returns the number of domain found or -1 in case of error
 */
int
1425 1426
virConnectNumOfDomains(virConnectPtr conn)
{
1427 1428
    DEBUG("conn=%p", conn);

1429 1430
    virResetLastError();

D
Daniel Veillard 已提交
1431
    if (!VIR_IS_CONNECT(conn)) {
1432
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1433
        goto error;
D
Daniel Veillard 已提交
1434
    }
K
Karel Zak 已提交
1435

1436 1437 1438 1439 1440 1441
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1442

1443
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1444 1445 1446
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1447
    return -1;
K
 
Karel Zak 已提交
1448 1449
}

1450 1451 1452 1453
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1454
 * Provides the connection pointer associated with a domain.  The
1455 1456 1457
 * reference counter on the connection is not increased by this
 * call.
 *
1458 1459 1460 1461
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1462 1463 1464 1465 1466
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1467 1468
    DEBUG("dom=%p", dom);

1469 1470 1471
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1472
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1473 1474 1475 1476 1477
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1478
/**
1479
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1480
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1481
 * @xmlDesc: string containing an XML description of the domain
1482
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1483
 *
1484
 * Launch a new guest domain, based on an XML description similar
1485
 * to the one returned by virDomainGetXMLDesc()
1486
 * This function may requires privileged access to the hypervisor.
1487 1488 1489
 * 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).
1490
 *
D
Daniel Veillard 已提交
1491 1492
 * Returns a new domain object or NULL in case of failure
 */
1493
virDomainPtr
1494 1495
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1496
{
1497 1498
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

1499 1500
    virResetLastError();

D
Daniel Veillard 已提交
1501
    if (!VIR_IS_CONNECT(conn)) {
1502
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1503
        return (NULL);
D
Daniel Veillard 已提交
1504 1505 1506
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1507
        goto error;
D
Daniel Veillard 已提交
1508
    }
1509 1510
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1511
        goto error;
1512
    }
D
Daniel Veillard 已提交
1513

1514 1515 1516 1517 1518 1519 1520
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1521 1522

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1523 1524 1525
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1526
    return NULL;
D
Daniel Veillard 已提交
1527 1528
}

1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
/**
 * 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));
}
1547

1548
/**
1549
 * virDomainLookupByID:
1550 1551 1552 1553
 * @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 已提交
1554 1555
 * 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.
1556
 *
1557 1558
 * 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.
1559
 */
1560
virDomainPtr
1561 1562
virDomainLookupByID(virConnectPtr conn, int id)
{
1563 1564
    DEBUG("conn=%p, id=%d", conn, id);

1565 1566
    virResetLastError();

D
Daniel Veillard 已提交
1567
    if (!VIR_IS_CONNECT(conn)) {
1568
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1569
        return (NULL);
D
Daniel Veillard 已提交
1570 1571 1572
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1573
        goto error;
D
Daniel Veillard 已提交
1574
    }
1575

1576 1577 1578 1579 1580 1581 1582
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1583

1584
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1585 1586 1587 1588

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1589
    return NULL;
1590 1591 1592 1593 1594
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1595
 * @uuid: the raw UUID for the domain
1596 1597 1598
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1599 1600
 * 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.
1601 1602
 */
virDomainPtr
1603 1604
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1605 1606
    DEBUG("conn=%p, uuid=%s", conn, uuid);

1607 1608
    virResetLastError();

D
Daniel Veillard 已提交
1609
    if (!VIR_IS_CONNECT(conn)) {
1610
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1611
        return (NULL);
D
Daniel Veillard 已提交
1612 1613 1614
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1615
        goto error;
D
Daniel Veillard 已提交
1616
    }
1617

1618 1619 1620 1621 1622 1623 1624
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1625

1626
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1627 1628 1629 1630

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1631
    return NULL;
1632 1633
}

K
Karel Zak 已提交
1634 1635 1636 1637 1638 1639 1640
/**
 * 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.
 *
1641 1642
 * 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 已提交
1643 1644 1645 1646
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1647 1648
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1649 1650
    int ret;

1651 1652
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1653 1654
    virResetLastError();

K
Karel Zak 已提交
1655
    if (!VIR_IS_CONNECT(conn)) {
1656
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1657 1658 1659 1660
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1661
        goto error;
K
Karel Zak 已提交
1662
    }
1663 1664
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
     */
    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);
1676

1677
    if (ret!=VIR_UUID_BUFLEN) {
1678
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1679
        goto error;
K
Karel Zak 已提交
1680
    }
1681
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1682
        uuid[i] = raw[i] & 0xFF;
1683

K
Karel Zak 已提交
1684
    return virDomainLookupByUUID(conn, &uuid[0]);
1685 1686 1687 1688 1689

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
K
Karel Zak 已提交
1690 1691
}

1692 1693 1694 1695 1696
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1697
 * Try to lookup a domain on the given hypervisor based on its name.
1698
 *
1699 1700
 * 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.
1701 1702
 */
virDomainPtr
1703 1704
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1705 1706
    DEBUG("conn=%p, name=%s", conn, name);

1707 1708
    virResetLastError();

D
Daniel Veillard 已提交
1709
    if (!VIR_IS_CONNECT(conn)) {
1710
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1711
        return (NULL);
D
Daniel Veillard 已提交
1712 1713 1714
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1715
        goto error;
D
Daniel Veillard 已提交
1716
    }
1717

1718 1719 1720 1721 1722 1723 1724
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
1725 1726

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1727 1728 1729 1730

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1731
    return NULL;
1732 1733
}

D
Daniel Veillard 已提交
1734
/**
1735
 * virDomainDestroy:
D
Daniel Veillard 已提交
1736 1737 1738
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1739 1740 1741
 * 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 已提交
1742 1743
 *
 * Returns 0 in case of success and -1 in case of failure.
1744
 */
D
Daniel Veillard 已提交
1745
int
1746 1747
virDomainDestroy(virDomainPtr domain)
{
1748
    virConnectPtr conn;
1749

1750 1751
    DEBUG("domain=%p", domain);

1752 1753
    virResetLastError();

D
Daniel Veillard 已提交
1754
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1755
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1756
        return (-1);
D
Daniel Veillard 已提交
1757
    }
1758

1759
    conn = domain->conn;
1760 1761
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1762
        goto error;
1763
    }
1764

1765 1766 1767 1768 1769 1770 1771
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1772

1773
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1774 1775 1776 1777

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1778
    return -1;
1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790
}

/**
 * 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
1791 1792
virDomainFree(virDomainPtr domain)
{
1793 1794
    DEBUG("domain=%p", domain);

1795 1796 1797
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1798
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1799
        return (-1);
D
Daniel Veillard 已提交
1800
    }
1801
    if (virUnrefDomain(domain) < 0)
1802
        return -1;
1803
    return(0);
D
Daniel Veillard 已提交
1804 1805
}

1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
/**
 * virDomainRef:
 * @conn: the domain to hold a reference on
 *
 * Increment the reference count on the domain. For each
 * additional call to this method, there shall be a corresponding
 * call to virDomainFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a domain would increment
 * the reference count.
 */
int
virDomainRef(virDomainPtr domain)
{
    if ((!VIR_IS_CONNECTED_DOMAIN(domain))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&domain->conn->lock);
    DEBUG("domain=%p refs=%d", domain, domain->refs);
    domain->refs++;
    virMutexUnlock(&domain->conn->lock);
    return 0;
}


D
Daniel Veillard 已提交
1836
/**
1837
 * virDomainSuspend:
D
Daniel Veillard 已提交
1838 1839 1840
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1841
 * to CPU resources and I/O but the memory used by the domain at the
1842
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1843
 * the domain.
1844
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1845 1846 1847 1848
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1849 1850
virDomainSuspend(virDomainPtr domain)
{
1851
    virConnectPtr conn;
1852
    DEBUG("domain=%p", domain);
1853

1854 1855
    virResetLastError();

D
Daniel Veillard 已提交
1856
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1857
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1858
        return (-1);
D
Daniel Veillard 已提交
1859
    }
1860 1861
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1862
        goto error;
1863
    }
D
Daniel Veillard 已提交
1864

1865 1866
    conn = domain->conn;

1867 1868 1869 1870 1871 1872 1873
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1874

1875
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1876 1877 1878 1879

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
1880
    return -1;
D
Daniel Veillard 已提交
1881 1882 1883
}

/**
1884
 * virDomainResume:
D
Daniel Veillard 已提交
1885 1886 1887
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1888
 * it was frozen by calling virSuspendDomain().
1889
 * This function may requires privileged access
D
Daniel Veillard 已提交
1890 1891 1892 1893
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1894 1895
virDomainResume(virDomainPtr domain)
{
1896
    virConnectPtr conn;
1897
    DEBUG("domain=%p", domain);
1898

1899 1900
    virResetLastError();

D
Daniel Veillard 已提交
1901
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1902
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1903
        return (-1);
D
Daniel Veillard 已提交
1904
    }
1905 1906
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1907
        goto error;
1908
    }
D
Daniel Veillard 已提交
1909

1910 1911
    conn = domain->conn;

1912 1913 1914 1915 1916 1917 1918
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1919

1920
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1921 1922 1923 1924

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
1925
    return -1;
D
Daniel Veillard 已提交
1926 1927
}

1928 1929 1930 1931 1932 1933
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1934 1935 1936
 * 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.
1937 1938 1939 1940
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1941 1942
virDomainSave(virDomainPtr domain, const char *to)
{
1943
    char filepath[4096];
1944
    virConnectPtr conn;
1945
    DEBUG("domain=%p, to=%s", domain, to);
1946

1947 1948
    virResetLastError();

D
Daniel Veillard 已提交
1949
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1950
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1951
        return (-1);
D
Daniel Veillard 已提交
1952
    }
1953 1954
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1955
        goto error;
1956
    }
1957
    conn = domain->conn;
D
Daniel Veillard 已提交
1958 1959
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1960
        goto error;
D
Daniel Veillard 已提交
1961
    }
1962

1963 1964 1965 1966 1967
    /*
     * 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] != '/') {
1968
        unsigned int len, t;
1969

1970 1971 1972 1973 1974 1975 1976 1977 1978 1979
        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];
1980 1981 1982

    }

1983 1984 1985 1986 1987 1988 1989
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
1990

1991
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1992 1993 1994 1995

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
1996
    return -1;
1997 1998 1999 2000
}

/**
 * virDomainRestore:
2001
 * @conn: pointer to the hypervisor connection
2002
 * @from: path to the
2003 2004 2005 2006 2007 2008
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2009 2010
virDomainRestore(virConnectPtr conn, const char *from)
{
2011
    char filepath[4096];
2012
    DEBUG("conn=%p, from=%s", conn, from);
2013

2014 2015
    virResetLastError();

D
Daniel Veillard 已提交
2016
    if (!VIR_IS_CONNECT(conn)) {
2017
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2018
        return (-1);
D
Daniel Veillard 已提交
2019
    }
2020 2021
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2022
        goto error;
2023
    }
D
Daniel Veillard 已提交
2024 2025
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2026
        goto error;
D
Daniel Veillard 已提交
2027 2028
    }

2029 2030 2031 2032 2033
    /*
     * 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] != '/') {
2034 2035 2036
        unsigned int len, t;

        t = strlen(from);
2037 2038 2039 2040 2041
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2042 2043
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2044 2045 2046 2047 2048
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2049 2050 2051 2052 2053
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2054 2055 2056 2057 2058 2059 2060
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2061

2062
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2063 2064 2065 2066

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
2067
    return -1;
D
Daniel Veillard 已提交
2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
}

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

2089 2090
    virResetLastError();

D
Daniel Veillard 已提交
2091
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2092
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
2093 2094 2095 2096
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2097
        goto error;
D
Daniel Veillard 已提交
2098 2099 2100 2101
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2102
        goto error;
D
Daniel Veillard 已提交
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
    }

    /*
     * 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);
2113 2114 2115 2116 2117
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibDomainError(domain, VIR_ERR_SYSTEM_ERROR,
                              _("cannot get current directory"));
            goto error;
        }
D
Daniel Veillard 已提交
2118 2119
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2120 2121 2122 2123 2124
        if (len > sizeof(filepath) - (t + 3)) {
            virLibDomainError(domain, VIR_ERR_INTERNAL_ERROR,
                              _("path too long"));
            goto error;
        }
D
Daniel Veillard 已提交
2125 2126 2127 2128 2129 2130
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

2131 2132 2133 2134 2135 2136 2137
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2138

2139
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2140 2141 2142 2143

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2144
    return -1;
2145 2146
}

2147 2148 2149 2150 2151
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2152 2153
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2154 2155 2156 2157 2158 2159 2160
 *
 * 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
2161 2162
virDomainShutdown(virDomainPtr domain)
{
2163
    virConnectPtr conn;
2164
    DEBUG("domain=%p", domain);
2165

2166 2167
    virResetLastError();

D
Daniel Veillard 已提交
2168
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2169
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2170
        return (-1);
D
Daniel Veillard 已提交
2171
    }
2172 2173
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2174
        goto error;
2175
    }
2176

2177 2178
    conn = domain->conn;

2179 2180 2181 2182 2183 2184 2185
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2186

2187
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2188 2189 2190 2191

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2192
    return -1;
2193 2194
}

2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
/**
 * 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)
{
2209
    virConnectPtr conn;
2210
    DEBUG("domain=%p, flags=%u", domain, flags);
2211

2212 2213
    virResetLastError();

2214
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2215
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2216 2217
        return (-1);
    }
2218 2219
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2220
        goto error;
2221
    }
2222

2223 2224
    conn = domain->conn;

2225 2226 2227 2228 2229 2230 2231
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2232

2233
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2234 2235 2236 2237

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2238
    return -1;
2239 2240
}

2241
/**
2242
 * virDomainGetName:
2243 2244 2245 2246 2247 2248 2249 2250
 * @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 *
2251 2252
virDomainGetName(virDomainPtr domain)
{
2253 2254
    DEBUG("domain=%p", domain);

2255 2256
    virResetLastError();

D
Daniel Veillard 已提交
2257
    if (!VIR_IS_DOMAIN(domain)) {
2258
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2259
        return (NULL);
D
Daniel Veillard 已提交
2260
    }
2261
    return (domain->name);
2262 2263
}

2264 2265 2266
/**
 * virDomainGetUUID:
 * @domain: a domain object
2267
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2268 2269 2270 2271 2272 2273
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2274 2275
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2276 2277
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2278 2279
    virResetLastError();

D
Daniel Veillard 已提交
2280
    if (!VIR_IS_DOMAIN(domain)) {
2281
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2282
        return (-1);
D
Daniel Veillard 已提交
2283 2284 2285
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2286 2287
        /* Copy to connection error object for back compatability */
        virSetConnError(domain->conn);
2288
        return (-1);
D
Daniel Veillard 已提交
2289 2290
    }

2291 2292
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2293
    return (0);
2294 2295
}

K
Karel Zak 已提交
2296 2297 2298
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2299
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2300
 *
2301
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2302 2303 2304 2305 2306 2307 2308
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2309
    unsigned char uuid[VIR_UUID_BUFLEN];
2310
    DEBUG("domain=%p, buf=%p", domain, buf);
2311

2312 2313
    virResetLastError();

K
Karel Zak 已提交
2314
    if (!VIR_IS_DOMAIN(domain)) {
2315
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
2316 2317 2318 2319
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2320
        goto error;
K
Karel Zak 已提交
2321
    }
2322

K
Karel Zak 已提交
2323
    if (virDomainGetUUID(domain, &uuid[0]))
2324
        goto error;
K
Karel Zak 已提交
2325

2326
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2327
    return (0);
2328 2329 2330 2331 2332

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
    return -1;
K
Karel Zak 已提交
2333 2334
}

2335
/**
2336
 * virDomainGetID:
2337 2338 2339 2340 2341 2342 2343
 * @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
2344 2345
virDomainGetID(virDomainPtr domain)
{
2346 2347
    DEBUG("domain=%p", domain);

2348 2349
    virResetLastError();

D
Daniel Veillard 已提交
2350
    if (!VIR_IS_DOMAIN(domain)) {
2351
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2352
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2353
    }
2354
    return (domain->id);
2355 2356
}

2357 2358 2359 2360 2361 2362
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2363 2364
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2365 2366
 */
char *
2367 2368
virDomainGetOSType(virDomainPtr domain)
{
2369
    virConnectPtr conn;
2370
    DEBUG("domain=%p", domain);
2371

2372 2373 2374
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2375
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2376
        return (NULL);
D
Daniel Veillard 已提交
2377
    }
2378

2379 2380
    conn = domain->conn;

2381 2382 2383 2384 2385 2386 2387
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2388

2389
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2390 2391 2392 2393

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2394
    return NULL;
2395 2396
}

2397
/**
2398
 * virDomainGetMaxMemory:
2399
 * @domain: a domain object or NULL
2400
 *
2401 2402 2403 2404 2405 2406 2407
 * 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
2408 2409
virDomainGetMaxMemory(virDomainPtr domain)
{
2410
    virConnectPtr conn;
2411
    DEBUG("domain=%p", domain);
2412

2413 2414
    virResetLastError();

D
Daniel Veillard 已提交
2415
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2416
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2417
        return (0);
D
Daniel Veillard 已提交
2418
    }
2419

2420 2421
    conn = domain->conn;

2422 2423 2424 2425 2426 2427 2428
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2429

2430
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2431 2432 2433 2434

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2435
    return 0;
2436 2437
}

D
Daniel Veillard 已提交
2438
/**
2439
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2440 2441
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2442
 *
D
Daniel Veillard 已提交
2443 2444 2445
 * 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.
2446
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2447 2448 2449 2450
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2451 2452
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2453
    virConnectPtr conn;
2454
    DEBUG("domain=%p, memory=%lu", domain, memory);
2455

2456 2457
    virResetLastError();

2458
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2459
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2460
        return (-1);
2461
    }
2462 2463
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2464
        goto error;
2465 2466 2467
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2468
        goto error;
2469
    }
2470
    conn = domain->conn;
2471

2472 2473 2474 2475 2476 2477 2478
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2479

2480
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2481 2482 2483 2484

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2485
    return -1;
2486
}
2487

2488 2489 2490 2491
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2492
 *
2493 2494 2495
 * 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.
2496
 * This function may requires privileged access to the hypervisor.
2497 2498 2499 2500 2501 2502 2503
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2504
    DEBUG("domain=%p, memory=%lu", domain, memory);
2505

2506 2507
    virResetLastError();

2508
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2509
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2510
        return (-1);
2511
    }
2512 2513
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2514
        goto error;
2515 2516 2517
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2518
        goto error;
2519 2520 2521
    }

    conn = domain->conn;
2522

2523 2524 2525 2526 2527 2528 2529
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2530

2531
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2532 2533 2534 2535

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2536
    return -1;
D
Daniel Veillard 已提交
2537 2538
}

2539 2540
/**
 * virDomainGetInfo:
2541
 * @domain: a domain object
2542
 * @info: pointer to a virDomainInfo structure allocated by the user
2543
 *
2544
 * Extract information about a domain. Note that if the connection
2545
 * used to get the domain is limited only a partial set of the information
2546 2547 2548 2549 2550
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2551 2552
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2553
    virConnectPtr conn;
2554
    DEBUG("domain=%p, info=%p", domain, info);
2555

2556 2557
    virResetLastError();

D
Daniel Veillard 已提交
2558
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2559
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2560
        return (-1);
D
Daniel Veillard 已提交
2561 2562 2563
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2564
        goto error;
D
Daniel Veillard 已提交
2565
    }
2566

2567
    memset(info, 0, sizeof(virDomainInfo));
2568

2569 2570
    conn = domain->conn;

2571 2572 2573 2574 2575 2576 2577
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2578

2579
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2580 2581 2582 2583

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2584
    return -1;
2585
}
2586

2587 2588 2589
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2590
 * @flags: an OR'ed set of virDomainXMLFlags
2591 2592
 *
 * Provide an XML description of the domain. The description may be reused
2593
 * later to relaunch the domain with virDomainCreateXML().
2594 2595 2596 2597 2598
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2599 2600
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2601
    virConnectPtr conn;
2602
    DEBUG("domain=%p, flags=%d", domain, flags);
2603

2604 2605 2606
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2607
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2608
        return (NULL);
D
Daniel Veillard 已提交
2609
    }
2610

2611 2612
    conn = domain->conn;

2613 2614 2615 2616 2617 2618 2619
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
2620

2621
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2622 2623 2624 2625

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2626
    return NULL;
2627
}
2628

2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688
/**
 * 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 已提交
2689 2690
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2691 2692 2693
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

2694 2695 2696
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2697
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2698 2699 2700 2701 2702
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
2703
        goto error;
2704 2705
    }

2706 2707
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2708
        goto error;
2709 2710 2711 2712
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, delibrately report error against source object, not dest here */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2713
        goto error;
2714 2715
    }

2716
    /* Check that migration is supported by both drivers. */
D
Daniel Veillard 已提交
2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
    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 {
2728
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2729
        goto error;
2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742
    }

    /* 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 已提交
2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755
    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);
2756
    }
D
Daniel Veillard 已提交
2757 2758 2759 2760 2761 2762 2763
    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__);
2764
            goto error;
D
Daniel Veillard 已提交
2765 2766 2767
        }
        dom_xml = conn->driver->domainDumpXML (domain,
                                               VIR_DOMAIN_XML_SECURE);
2768

D
Daniel Veillard 已提交
2769
        if (!dom_xml)
2770
            goto error;
D
Daniel Veillard 已提交
2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785

        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);
    }
2786 2787 2788 2789 2790 2791 2792

    /* 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 已提交
2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814
    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);
    }
2815 2816

 done:
2817 2818
    free (uri_out);
    free (cookie);
2819
    return ddomain;
2820 2821 2822 2823 2824

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
    return NULL;
2825 2826
}

D
Daniel Veillard 已提交
2827 2828
/*
 * Not for public use.  This function is part of the internal
2829 2830 2831
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2832
virDomainMigratePrepare (virConnectPtr dconn,
2833 2834 2835 2836 2837 2838 2839 2840 2841 2842
                           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);

2843 2844
    virResetLastError();

2845
    if (!VIR_IS_CONNECT (dconn)) {
2846
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2847 2848 2849
        return -1;
    }

2850 2851
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2852
        goto error;
2853 2854
    }

2855 2856 2857 2858 2859 2860 2861 2862 2863
    if (dconn->driver->domainMigratePrepare) {
        int ret;
        ret = dconn->driver->domainMigratePrepare (dconn, cookie, cookielen,
                                                   uri_in, uri_out,
                                                   flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
2864 2865

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2866 2867 2868 2869

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
2870 2871 2872
    return -1;
}

D
Daniel Veillard 已提交
2873 2874
/*
 * Not for public use.  This function is part of the internal
2875 2876 2877
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2878
virDomainMigratePerform (virDomainPtr domain,
2879 2880 2881 2882 2883 2884 2885 2886 2887 2888
                           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);

2889 2890 2891
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2892
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2893 2894 2895 2896
        return -1;
    }
    conn = domain->conn;

2897 2898
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2899
        goto error;
2900 2901
    }

2902 2903 2904 2905 2906 2907 2908 2909 2910
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
2911 2912

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2913 2914 2915 2916

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2917 2918 2919
    return -1;
}

D
Daniel Veillard 已提交
2920 2921
/*
 * Not for public use.  This function is part of the internal
2922 2923 2924
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2925
virDomainMigrateFinish (virConnectPtr dconn,
2926 2927 2928 2929 2930 2931 2932 2933
                          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);

2934 2935
    virResetLastError();

2936
    if (!VIR_IS_CONNECT (dconn)) {
2937
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2938 2939 2940
        return NULL;
    }

2941 2942
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2943
        goto error;
2944 2945
    }

2946 2947 2948 2949 2950 2951 2952 2953 2954
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
2955 2956

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2957 2958 2959 2960

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
2961
    return NULL;
D
Daniel Veillard 已提交
2962 2963 2964
}


D
Daniel Veillard 已提交
2965 2966
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2967 2968 2969
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2970 2971 2972 2973 2974 2975 2976 2977 2978
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 已提交
2979 2980 2981
{
    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);

2982 2983
    virResetLastError();

D
Daniel Veillard 已提交
2984 2985 2986 2987 2988
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

2989 2990
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2991
        goto error;
2992 2993
    }

2994 2995 2996 2997 2998 2999 3000 3001 3002 3003
    if (dconn->driver->domainMigratePrepare2) {
        int ret;
        ret = dconn->driver->domainMigratePrepare2 (dconn, cookie, cookielen,
                                                    uri_in, uri_out,
                                                    flags, dname, bandwidth,
                                                    dom_xml);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel Veillard 已提交
3004 3005

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3006 3007 3008 3009

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3010 3011 3012
    return -1;
}

D
Daniel Veillard 已提交
3013 3014
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3015 3016 3017
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3018 3019 3020 3021 3022 3023 3024
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3025 3026 3027
{
    DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, flags=%lu, retcode=%d", dconn, dname, cookie, cookielen, uri, flags, retcode);

3028 3029
    virResetLastError();

D
Daniel Veillard 已提交
3030 3031 3032 3033 3034
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3035 3036
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3037
        goto error;
3038 3039
    }

3040 3041 3042 3043 3044 3045 3046 3047 3048 3049
    if (dconn->driver->domainMigrateFinish2) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish2 (dconn, dname,
                                                   cookie, cookielen,
                                                   uri, flags,
                                                   retcode);
        if (!ret)
            goto error;
        return ret;
    }
D
Daniel Veillard 已提交
3050 3051

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3052 3053 3054 3055

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3056
    return NULL;
3057 3058 3059
}


3060 3061 3062 3063
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3064
 *
3065 3066 3067 3068 3069
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3070 3071
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3072 3073
    DEBUG("conn=%p, info=%p", conn, info);

3074 3075
    virResetLastError();

3076
    if (!VIR_IS_CONNECT(conn)) {
3077
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3078 3079 3080 3081
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3082
        goto error;
3083 3084
    }

3085 3086 3087 3088 3089 3090 3091
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3092

3093
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3094 3095 3096 3097

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3098
    return -1;
3099
}
3100

3101 3102 3103 3104 3105 3106
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
3107 3108
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
3109 3110 3111 3112 3113
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
3114 3115
    DEBUG("conn=%p", conn);

3116 3117
    virResetLastError();

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

3123 3124 3125 3126 3127 3128 3129
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3130

3131
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3132 3133 3134 3135

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3136 3137 3138
    return NULL;
}

3139 3140 3141
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
3142
 *
D
Daniel Veillard 已提交
3143
 * provides the free memory available on the Node
3144 3145 3146 3147 3148 3149
 *
 * Returns the available free memory in kilobytes or 0 in case of error
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
3150 3151
    DEBUG("conn=%p", conn);

3152 3153
    virResetLastError();

3154 3155 3156 3157 3158
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3159 3160 3161 3162 3163 3164 3165
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3166 3167

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3168 3169 3170 3171

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3172 3173 3174
    return 0;
}

3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188
/**
 * 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;
3189
    DEBUG("domain=%p, nparams=%p", domain, nparams);
3190

3191 3192
    virResetLastError();

3193
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3194
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3195 3196 3197 3198 3199 3200
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3201 3202
        if (!schedtype)
            goto error;
3203 3204 3205
        return schedtype;
    }

3206
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3207 3208 3209 3210

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230
    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,
3231
                                virSchedParameterPtr params, int *nparams)
3232 3233
{
    virConnectPtr conn;
3234
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
3235

3236 3237
    virResetLastError();

3238
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3239
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3240 3241 3242 3243
        return -1;
    }
    conn = domain->conn;

3244 3245 3246 3247 3248 3249 3250
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3251

3252
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3253 3254 3255 3256

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272
    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
3273
virDomainSetSchedulerParameters(virDomainPtr domain,
3274
                                virSchedParameterPtr params, int nparams)
3275 3276
{
    virConnectPtr conn;
3277
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
3278

3279 3280
    virResetLastError();

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

3291 3292 3293 3294 3295 3296 3297
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3298

3299
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3300 3301 3302 3303

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3304 3305 3306 3307
    return -1;
}


3308
/**
3309
 * virDomainBlockStats:
3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338
 * @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);

3339 3340
    virResetLastError();

3341
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3342
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3343 3344
        return -1;
    }
3345 3346 3347 3348
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3349 3350 3351 3352
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3353
            goto error;
3354 3355 3356 3357 3358 3359

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3360 3361 3362 3363

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3364 3365 3366 3367
    return -1;
}

/**
3368
 * virDomainInterfaceStats:
3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396
 * @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);

3397 3398
    virResetLastError();

3399
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3400
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3401 3402
        return -1;
    }
3403 3404 3405 3406
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3407 3408 3409 3410
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3411
            goto error;
3412 3413 3414 3415 3416 3417

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3418 3419 3420 3421

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3422 3423 3424
    return -1;
}

R
Richard W.M. Jones 已提交
3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457
/**
 * 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 已提交
3458 3459 3460 3461
 * 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 已提交
3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475
 * 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);

3476 3477
    virResetLastError();

R
Richard W.M. Jones 已提交
3478 3479 3480 3481 3482
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3483

3484 3485
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3486
        goto error;
3487 3488
    }

R
Richard W.M. Jones 已提交
3489 3490 3491
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
3492
        goto error;
R
Richard W.M. Jones 已提交
3493 3494 3495 3496 3497
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
3498
        goto error;
R
Richard W.M. Jones 已提交
3499 3500 3501 3502 3503 3504
    }

    /* Allow size == 0 as an access test. */
    if (size > 0 && !buffer) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("buffer is NULL"));
3505
        goto error;
R
Richard W.M. Jones 已提交
3506 3507
    }

3508 3509 3510 3511 3512 3513 3514 3515
    if (conn->driver->domainBlockPeek) {
        int ret;
        ret =conn->driver->domainBlockPeek (dom, path, offset, size,
                                            buffer, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
R
Richard W.M. Jones 已提交
3516 3517

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3518 3519 3520 3521

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
R
Richard W.M. Jones 已提交
3522 3523
    return -1;
}
3524

R
Richard W.M. Jones 已提交
3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566
/**
 * 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);

3567 3568
    virResetLastError();

R
Richard W.M. Jones 已提交
3569 3570 3571 3572 3573 3574
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3575 3576
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3577
        goto error;
3578 3579
    }

R
Richard W.M. Jones 已提交
3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603
    /* 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"));
3604
        goto error;
R
Richard W.M. Jones 已提交
3605 3606 3607 3608 3609 3610
    }

    /* 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"));
3611
        goto error;
R
Richard W.M. Jones 已提交
3612 3613
    }

3614 3615 3616 3617 3618 3619 3620 3621
    if (conn->driver->domainMemoryPeek) {
        int ret;
        ret = conn->driver->domainMemoryPeek (dom, start, size,
                                              buffer, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
R
Richard W.M. Jones 已提交
3622 3623

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3624 3625 3626 3627

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
R
Richard W.M. Jones 已提交
3628 3629 3630
    return -1;
}

3631

3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642
/************************************************************************
 *									*
 *		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
 *
3643 3644 3645
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
 * virDomainUndefine().
3646 3647 3648 3649 3650
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3651 3652
    DEBUG("conn=%p, xml=%s", conn, xml);

3653 3654
    virResetLastError();

3655
    if (!VIR_IS_CONNECT(conn)) {
3656
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3657 3658
        return (NULL);
    }
3659 3660
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3661
        goto error;
3662
    }
3663 3664
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3665
        goto error;
3666 3667
    }

3668 3669 3670 3671 3672 3673 3674
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3675

3676
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3677 3678 3679 3680

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3681
    return NULL;
3682 3683 3684 3685 3686 3687
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3688
 * Undefine a domain but does not stop it if it is running
3689 3690 3691 3692 3693
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3694
    virConnectPtr conn;
3695
    DEBUG("domain=%p", domain);
3696

3697 3698
    virResetLastError();

3699
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3700
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3701 3702
        return (-1);
    }
3703 3704
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3705
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3706
        goto error;
3707 3708
    }

3709 3710 3711 3712 3713 3714 3715
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3716

3717
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3718 3719 3720 3721

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3722
    return -1;
3723 3724 3725 3726 3727 3728
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3729
 * Provides the number of defined but inactive domains.
3730 3731 3732 3733 3734 3735
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3736 3737
    DEBUG("conn=%p", conn);

3738 3739
    virResetLastError();

3740
    if (!VIR_IS_CONNECT(conn)) {
3741
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3742 3743 3744
        return (-1);
    }

3745 3746 3747 3748 3749 3750 3751
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
3752

3753
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3754 3755 3756 3757

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3758
    return -1;
3759 3760 3761 3762 3763 3764 3765 3766
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
3767 3768
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
3769
 *
3770 3771 3772
 * Returns the number of names provided in the array or -1 in case of error
 */
int
3773
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
3774
                             int maxnames) {
3775 3776
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3777 3778
    virResetLastError();

3779
    if (!VIR_IS_CONNECT(conn)) {
3780
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3781 3782 3783
        return (-1);
    }

3784
    if ((names == NULL) || (maxnames < 0)) {
3785
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3786
        goto error;
3787 3788
    }

3789 3790 3791 3792 3793 3794 3795
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
3796

3797
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3798 3799 3800 3801

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3802
    return -1;
3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815
}

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

3819 3820
    virResetLastError();

3821
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3822
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3823 3824
        return (-1);
    }
3825 3826
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3827
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3828
        goto error;
3829
    }
3830

3831 3832 3833 3834 3835 3836 3837
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3838

3839
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3840 3841 3842 3843

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3844
    return -1;
3845 3846
}

3847 3848 3849
/**
 * virDomainGetAutostart:
 * @domain: a domain object
3850
 * @autostart: the value returned
3851
 *
3852
 * Provides a boolean value indicating whether the domain
3853 3854 3855 3856 3857 3858 3859
 * 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,
3860 3861 3862
                      int *autostart)
{
    virConnectPtr conn;
3863
    DEBUG("domain=%p, autostart=%p", domain, autostart);
3864

3865 3866 3867
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3868
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3869 3870 3871 3872
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
3873
        goto error;
3874 3875
    }

3876 3877
    conn = domain->conn;

3878 3879 3880 3881 3882 3883 3884
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
3885

3886
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3887 3888 3889 3890

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3891
    return -1;
3892 3893 3894 3895 3896
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3897
 * @autostart: whether the domain should be automatically started 0 or 1
3898 3899 3900 3901 3902 3903 3904 3905
 *
 * 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,
3906 3907 3908
                      int autostart)
{
    virConnectPtr conn;
3909
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3910

3911 3912 3913
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3914
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3915 3916 3917
        return (-1);
    }

3918 3919
    conn = domain->conn;

3920 3921
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3922
        goto error;
3923 3924
    }

3925 3926 3927 3928 3929 3930 3931
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
3932

3933
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3934 3935 3936 3937

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3938
    return -1;
3939 3940
}

3941 3942 3943 3944 3945 3946 3947 3948
/**
 * 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.
3949
 * This function requires privileged access to the hypervisor.
3950 3951 3952 3953 3954 3955 3956
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3957
    virConnectPtr conn;
3958
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3959

3960 3961
    virResetLastError();

3962
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3963
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3964 3965
        return (-1);
    }
3966 3967
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3968
        goto error;
3969
    }
3970

3971 3972
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
3973
        goto error;
3974
    }
3975
    conn = domain->conn;
3976

3977 3978 3979 3980 3981 3982 3983
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
3984

3985
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3986 3987 3988 3989

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3990
    return -1;
3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004
}

/**
 * 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.
4005
 *
4006
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
4007
 * This function requires privileged access to the hypervisor.
4008 4009 4010 4011 4012 4013 4014
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
4015
    virConnectPtr conn;
4016
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
4017

4018 4019
    virResetLastError();

4020
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4021
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4022 4023
        return (-1);
    }
4024 4025
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4026
        goto error;
4027
    }
4028

4029
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4030
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4031
       goto error;
4032
    }
4033

4034 4035
    conn = domain->conn;

4036 4037 4038 4039 4040 4041 4042
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4043

4044
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4045 4046 4047 4048

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4049
    return -1;
4050 4051 4052 4053 4054 4055 4056 4057 4058
}

/**
 * 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 已提交
4059
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
4060 4061 4062 4063 4064 4065 4066
 *	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...).
4067
 *
4068
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
4069
 * and also in cpumaps if this pointer isn't NULL.
4070 4071 4072 4073 4074
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
4075
                  unsigned char *cpumaps, int maplen)
4076
{
4077
    virConnectPtr conn;
4078
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
4079

4080 4081
    virResetLastError();

4082
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4083
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4084 4085 4086 4087
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4088
        goto error;
4089 4090 4091
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4092
        goto error;
4093
    }
4094

4095 4096
    conn = domain->conn;

4097 4098 4099 4100 4101 4102 4103 4104
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4105

4106
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4107 4108 4109 4110

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4111
    return -1;
4112
}
4113

4114 4115 4116
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
4117
 *
4118 4119 4120 4121 4122
 * 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.
4123 4124 4125 4126
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
4127 4128
virDomainGetMaxVcpus(virDomainPtr domain)
{
4129
    virConnectPtr conn;
4130
    DEBUG("domain=%p", domain);
4131

4132 4133
    virResetLastError();

4134
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4135
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4136 4137 4138 4139 4140
        return (-1);
    }

    conn = domain->conn;

4141 4142 4143 4144 4145 4146 4147
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4148

4149
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4150 4151 4152 4153

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4154
    return -1;
4155 4156 4157
}


4158 4159 4160 4161
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4162
 *
4163 4164 4165 4166 4167
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4168
virDomainAttachDevice(virDomainPtr domain, const char *xml)
4169 4170
{
    virConnectPtr conn;
4171
    DEBUG("domain=%p, xml=%s", domain, xml);
4172

4173 4174
    virResetLastError();

4175
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4176
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4177 4178 4179 4180
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4181
        goto error;
4182 4183 4184
    }
    conn = domain->conn;

4185 4186 4187 4188 4189 4190 4191
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4192

4193
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4194 4195 4196 4197

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4198
    return -1;
4199 4200 4201 4202 4203 4204
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4205
 *
4206 4207 4208 4209 4210
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4211
virDomainDetachDevice(virDomainPtr domain, const char *xml)
4212 4213
{
    virConnectPtr conn;
4214
    DEBUG("domain=%p, xml=%s", domain, xml);
4215

4216 4217
    virResetLastError();

4218
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4219
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4220 4221 4222 4223
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4224
        goto error;
4225 4226 4227
    }
    conn = domain->conn;

4228 4229 4230 4231 4232 4233 4234
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4235

4236
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4237 4238 4239 4240

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4241
    return -1;
4242
}
4243

4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265
/**
 * 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)
{
4266 4267 4268
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

4269 4270
    virResetLastError();

4271 4272 4273 4274 4275
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4276
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4277
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4278
        goto error;
4279 4280
    }

4281 4282 4283 4284 4285 4286 4287
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4288 4289

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4290 4291 4292 4293

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4294 4295 4296
    return -1;
}

4297 4298 4299 4300
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
4301
 * Provides the connection pointer associated with a network.  The
4302 4303 4304
 * reference counter on the connection is not increased by this
 * call.
 *
4305 4306 4307 4308
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
4309 4310 4311 4312 4313
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
4314 4315
    DEBUG("net=%p", net);

4316 4317 4318
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4319
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4320 4321 4322 4323 4324
        return NULL;
    }
    return net->conn;
}

4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335
/**
 * 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)
{
4336 4337
    DEBUG("conn=%p", conn);

4338 4339
    virResetLastError();

4340
    if (!VIR_IS_CONNECT(conn)) {
4341
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4342 4343 4344
        return (-1);
    }

4345 4346 4347 4348 4349 4350 4351
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4352

4353
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4354 4355 4356 4357

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4358
    return -1;
4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371
}

/**
 * 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
4372
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4373
{
4374 4375
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4376 4377
    virResetLastError();

4378
    if (!VIR_IS_CONNECT(conn)) {
4379
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4380 4381 4382
        return (-1);
    }

4383
    if ((names == NULL) || (maxnames < 0)) {
4384
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4385
        goto error;
4386 4387
    }

4388 4389 4390 4391 4392 4393 4394
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4395

4396
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4397 4398 4399 4400

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4401
    return -1;
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414
}

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

4417 4418
    virResetLastError();

4419
    if (!VIR_IS_CONNECT(conn)) {
4420
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4421 4422 4423
        return (-1);
    }

4424 4425 4426 4427 4428 4429 4430
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4431

4432
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4433 4434 4435 4436

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4437
    return -1;
4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450
}

/**
 * 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
4451
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4452 4453
                              int maxnames)
{
4454 4455
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4456 4457
    virResetLastError();

4458
    if (!VIR_IS_CONNECT(conn)) {
4459
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4460 4461 4462
        return (-1);
    }

4463
    if ((names == NULL) || (maxnames < 0)) {
4464
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4465
        goto error;
4466 4467
    }

4468 4469 4470 4471 4472 4473 4474 4475
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4476

4477
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4478 4479 4480 4481

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4482
    return -1;
4483 4484 4485 4486 4487 4488 4489 4490 4491
}

/**
 * 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.
 *
4492 4493
 * 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.
4494 4495 4496 4497
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
4498 4499
    DEBUG("conn=%p, name=%s", conn, name);

4500 4501
    virResetLastError();

4502
    if (!VIR_IS_CONNECT(conn)) {
4503
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4504 4505 4506 4507
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4508
        goto  error;
4509 4510
    }

4511 4512 4513 4514 4515 4516 4517
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
4518

4519
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4520 4521 4522 4523

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4524
    return NULL;
4525 4526 4527 4528 4529 4530 4531 4532 4533
}

/**
 * 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.
 *
4534 4535
 * 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.
4536 4537 4538 4539
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
4540 4541
    DEBUG("conn=%p, uuid=%s", conn, uuid);

4542 4543
    virResetLastError();

4544
    if (!VIR_IS_CONNECT(conn)) {
4545
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4546 4547 4548 4549
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4550
        goto error;
4551 4552
    }

4553 4554 4555 4556 4557 4558 4559
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4560

4561
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4562 4563 4564 4565

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4566
    return NULL;
4567 4568 4569 4570 4571 4572 4573 4574 4575
}

/**
 * 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.
 *
4576 4577
 * 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.
4578 4579 4580 4581 4582 4583 4584
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
4585
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
4586

4587 4588
    virResetLastError();

4589
    if (!VIR_IS_CONNECT(conn)) {
4590
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4591 4592 4593 4594
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4595
        goto error;
4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612
    }

    /* 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) {
4613
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4614
        goto error;
4615 4616 4617 4618 4619
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

    return virNetworkLookupByUUID(conn, &uuid[0]);
4620 4621 4622 4623 4624

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639
}

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

4642 4643
    virResetLastError();

4644
    if (!VIR_IS_CONNECT(conn)) {
4645
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4646 4647 4648 4649
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4650
        goto error;
4651 4652 4653
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4654
        goto error;
4655 4656
    }

4657 4658 4659 4660 4661 4662 4663
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
4664

4665
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4666 4667 4668 4669

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4670
    return NULL;
4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682
}

/**
 * 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
4683 4684
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
4685 4686
    DEBUG("conn=%p, xml=%s", conn, xml);

4687 4688
    virResetLastError();

4689
    if (!VIR_IS_CONNECT(conn)) {
4690
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4691 4692 4693 4694
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4695
        goto error;
4696 4697 4698
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4699
        goto error;
4700 4701
    }

4702 4703 4704 4705 4706 4707 4708
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4709

4710
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4711 4712 4713 4714

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4715
    return NULL;
4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728
}

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

4731 4732
    virResetLastError();

4733
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4734
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4735 4736 4737 4738 4739
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4740
        goto error;
4741 4742
    }

4743 4744 4745 4746 4747 4748 4749
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4750

4751
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4752 4753 4754 4755

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4756
    return -1;
4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768
}

/**
 * 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
4769 4770
virNetworkCreate(virNetworkPtr network)
{
4771
    virConnectPtr conn;
4772 4773
    DEBUG("network=%p", network);

4774 4775
    virResetLastError();

4776
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4777
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4778 4779 4780 4781 4782
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4783
        goto error;
4784 4785
    }

4786 4787 4788 4789 4790 4791 4792
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4793

4794
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4795 4796 4797 4798

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4799
    return -1;
4800 4801 4802 4803 4804 4805 4806
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
4807 4808 4809
 * 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
4810 4811 4812 4813 4814 4815 4816
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
4817
    DEBUG("network=%p", network);
4818

4819 4820
    virResetLastError();

4821
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4822
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4823 4824 4825 4826 4827 4828
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4829
        goto error;
4830 4831
    }

4832 4833 4834 4835 4836 4837 4838
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4839

4840
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4841 4842 4843 4844

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4845
    return -1;
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859
}

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

4862 4863 4864
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4865
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4866 4867
        return (-1);
    }
4868
    if (virUnrefNetwork(network) < 0)
4869 4870 4871 4872
        return (-1);
    return(0);
}

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
/**
 * virNetworkRef:
 * @conn: the network to hold a reference on
 *
 * Increment the reference count on the network. For each
 * additional call to this method, there shall be a corresponding
 * call to virNetworkFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a network would increment
 * the reference count.
 */
int
virNetworkRef(virNetworkPtr network)
{
    if ((!VIR_IS_CONNECTED_NETWORK(network))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&network->conn->lock);
    DEBUG("network=%p refs=%d", network, network->refs);
    network->refs++;
    virMutexUnlock(&network->conn->lock);
    return 0;
}

4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913
/**
 * 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)
{
4914 4915
    DEBUG("network=%p", network);

4916 4917
    virResetLastError();

4918
    if (!VIR_IS_NETWORK(network)) {
4919
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936
        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)
{
4937 4938
    DEBUG("network=%p, uuid=%p", network, uuid);

4939 4940
    virResetLastError();

4941
    if (!VIR_IS_NETWORK(network)) {
4942
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4943 4944 4945 4946
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
4947
        goto error;
4948 4949 4950 4951 4952
    }

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

    return (0);
4953 4954 4955 4956 4957

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973
}

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

4976 4977
    virResetLastError();

4978
    if (!VIR_IS_NETWORK(network)) {
4979
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4980 4981 4982 4983
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
4984
        goto error;
4985 4986 4987
    }

    if (virNetworkGetUUID(network, &uuid[0]))
4988
        return (-1);
4989

4990
    virUUIDFormat(uuid, buf);
4991
    return (0);
4992 4993 4994 4995 4996

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012
}

/**
 * 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)
{
5013
    virConnectPtr conn;
5014
    DEBUG("network=%p, flags=%d", network, flags);
5015

5016 5017 5018
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5019
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5020 5021 5022 5023
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5024
        goto error;
5025 5026
    }

5027 5028
    conn = network->conn;

5029 5030 5031 5032 5033 5034 5035
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5036

5037
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5038 5039 5040 5041

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5042
    return NULL;
5043
}
5044 5045 5046 5047 5048

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5049
 * Provides a bridge interface name to which a domain may connect
5050 5051 5052 5053 5054 5055 5056 5057
 * 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)
{
5058
    virConnectPtr conn;
5059
    DEBUG("network=%p", network);
5060

5061 5062 5063
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5064
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5065 5066 5067
        return (NULL);
    }

5068 5069
    conn = network->conn;

5070 5071 5072 5073 5074 5075 5076
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5077

5078
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5079 5080 5081 5082

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5083
    return NULL;
5084
}
5085 5086 5087 5088

/**
 * virNetworkGetAutostart:
 * @network: a network object
5089
 * @autostart: the value returned
5090
 *
5091
 * Provides a boolean value indicating whether the network
5092 5093 5094 5095 5096 5097 5098
 * 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,
5099 5100 5101
                       int *autostart)
{
    virConnectPtr conn;
5102
    DEBUG("network=%p, autostart=%p", network, autostart);
5103

5104 5105 5106
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5107
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5108 5109 5110 5111
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5112
        goto error;
5113 5114
    }

5115 5116
    conn = network->conn;

5117 5118 5119 5120 5121 5122 5123
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5124

5125
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5126 5127 5128 5129

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5130
    return -1;
5131 5132 5133 5134 5135
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
5136
 * @autostart: whether the network should be automatically started 0 or 1
5137 5138 5139 5140 5141 5142 5143 5144
 *
 * 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,
5145 5146 5147
                       int autostart)
{
    virConnectPtr conn;
5148
    DEBUG("network=%p, autostart=%d", network, autostart);
5149

5150 5151 5152
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5153
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5154 5155 5156
        return (-1);
    }

5157 5158
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5159
        goto error;
5160 5161
    }

5162 5163
    conn = network->conn;

5164 5165 5166 5167 5168 5169 5170
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5171

5172
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5173 5174 5175 5176

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5177
    return -1;
5178
}
5179

5180 5181 5182

/**
 * virStoragePoolGetConnect:
5183
 * @pool: pointer to a pool
5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199
 *
 * 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);

5200 5201 5202
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221
        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);

5222 5223
    virResetLastError();

5224 5225 5226 5227 5228
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

5229 5230 5231 5232 5233 5234 5235
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5236 5237

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5238 5239 5240 5241

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263
    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);

5264 5265
    virResetLastError();

5266 5267 5268 5269 5270 5271 5272
    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__);
5273
        goto error;
5274 5275
    }

5276 5277 5278 5279 5280 5281 5282
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5283 5284 5285

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5286 5287 5288 5289
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return -1;
5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305
}


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

5306 5307
    virResetLastError();

5308 5309 5310 5311 5312
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

5313 5314 5315 5316 5317 5318 5319
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5320 5321

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5322 5323 5324 5325

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348
    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);

5349 5350
    virResetLastError();

5351 5352 5353 5354 5355 5356 5357
    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__);
5358
        goto error;
5359 5360
    }

5361 5362 5363 5364 5365 5366 5367
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5368 5369

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5370 5371 5372 5373

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5374 5375 5376 5377
    return -1;
}


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
/**
 * 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)
{
5405 5406 5407 5408
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

5409 5410
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5411
        goto error;
5412 5413 5414
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5415
        goto error;
5416 5417
    }

5418 5419
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5420
        goto error;
5421 5422
    }

5423 5424 5425 5426 5427 5428 5429
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
5430 5431

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5432 5433 5434 5435

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5436 5437 5438 5439
    return NULL;
}


5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454
/**
 * 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);

5455 5456
    virResetLastError();

5457 5458 5459 5460 5461 5462
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5463
        goto error;
5464 5465
    }

5466 5467 5468 5469 5470 5471 5472
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
5473 5474

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5475 5476 5477 5478

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497
    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);

5498 5499
    virResetLastError();

5500 5501 5502 5503 5504 5505
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5506
        goto error;
5507 5508
    }

5509 5510 5511 5512 5513 5514 5515
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
5516 5517 5518

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5519 5520 5521 5522
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536
}


/**
 * 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,
5537
                                 const char *uuidstr)
5538 5539 5540 5541
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

5542 5543
    virResetLastError();

5544 5545 5546 5547 5548 5549
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5550
        goto error;
5551 5552 5553 5554
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5555
        goto error;
5556 5557 5558
    }

    return virStoragePoolLookupByUUID(conn, uuid);
5559 5560 5561 5562 5563

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579
}


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

5580 5581 5582
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
5583 5584 5585 5586
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

5587 5588 5589 5590 5591 5592 5593
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
5594 5595 5596

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

5597 5598 5599 5600
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
5601 5602 5603 5604 5605 5606
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
5607
 * @flags: future flags, use 0 for now
5608 5609
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
5610
 * pool is not persistent, so its definition will disappear
5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621
 * 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);

5622 5623
    virResetLastError();

5624 5625 5626 5627 5628 5629
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5630
        goto error;
5631 5632 5633
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5634
        goto error;
5635 5636
    }

5637 5638 5639 5640 5641 5642 5643
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
5644 5645

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5646 5647 5648 5649

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5650 5651 5652 5653 5654 5655 5656
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
5657
 * @flags: future flags, use 0 for now
5658 5659
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
5660
 * pool is persistent, until explicitly undefined.
5661 5662 5663 5664 5665 5666 5667 5668 5669 5670
 *
 * 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);

5671 5672
    virResetLastError();

5673 5674 5675 5676 5677 5678
    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__);
5679
        goto error;
5680 5681 5682
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5683
        goto error;
5684 5685
    }

5686 5687 5688 5689 5690 5691 5692
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
5693 5694 5695

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5696 5697 5698 5699
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5700 5701 5702 5703 5704
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
5705
 * @flags: future flags, use 0 for now
5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717
 *
 * 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);

5718 5719
    virResetLastError();

5720 5721 5722 5723 5724 5725 5726
    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__);
5727
        goto error;
5728 5729
    }

5730 5731 5732 5733 5734 5735 5736
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
5737 5738 5739

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5740 5741 5742 5743
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760
}


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

5761 5762
    virResetLastError();

5763 5764 5765 5766 5767 5768 5769
    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__);
5770
        goto error;
5771 5772
    }

5773 5774 5775 5776 5777 5778 5779
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
5780 5781 5782

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5783 5784 5785 5786
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5787 5788 5789 5790 5791 5792
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
5793
 * @flags: future flags, use 0 for now
5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805
 *
 * 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);

5806 5807
    virResetLastError();

5808 5809 5810 5811 5812 5813 5814
    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__);
5815
        goto error;
5816 5817
    }

5818 5819 5820 5821 5822 5823 5824
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
5825 5826 5827

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5828 5829 5830 5831
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852
}


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

5853 5854
    virResetLastError();

5855 5856 5857 5858 5859 5860 5861 5862
    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__);
5863
        goto error;
5864 5865
    }

5866 5867 5868 5869 5870 5871 5872
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
5873 5874

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5875 5876 5877 5878

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899
    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);

5900 5901
    virResetLastError();

5902 5903 5904 5905 5906 5907 5908 5909
    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__);
5910
        goto error;
5911 5912
    }

5913 5914 5915 5916 5917 5918 5919
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
5920 5921

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5922 5923 5924 5925

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943
    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);

5944 5945 5946
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
5947 5948 5949 5950 5951 5952 5953 5954 5955 5956
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985
/**
 * virStoragePoolRef:
 * @conn: the pool to hold a reference on
 *
 * Increment the reference count on the pool. For each
 * additional call to this method, there shall be a corresponding
 * call to virStoragePoolFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a pool would increment
 * the reference count.
 */
int
virStoragePoolRef(virStoragePoolPtr pool)
{
    if ((!VIR_IS_CONNECTED_STORAGE_POOL(pool))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&pool->conn->lock);
    DEBUG("pool=%p refs=%d", pool, pool->refs);
    pool->refs++;
    virMutexUnlock(&pool->conn->lock);
    return 0;
}

5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003
/**
 * 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);

6004 6005
    virResetLastError();

6006 6007 6008 6009 6010 6011 6012 6013
    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__);
6014
        goto error;
6015 6016
    }

6017 6018 6019 6020 6021 6022 6023
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6024 6025

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6026 6027 6028 6029

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046
    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);

6047 6048
    virResetLastError();

6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071
    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);

6072 6073
    virResetLastError();

6074 6075 6076 6077 6078 6079
    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__);
6080
        goto error;
6081 6082 6083 6084 6085 6086
    }

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

    return (0);

6087 6088 6089 6090
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108
}

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

6109 6110
    virResetLastError();

6111 6112 6113 6114 6115 6116
    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__);
6117
        goto error;
6118 6119 6120
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
6121
        goto error;
6122 6123 6124 6125

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

6126 6127 6128 6129
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149
}


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

6150 6151
    virResetLastError();

6152 6153 6154 6155 6156 6157
    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__);
6158
        goto error;
6159 6160 6161 6162 6163 6164
    }

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

    conn = pool->conn;

6165 6166 6167 6168 6169 6170 6171
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6172 6173 6174

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6175 6176 6177 6178
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6179 6180 6181 6182 6183 6184
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
6185
 * @flags: flags for XML format options (set of virDomainXMLFlags)
6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199
 *
 * 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);

6200 6201 6202
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6203 6204 6205 6206 6207
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
6208
        goto error;
6209 6210 6211 6212
    }

    conn = pool->conn;

6213 6214 6215 6216 6217 6218 6219
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
6220 6221 6222

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6223 6224 6225 6226
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return NULL;
6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246
}


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

6247 6248 6249
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6250 6251 6252 6253 6254
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
6255
        goto error;
6256 6257 6258 6259
    }

    conn = pool->conn;

6260 6261 6262 6263 6264 6265 6266
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6267 6268

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6269 6270 6271 6272

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292
    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);

6293 6294 6295
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6296
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
6297
        goto error;
6298 6299
    }

6300 6301
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6302
        goto error;
6303 6304
    }

6305 6306
    conn = pool->conn;

6307 6308 6309 6310 6311 6312 6313
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6314 6315

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6316 6317 6318 6319

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336
    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);

6337 6338
    virResetLastError();

6339 6340 6341 6342 6343
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

6344 6345 6346 6347 6348 6349 6350
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6351 6352

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6353 6354 6355 6356

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378
    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);

6379 6380
    virResetLastError();

6381 6382 6383 6384 6385 6386 6387
    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__);
6388
        goto error;
6389 6390
    }

6391 6392 6393 6394 6395 6396 6397
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolListVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolListVolumes (pool, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6398 6399

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6400 6401 6402 6403

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6404 6405 6406 6407 6408 6409
    return -1;
}


/**
 * virStorageVolGetConnect:
6410
 * @vol: pointer to a pool
6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426
 *
 * 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);

6427 6428
    virResetLastError();

6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452
    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);

6453 6454
    virResetLastError();

6455 6456 6457 6458 6459 6460
    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__);
6461
        goto error;
6462 6463
    }

6464 6465 6466 6467 6468 6469 6470
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
6471 6472

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6473 6474 6475 6476

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497
    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);

6498 6499
    virResetLastError();

6500 6501 6502 6503 6504 6505
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6506
        goto error;
6507 6508
    }

6509 6510 6511 6512 6513 6514 6515
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
6516 6517

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6518 6519 6520 6521

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540
    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);

6541 6542
    virResetLastError();

6543 6544 6545 6546 6547 6548
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6549
        goto error;
6550 6551
    }

6552 6553 6554 6555 6556 6557 6558
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
6559 6560

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6561 6562 6563 6564

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582
    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);

6583 6584
    virResetLastError();

6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597
    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
6598
 * unique, so the same volume will have the same
6599 6600 6601 6602 6603 6604 6605 6606 6607
 * 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);

6608 6609
    virResetLastError();

6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636
    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);

6637 6638
    virResetLastError();

6639 6640 6641 6642 6643 6644 6645
    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__);
6646
        goto error;
6647 6648
    }

6649 6650 6651 6652 6653 6654 6655
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6656 6657

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6658 6659 6660 6661

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6662 6663 6664 6665 6666 6667 6668
    return NULL;
}


/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
6669
 * @flags: future flags, use 0 for now
6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
 *
 * 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);

6682 6683
    virResetLastError();

6684 6685 6686 6687 6688 6689 6690 6691
    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__);
6692
        goto error;
6693 6694
    }

6695 6696 6697 6698 6699 6700 6701
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6702 6703

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6704 6705 6706 6707

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6708 6709 6710 6711 6712 6713 6714 6715 6716
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
6717
 * storage volume continues to exist.
6718 6719 6720 6721 6722 6723 6724 6725
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

6726 6727
    virResetLastError();

6728 6729 6730 6731 6732 6733 6734 6735 6736 6737
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766
/**
 * virStorageVolRef:
 * @conn: the vol to hold a reference on
 *
 * Increment the reference count on the vol. For each
 * additional call to this method, there shall be a corresponding
 * call to virStorageVolFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a vol would increment
 * the reference count.
 */
int
virStorageVolRef(virStorageVolPtr vol)
{
    if ((!VIR_IS_CONNECTED_STORAGE_VOL(vol))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&vol->conn->lock);
    DEBUG("vol=%p refs=%d", vol, vol->refs);
    vol->refs++;
    virMutexUnlock(&vol->conn->lock);
    return 0;
}

6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783
/**
 * 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);

6784 6785
    virResetLastError();

6786 6787 6788 6789 6790 6791
    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__);
6792
        goto error;
6793 6794 6795 6796 6797 6798
    }

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

    conn = vol->conn;

6799 6800 6801 6802 6803 6804 6805
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6806 6807

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6808 6809 6810 6811

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832
    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);

6833 6834
    virResetLastError();

6835 6836 6837 6838 6839 6840
    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__);
6841
        goto error;
6842 6843 6844 6845
    }

    conn = vol->conn;

6846 6847 6848 6849 6850 6851 6852
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
6853 6854 6855

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6856 6857 6858 6859
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880
}


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

6881 6882
    virResetLastError();

6883 6884 6885 6886 6887 6888 6889
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

6890 6891 6892 6893 6894 6895 6896
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
6897 6898

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6899 6900 6901 6902

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6903 6904
    return NULL;
}
6905 6906 6907



6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926

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

6927 6928
    virResetLastError();

6929 6930 6931 6932 6933 6934
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6935
        goto error;
6936 6937
    }

6938 6939 6940 6941 6942 6943 6944
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6945 6946

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6947 6948 6949 6950

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978
    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);

6979 6980
    virResetLastError();

6981 6982 6983 6984 6985 6986
    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__);
6987
        goto error;
6988 6989
    }

6990 6991 6992 6993 6994 6995 6996
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6997 6998

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6999 7000 7001 7002

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019
    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);

7020 7021
    virResetLastError();

7022 7023 7024 7025 7026 7027 7028
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7029
        goto error;
7030 7031
    }

7032 7033 7034 7035 7036 7037 7038
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7039 7040

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7041 7042 7043 7044

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062
    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);

7063 7064
    virResetLastError();

7065 7066 7067 7068 7069
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7070 7071 7072 7073 7074 7075 7076
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
7077 7078

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7079 7080 7081 7082

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7083 7084 7085 7086 7087 7088 7089 7090
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7091 7092 7093
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110
 */
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 已提交
7111 7112
 * Accessor for the parent of the device
 *
7113 7114 7115 7116 7117 7118 7119
 * 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);

7120 7121
    virResetLastError();

7122 7123 7124 7125 7126
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7127 7128 7129 7130 7131
    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__);
7132
            virSetConnError(dev->conn);
7133 7134 7135 7136
            return NULL;
        }
    }
    return dev->parent;
7137 7138 7139 7140 7141 7142
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7143 7144
 * Accessor for the number of capabilities supported by the device.
 *
7145 7146 7147 7148 7149 7150
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

7151 7152
    virResetLastError();

7153 7154 7155 7156 7157
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

7158 7159 7160 7161 7162 7163 7164
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
7165 7166

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7167 7168 7169 7170

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190
    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);

7191 7192
    virResetLastError();

7193 7194 7195 7196 7197
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

7198 7199 7200 7201 7202 7203 7204
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceListCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceListCaps (dev, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
7205 7206

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7207 7208 7209 7210

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227
    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);

7228 7229
    virResetLastError();

7230 7231 7232 7233 7234 7235 7236 7237 7238 7239
    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);
}


7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269
/**
 * virNodeDeviceRef:
 * @conn: the dev to hold a reference on
 *
 * Increment the reference count on the dev. For each
 * additional call to this method, there shall be a corresponding
 * call to virNodeDeviceFree to release the reference count, once
 * the caller no longer needs the reference to this object.
 *
 * This method is typically useful for applications where multiple
 * threads are using a connection, and it is required that the
 * connection remain open until all threads have finished using
 * it. ie, each new thread using a dev would increment
 * the reference count.
 */
int
virNodeDeviceRef(virNodeDevicePtr dev)
{
    if ((!VIR_IS_CONNECTED_NODE_DEVICE(dev))) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
    virMutexLock(&dev->conn->lock);
    DEBUG("dev=%p refs=%d", dev, dev->refs);
    dev->refs++;
    virMutexUnlock(&dev->conn->lock);
    return 0;
}


7270 7271 7272 7273 7274 7275 7276 7277 7278
/*
 * 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 已提交
7279
 * @freecb: optional function to deallocate opaque when not used anymore
7280 7281 7282 7283
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
7284 7285 7286 7287 7288 7289 7290
 * The virDomainPtr object handle passed into the callback upon delivery
 * of an event is only valid for the duration of execution of the callback.
 * If the callback wishes to keep the domain object after the callback
 * returns, it shall take a reference to it, by calling virDomainRef.
 * The reference can be released once the object is no longer required
 * by calling virDomainFree.
 *
7291 7292 7293 7294 7295
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
7296 7297
                              void *opaque,
                              virFreeCallback freecb)
7298
{
7299 7300
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
7301 7302 7303 7304 7305 7306 7307

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

7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322
    if ((conn->driver) && (conn->driver->domainEventRegister)) {
        int ret;
        ret = conn->driver->domainEventRegister (conn, cb, opaque, freecb);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340
    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)
{
7341 7342 7343
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
7344 7345 7346 7347 7348 7349 7350

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7351 7352 7353 7354 7355 7356 7357 7358
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
7359 7360
    }

7361 7362 7363 7364
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7365 7366
    return -1;
}