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 Red Hat, Inc.
D
Daniel Veillard 已提交
6 7 8 9 10 11
 *
 * See COPYING.LIB for the License of this software
 *
 * Daniel Veillard <veillard@redhat.com>
 */

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

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

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

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

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

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

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

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

65 66
#define MAX_DRIVERS 10

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

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
#if defined(POLKIT_AUTH)
static int virConnectAuthGainPolkit(const char *privilege) {
    const char *const args[] = {
        POLKIT_AUTH, "--obtain", privilege, NULL
    };
    int childpid, status, ret;

    /* Root has all rights */
    if (getuid() == 0)
        return 0;

    if ((childpid = fork()) < 0)
        return -1;

    if (!childpid) {
        execvp(args[0], (char **)args);
        _exit(-1);
    }

    while ((ret = waitpid(childpid, &status, 0) == -1) && errno == EINTR);
    if (ret == -1) {
        return -1;
    }

    if (!WIFEXITED(status) ||
        (WEXITSTATUS(status) != 0 && WEXITSTATUS(status) != 1)) {
        return -1;
    }

    return 0;
}
#endif

114 115 116 117 118 119 120 121
static int virConnectAuthCallbackDefault(virConnectCredentialPtr cred,
                                         unsigned int ncred,
                                         void *cbdata ATTRIBUTE_UNUSED) {
    int i;

    for (i = 0 ; i < ncred ; i++) {
        char buf[1024];
        char *bufptr = buf;
122
        size_t len;
123 124

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

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

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

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

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

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

        default:
            return -1;
177 178
        }

D
Daniel P. Berrange 已提交
179 180 181 182 183 184 185 186 187
        if (cred[i].type != VIR_CRED_EXTERNAL) {
            if (STREQ(bufptr, "") && cred[i].defresult)
                cred[i].result = strdup(cred[i].defresult);
            else
                cred[i].result = strdup(bufptr);
            if (!cred[i].result)
                return -1;
            cred[i].resultlen = strlen(cred[i].result);
        }
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    }

    return 0;
}

/* Don't typically want VIR_CRED_USERNAME. It enables you to authenticate
 * as one user, and act as another. It just results in annoying
 * prompts for the username twice & is very rarely what you want
 */
static int virConnectCredTypeDefault[] = {
    VIR_CRED_AUTHNAME,
    VIR_CRED_ECHOPROMPT,
    VIR_CRED_REALM,
    VIR_CRED_PASSPHRASE,
    VIR_CRED_NOECHOPROMPT,
203
    VIR_CRED_EXTERNAL,
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
};

static virConnectAuth virConnectAuthDefault = {
    virConnectCredTypeDefault,
    sizeof(virConnectCredTypeDefault)/sizeof(int),
    virConnectAuthCallbackDefault,
    NULL,
};

/*
 * virConnectAuthPtrDefault
 *
 * A default implementation of the authentication callbacks. This
 * implementation is suitable for command line based tools. It will
 * prompt for username, passwords, realm and one time keys as needed.
 * It will print on STDOUT, and read from STDIN. If this is not
 * suitable for the application's needs an alternative implementation
 * should be provided.
 */
virConnectAuthPtr virConnectAuthPtrDefault = &virConnectAuthDefault;

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

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

239 240 241 242 243 244 245 246 247 248 249 250
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
251 252 253
#ifdef ENABLE_DEBUG
    char *debugEnv;
#endif
254 255
    if (initialized)
        return(0);
256

257
    initialized = 1;
258

259 260
    if (virThreadInitialize() < 0 ||
        virErrorInitialize() < 0)
261 262
        return -1;

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

    DEBUG0("register drivers");

285 286 287 288
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

289 290 291
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

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

321 322 323
    return(0);
}

324 325 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 359 360
#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:
        fprintf(stderr, "Initializing DLL\n");
        virInitialize();
        break;

    case DLL_THREAD_ATTACH:
        fprintf(stderr, "Thread start\n");
        /* Nothing todo in libvirt yet */
        break;

    case DLL_THREAD_DETACH:
        fprintf(stderr, "Thread exit\n");
        /* Release per-thread local data */
        virThreadOnExit();
        break;

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

    return TRUE;
}
#endif
361 362


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

D
Daniel Veillard 已提交
376 377 378
    if (error == VIR_ERR_OK)
        return;

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

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

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

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

D
Daniel Veillard 已提交
420 421 422
    if (error == VIR_ERR_OK)
        return;

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

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

    if (error == VIR_ERR_OK)
        return;

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

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

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

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

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

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

505 506
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
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 533 534
/**
 * 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);
}

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

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

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

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

562 563
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
564 565
}

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

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

593 594 595 596
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

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

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

624 625 626 627
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

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

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

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

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

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

662 663
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
664 665
}

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

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

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

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

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

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

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

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

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

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

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

A
Atsushi SAKAI 已提交
770
#endif
771

772 773


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

795
    if (!initialized)
796
        if (virInitialize() < 0)
797
            return -1;
798

799
    if (libVer == NULL)
800
        return (-1);
801 802 803
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
804
        if (type == NULL)
805
            type = "Xen";
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 834 835
        *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) {
836
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
837 838 839 840
            return (-1);
        }
    }
    return (0);
841 842
}

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

851 852
    virResetLastError();

853 854 855
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
856

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

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

890 891 892 893 894 895 896 897 898
        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,
899 900 901 902
              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));
903 904
    } else {
        DEBUG0("no name, allowing driver auto-select");
905 906
    }

907 908 909
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

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

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

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

951 952 953

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

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

1001
    return ret;
1002 1003

failed:
1004
    if (ret->driver) ret->driver->close (ret);
1005

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

    virUnrefConnect(ret);

1011
    return NULL;
1012 1013
}

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

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

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

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

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

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

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

1102 1103 1104 1105
    virResetLastError();

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

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

1117
    if (virUnrefConnect(conn) < 0)
1118
        return (-1);
1119
    return (0);
D
Daniel Veillard 已提交
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 1149 1150
/**
 * 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 已提交
1151 1152
/*
 * Not for public use.  This function is part of the internal
1153 1154 1155
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1156
virDrvSupportsFeature (virConnectPtr conn, int feature)
1157
{
1158
    int ret;
1159 1160
    DEBUG("conn=%p, feature=%d", conn, feature);

1161 1162 1163 1164
    virResetLastError();

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

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

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

1191 1192
    virResetLastError();

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

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

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

1223 1224
    virResetLastError();

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

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

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

1242
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1243 1244 1245 1246

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

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

1267 1268
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1282 1283 1284 1285

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

1310 1311
    virResetLastError();

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

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

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

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

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

1356 1357
    virResetLastError();

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

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

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

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

1392 1393
    virResetLastError();

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

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

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

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

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

1431 1432
    virResetLastError();

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

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

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

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

1471 1472 1473
    virResetLastError();

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

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

1501 1502
    virResetLastError();

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

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

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

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

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

1567 1568
    virResetLastError();

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

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

1586
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1587 1588 1589 1590

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

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

1609 1610
    virResetLastError();

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

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

1628
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1629 1630 1631 1632

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

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

1653 1654
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1655 1656
    virResetLastError();

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

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

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

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

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

1709 1710
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1729 1730 1731 1732

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

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

1752 1753
    DEBUG("domain=%p", domain);

1754 1755
    virResetLastError();

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

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

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

1775
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1776 1777 1778 1779

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

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

1797 1798 1799
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1800
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1801
        return (-1);
D
Daniel Veillard 已提交
1802
    }
1803
    if (virUnrefDomain(domain) < 0)
1804
        return -1;
1805
    return(0);
D
Daniel Veillard 已提交
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 1836 1837
/**
 * 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 已提交
1838
/**
1839
 * virDomainSuspend:
D
Daniel Veillard 已提交
1840 1841 1842
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1843
 * to CPU resources and I/O but the memory used by the domain at the
1844
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1845
 * the domain.
1846
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1847 1848 1849 1850
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1851 1852
virDomainSuspend(virDomainPtr domain)
{
1853
    virConnectPtr conn;
1854
    DEBUG("domain=%p", domain);
1855

1856 1857
    virResetLastError();

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

1867 1868
    conn = domain->conn;

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

1877
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1878 1879 1880 1881

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

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

1901 1902
    virResetLastError();

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

1912 1913
    conn = domain->conn;

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

1922
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1923 1924 1925 1926

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

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

1949 1950
    virResetLastError();

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

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

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

    }

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

1993
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1994 1995 1996 1997

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

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

2016 2017
    virResetLastError();

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

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

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

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

2064
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2065 2066 2067 2068

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

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

2091 2092
    virResetLastError();

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

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

    }

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

2141
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2142 2143 2144 2145

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

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

2168 2169
    virResetLastError();

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

2179 2180
    conn = domain->conn;

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

2189
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2190 2191 2192 2193

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

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

2214 2215
    virResetLastError();

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

2225 2226
    conn = domain->conn;

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

2235
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2236 2237 2238 2239

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

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

2257 2258
    virResetLastError();

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

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

2280 2281
    virResetLastError();

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

2293 2294
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2295
    return (0);
2296 2297
}

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

2314 2315
    virResetLastError();

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

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

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

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

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

2350 2351
    virResetLastError();

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

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

2374 2375 2376
    virResetLastError();

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

2381 2382
    conn = domain->conn;

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

2391
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2392 2393 2394 2395

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

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

2415 2416
    virResetLastError();

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

2422 2423
    conn = domain->conn;

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

2432
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2433 2434 2435 2436

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

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

2458 2459
    virResetLastError();

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

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

2482
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2483 2484 2485 2486

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

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

2508 2509
    virResetLastError();

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

    conn = domain->conn;
2524

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

2533
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2534 2535 2536 2537

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

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

2558 2559
    virResetLastError();

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

2569
    memset(info, 0, sizeof(virDomainInfo));
2570

2571 2572
    conn = domain->conn;

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

2581
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2582 2583 2584 2585

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

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

2606 2607 2608
    virResetLastError();

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

2613 2614
    conn = domain->conn;

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

2623
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2624 2625 2626 2627

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2628
    return NULL;
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 2689 2690
/**
 * 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 已提交
2691 2692
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2693 2694 2695
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
          domain, dconn, flags, dname, uri, bandwidth);

2696 2697 2698
    virResetLastError();

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

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

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

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

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

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

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

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

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

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

2845 2846
    virResetLastError();

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

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

2857 2858 2859 2860 2861 2862 2863 2864 2865
    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;
    }
2866 2867

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2868 2869 2870 2871

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

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

2891 2892 2893
    virResetLastError();

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

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

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

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2915 2916 2917 2918

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

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

2936 2937
    virResetLastError();

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

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

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

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2959 2960 2961 2962

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


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

2984 2985
    virResetLastError();

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

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

2996 2997 2998 2999 3000 3001 3002 3003 3004 3005
    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 已提交
3006 3007

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3008 3009 3010 3011

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

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

3030 3031
    virResetLastError();

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

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

3042 3043 3044 3045 3046 3047 3048 3049 3050 3051
    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 已提交
3052 3053

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3054 3055 3056 3057

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


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

3076 3077
    virResetLastError();

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

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

3095
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3096 3097 3098 3099

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

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

3118 3119
    virResetLastError();

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

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

3133
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3134 3135 3136 3137

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

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

3154 3155
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3170 3171 3172 3173

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

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

3193 3194
    virResetLastError();

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

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

3208
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3209 3210 3211 3212

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

3238 3239
    virResetLastError();

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

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

3254
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3255 3256 3257 3258

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

3281 3282
    virResetLastError();

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

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

3301
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3302 3303 3304 3305

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


3310
/**
3311
 * virDomainBlockStats:
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 3339 3340
 * @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);

3341 3342
    virResetLastError();

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

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

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3362 3363 3364 3365

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

/**
3370
 * virDomainInterfaceStats:
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 3397 3398
 * @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);

3399 3400
    virResetLastError();

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

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

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3420 3421 3422 3423

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

R
Richard W.M. Jones 已提交
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 3458 3459
/**
 * 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 已提交
3460 3461 3462 3463
 * 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 已提交
3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477
 * 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);

3478 3479
    virResetLastError();

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

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

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

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

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

3510 3511 3512 3513 3514 3515 3516 3517
    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 已提交
3518 3519

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3520 3521 3522 3523

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

R
Richard W.M. Jones 已提交
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 3567 3568
/**
 * 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);

3569 3570
    virResetLastError();

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

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

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

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

3616 3617 3618 3619 3620 3621 3622 3623
    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 已提交
3624 3625

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3626 3627 3628 3629

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

3633

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

3655 3656
    virResetLastError();

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

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

3678
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3679 3680 3681 3682

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

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

3699 3700
    virResetLastError();

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

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

3719
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3720 3721 3722 3723

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

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

3740 3741
    virResetLastError();

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

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

3755
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3756 3757 3758 3759

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

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

3779 3780
    virResetLastError();

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

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

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

3799
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3800 3801 3802 3803

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

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

3821 3822
    virResetLastError();

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

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

3841
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3842 3843 3844 3845

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

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

3867 3868 3869
    virResetLastError();

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

3878 3879
    conn = domain->conn;

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

3888
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3889 3890 3891 3892

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

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

3913 3914 3915
    virResetLastError();

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

3920 3921
    conn = domain->conn;

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

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

3935
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3936 3937 3938 3939

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

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

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

3962 3963
    virResetLastError();

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

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

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

3987
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3988 3989 3990 3991

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

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

4020 4021
    virResetLastError();

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

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

4036 4037
    conn = domain->conn;

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

4046
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4047 4048 4049 4050

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

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

4082 4083
    virResetLastError();

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

4097 4098
    conn = domain->conn;

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

4108
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4109 4110 4111 4112

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

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

4134 4135
    virResetLastError();

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

    conn = domain->conn;

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

4151
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4152 4153 4154 4155

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


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

4175 4176
    virResetLastError();

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

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

4195
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4196 4197 4198 4199

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

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

4218 4219
    virResetLastError();

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

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

4238
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4239 4240 4241 4242

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

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

4271 4272
    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4292 4293 4294 4295

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

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

4318 4319 4320
    virResetLastError();

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

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

4340 4341
    virResetLastError();

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

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

4355
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4356 4357 4358 4359

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

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

4378 4379
    virResetLastError();

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

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

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

4398
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4399 4400 4401 4402

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

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

4419 4420
    virResetLastError();

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

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

4434
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4435 4436 4437 4438

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

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

4458 4459
    virResetLastError();

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

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

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

4479
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4480 4481 4482 4483

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

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

4502 4503
    virResetLastError();

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

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

4521
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4522 4523 4524 4525

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

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

4544 4545
    virResetLastError();

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

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

4563
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4564 4565 4566 4567

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

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

4589 4590
    virResetLastError();

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

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

    return virNetworkLookupByUUID(conn, &uuid[0]);
4622 4623 4624 4625 4626

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

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

4644 4645
    virResetLastError();

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

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

4667
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4668 4669 4670 4671

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

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

4689 4690
    virResetLastError();

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

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

4712
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4713 4714 4715 4716

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

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

4733 4734
    virResetLastError();

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

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

4753
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4754 4755 4756 4757

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

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

4776 4777
    virResetLastError();

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

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

4796
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4797 4798 4799 4800

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

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

4821 4822
    virResetLastError();

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

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

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

4842
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4843 4844 4845 4846

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

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

4864 4865 4866
    virResetLastError();

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

4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903
/**
 * 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;
}

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

4918 4919
    virResetLastError();

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

4941 4942
    virResetLastError();

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

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

    return (0);
4955 4956 4957 4958 4959

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

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

4978 4979
    virResetLastError();

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

    if (virNetworkGetUUID(network, &uuid[0]))
4990
        return (-1);
4991

4992
    virUUIDFormat(uuid, buf);
4993
    return (0);
4994 4995 4996 4997 4998

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

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

5018 5019 5020
    virResetLastError();

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

5029 5030
    conn = network->conn;

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

5039
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5040 5041 5042 5043

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

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

5063 5064 5065
    virResetLastError();

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

5070 5071
    conn = network->conn;

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

5080
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5081 5082 5083 5084

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

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

5106 5107 5108
    virResetLastError();

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

5117 5118
    conn = network->conn;

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

5127
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5128 5129 5130 5131

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

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

5152 5153 5154
    virResetLastError();

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

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

5164 5165
    conn = network->conn;

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

5174
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5175 5176 5177 5178

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

5182 5183 5184

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

5202 5203 5204
    virResetLastError();

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

5224 5225
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5240 5241 5242 5243

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

5266 5267
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

5308 5309
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5324 5325 5326 5327

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

5351 5352
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5372 5373 5374 5375

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


5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406
/**
 * 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)
{
5407 5408 5409 5410
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5434 5435 5436 5437

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


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

5457 5458
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5477 5478 5479 5480

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

5500 5501
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

5544 5545
    virResetLastError();

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

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

    return virStoragePoolLookupByUUID(conn, uuid);
5561 5562 5563 5564 5565

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


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

5582 5583 5584
    virResetLastError();

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

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

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

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

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

5624 5625
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5648 5649 5650 5651

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

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

5673 5674
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

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

5720 5721
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

5763 5764
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

5808 5809
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

5855 5856
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5877 5878 5879 5880

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

5902 5903
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5924 5925 5926 5927

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

5946 5947 5948
    virResetLastError();

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

}


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

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

6006 6007
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6028 6029 6030 6031

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

6049 6050
    virResetLastError();

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

6074 6075
    virResetLastError();

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

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

    return (0);

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

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

6111 6112
    virResetLastError();

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

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

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

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


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

6152 6153
    virResetLastError();

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

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

    conn = pool->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

6202 6203 6204
    virResetLastError();

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

    conn = pool->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

6249 6250 6251
    virResetLastError();

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

    conn = pool->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6271 6272 6273 6274

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

6295 6296 6297
    virResetLastError();

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

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

6307 6308
    conn = pool->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6318 6319 6320 6321

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

6339 6340
    virResetLastError();

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

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

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6355 6356 6357 6358

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

6381 6382
    virResetLastError();

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

6393 6394 6395 6396 6397 6398 6399
    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;
    }
6400 6401

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6402 6403 6404 6405

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


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

6429 6430
    virResetLastError();

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

6455 6456
    virResetLastError();

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

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

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6475 6476 6477 6478

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

6500 6501
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6520 6521 6522 6523

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

6543 6544
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6563 6564 6565 6566

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

6585 6586
    virResetLastError();

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

6610 6611
    virResetLastError();

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 6637 6638
    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);

6639 6640
    virResetLastError();

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

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

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6660 6661 6662 6663

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


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

6684 6685
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6706 6707 6708 6709

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
 * storage volume contains to exist
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

6728 6729
    virResetLastError();

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


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

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

6786 6787
    virResetLastError();

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

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

    conn = vol->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6810 6811 6812 6813

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

6835 6836
    virResetLastError();

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

    conn = vol->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

6883 6884
    virResetLastError();

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

    conn = vol->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6901 6902 6903 6904

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



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

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

6929 6930
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6949 6950 6951 6952

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
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 6979 6980
    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);

6981 6982
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7001 7002 7003 7004

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

7022 7023
    virResetLastError();

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

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7043 7044 7045 7046

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

7065 7066
    virResetLastError();

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

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

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7081 7082 7083 7084

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


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

7122 7123
    virResetLastError();

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

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

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

7153 7154
    virResetLastError();

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

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

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7169 7170 7171 7172

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

7193 7194
    virResetLastError();

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

7200 7201 7202 7203 7204 7205 7206
    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;
    }
7207 7208

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7209 7210 7211 7212

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

7230 7231
    virResetLastError();

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


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


7272 7273 7274 7275 7276 7277 7278 7279 7280
/*
 * 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 已提交
7281
 * @freecb: optional function to deallocate opaque when not used anymore
7282 7283 7284 7285
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
7286 7287 7288 7289 7290 7291 7292
 * 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.
 *
7293 7294 7295 7296 7297
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
7298 7299
                              void *opaque,
                              virFreeCallback freecb)
7300
{
7301 7302
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
7303 7304 7305 7306 7307 7308 7309

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

7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324
    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);
7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342
    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)
{
7343 7344 7345
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
7346 7347 7348 7349 7350 7351 7352

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

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

7370