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

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

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

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

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

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

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

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

63 64
#define VIR_FROM_THIS VIR_FROM_NONE

D
Daniel Veillard 已提交
65 66 67
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
D
Daniel Veillard 已提交
68
 * - use reference counting to guarantee coherent pointer state ?
D
Daniel Veillard 已提交
69 70
 */

71 72
#define MAX_DRIVERS 10

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

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
#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

120 121 122 123 124 125 126 127
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;
128
        size_t len;
129 130

        switch (cred[i].type) {
131 132 133 134
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

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

148 149 150 151
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
152 153 154 155 156
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

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

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
171 172 173 174 175
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

176 177 178 179
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
180 181 182

        default:
            return -1;
183 184
        }

D
Daniel P. Berrange 已提交
185 186 187 188 189 190 191 192 193
        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);
        }
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    }

    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,
209
    VIR_CRED_EXTERNAL,
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
};

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;

231 232 233 234 235 236 237 238 239 240
#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 已提交
241
    return err == 0 ? 0 : -1;
242 243 244
}
#endif

245 246 247 248 249 250 251 252 253 254 255 256
/**
 * 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)
{
257 258 259
#ifdef ENABLE_DEBUG
    char *debugEnv;
#endif
260 261
    if (initialized)
        return(0);
262

263
    initialized = 1;
264

265
    if (virThreadInitialize() < 0 ||
266 267
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
268 269
        return -1;

270 271
#ifdef ENABLE_DEBUG
    debugEnv = getenv("LIBVIRT_DEBUG");
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
    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);
288 289 290 291
#endif

    DEBUG0("register drivers");

292 293 294 295
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

296 297 298
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

299
    /*
300 301
     * Note that the order is important: the first ones have a higher
     * priority when calling virConnectOpen.
302
     */
303 304 305 306 307 308 309 310 311
#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");
312
    virDriverLoadModule("vbox");
313 314
    virDriverLoadModule("remote");
#else
315
#ifdef WITH_TEST
316
    if (testRegister() == -1) return -1;
317
#endif
318
#ifdef WITH_XEN
319
    if (xenRegister () == -1) return -1;
320
#endif
321 322
#ifdef WITH_OPENVZ
    if (openvzRegister() == -1) return -1;
D
Daniel Veillard 已提交
323
#endif
324 325 326
#ifdef WITH_VBOX
    if (vboxRegister() == -1) return -1;
#endif
327 328
#ifdef WITH_REMOTE
    if (remoteRegister () == -1) return -1;
329
#endif
330
#endif
D
Daniel P. Berrange 已提交
331

332 333 334
    return(0);
}

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 361 362 363 364 365 366 367
#ifdef WIN32
BOOL WINAPI
DllMain (HINSTANCE instance, DWORD reason, LPVOID ignore);

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

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

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

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

    return TRUE;
}
#endif
368 369


D
Daniel Veillard 已提交
370 371 372
/**
 * virLibConnError:
 * @conn: the connection if available
373
 * @error: the error number
D
Daniel Veillard 已提交
374 375 376 377 378
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
379 380
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
381
    const char *errmsg;
382

D
Daniel Veillard 已提交
383 384 385
    if (error == VIR_ERR_OK)
        return;

386 387 388
    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 已提交
389 390 391
}

/**
392
 * virLibConnWarning:
D
Daniel Veillard 已提交
393
 * @conn: the connection if available
394 395 396 397 398 399 400 401 402 403 404 405 406
 * @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;

407 408 409
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
410 411 412 413 414 415
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
416 417 418 419 420
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
421 422 423
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
424 425
    virConnectPtr conn = NULL;
    const char *errmsg;
426

D
Daniel Veillard 已提交
427 428 429
    if (error == VIR_ERR_OK)
        return;

430
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
431 432 433
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
434 435
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
436 437
}

438
/**
439 440
 * virLibNetworkError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
441
 * @error: the error number
442
 * @info: extra information string
443
 *
444
 * Handle an error at the connection level
445
 */
446 447 448 449 450 451 452 453 454 455
static void
virLibNetworkError(virNetworkPtr network, virErrorNumber error,
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

456
    errmsg = virErrorMsg(error, info);
457 458 459
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
460 461
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
462 463
}

464 465 466
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
467
 * @error: the error number
468 469 470 471 472 473 474 475 476 477 478 479 480 481
 * @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;

482
    errmsg = virErrorMsg(error, info);
483 484 485
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

486 487
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
488 489 490 491 492
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
493
 * @error: the error number
494 495 496 497 498 499 500 501 502 503 504 505 506 507
 * @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;

508
    errmsg = virErrorMsg(error, info);
509 510 511
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

512 513
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
514 515
}

516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
/**
 * 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);
}

542 543 544 545 546 547 548 549 550 551 552
/**
 * 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)
{
553 554 555 556 557
    if (virInitialize() < 0)
      return -1;

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

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
562 563
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
564 565
    }

566 567 568
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

569 570
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
571 572
}

573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
/**
 * 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) {
593
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
594 595 596
        return(-1);
    }

597 598 599
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

600 601 602 603
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
/**
 * 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);
    }

628 629 630
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

631 632 633 634
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

635 636 637 638 639 640 641 642 643 644 645
/**
 * 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)
{
646 647 648 649 650
    if (virInitialize() < 0)
      return -1;

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

    if (virDriverTabCount >= MAX_DRIVERS) {
655 656
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
657 658
    }

659
    if (driver->no < 0) {
660
        virLibConnError
661 662 663 664 665
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

666 667 668
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

669 670
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
671 672
}

A
Atsushi SAKAI 已提交
673
#ifdef WITH_LIBVIRTD
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
/**
 * 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) {
694
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
695 696 697 698 699 700 701
        return(-1);
    }

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

702 703 704 705 706 707 708
/**
 * virStateInitialize:
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
709
int virStateInitialize(void) {
710 711 712 713 714 715
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
716 717
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
718 719 720 721 722
            ret = -1;
    }
    return ret;
}

723 724 725 726 727 728 729
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
730
int virStateCleanup(void) {
731 732 733
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
734 735
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
736 737 738 739 740
            ret = -1;
    }
    return ret;
}

741 742 743 744 745 746 747
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
748
int virStateReload(void) {
749 750 751
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
752 753
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
754 755 756 757 758
            ret = -1;
    }
    return ret;
}

759 760 761 762 763 764 765
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
 * Return 0 if none are active, 1 if at least one is.
 */
D
Daniel P. Berrange 已提交
766
int virStateActive(void) {
767 768 769
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
770 771
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
772 773 774 775 776
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
777
#endif
778

779 780


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

802
    if (!initialized)
803
        if (virInitialize() < 0)
804
            return -1;
805

806
    if (libVer == NULL)
807
        return (-1);
808 809 810
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
811
        if (type == NULL)
812
            type = "Xen";
813 814 815 816 817

/* FIXME: Add _proper_ type version handling for loadable driver modules... */
#ifdef WITH_DRIVER_MODULES
        *typeVer = LIBVIR_VERSION_NUMBER;
#else
818
        *typeVer = 0;
819

820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
#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
840 841 842 843
#if WITH_VBOX
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
844 845 846 847 848 849 850 851 852
#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) {
853
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
854 855
            return (-1);
        }
856
#endif /* WITH_DRIVER_MODULES */
857 858
    }
    return (0);
859 860
}

861
static virConnectPtr
862 863 864
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
865
{
866
    int i, res;
867 868
    virConnectPtr ret;

869 870
    virResetLastError();

871 872 873
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
874

875 876 877 878 879 880 881 882
    /*
     *  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) {
883
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
884 885
            name = defname;
        } else {
886
            name = NULL;
887
        }
888
    }
889

890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
    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;
        }
907

908 909 910 911 912 913 914 915 916
        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,
917 918 919 920
              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));
921 922
    } else {
        DEBUG0("no name, allowing driver auto-select");
923 924
    }

925 926 927
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

928
    for (i = 0; i < virDriverTabCount; i++) {
929 930
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
931
        res = virDriverTab[i]->open (ret, auth, flags);
932 933 934 935 936
        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")));
937 938 939 940 941
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
942 943
    }

944
    if (!ret->driver) {
945 946
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
947
        goto failed;
948 949
    }

950
    for (i = 0; i < virNetworkDriverTabCount; i++) {
951
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
952 953 954 955 956
        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")));
957
        if (res == VIR_DRV_OPEN_ERROR) {
958
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
959
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
960 961
                                   "Is the daemon running ?");
            }
962 963
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
964 965 966
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
967
    }
968

969 970 971

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
972
        res = virStorageDriverTab[i]->open (ret, auth, flags);
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
#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;
        }
    }

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    /* 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;
1006 1007
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1019
    return ret;
1020 1021

failed:
1022
    if (ret->driver) ret->driver->close (ret);
1023

1024 1025
    /* Ensure a global error is set in case driver forgot */
    virSetGlobalError();
1026 1027 1028

    virUnrefConnect(ret);

1029
    return NULL;
1030 1031
}

1032 1033
/**
 * virConnectOpen:
1034
 * @name: URI of the hypervisor
1035
 *
1036
 * This function should be called first to get a connection to the
1037 1038 1039
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1040 1041
 *
 * URIs are documented at http://libvirt.org/uri.html
1042 1043 1044 1045
 */
virConnectPtr
virConnectOpen (const char *name)
{
1046 1047 1048 1049
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1050
    DEBUG("name=%s", name);
1051
    return do_open (name, NULL, 0);
1052 1053
}

1054
/**
1055
 * virConnectOpenReadOnly:
1056
 * @name: URI of the hypervisor
1057
 *
1058
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1059
 * library functionalities. The set of APIs usable are then restricted
1060
 * on the available methods to control the domains.
1061 1062
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1063 1064
 *
 * URIs are documented at http://libvirt.org/uri.html
1065
 */
1066
virConnectPtr
1067 1068
virConnectOpenReadOnly(const char *name)
{
1069 1070 1071 1072
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1073
    DEBUG("name=%s", name);
1074 1075 1076 1077 1078 1079 1080 1081 1082
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1083
 * This function should be called first to get a connection to the
1084
 * Hypervisor. If necessary, authentication will be performed fetching
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
 * 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)
{
1096 1097 1098 1099
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1100
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1101
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1102 1103 1104
}

/**
1105
 * virConnectClose:
D
Daniel Veillard 已提交
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
 * @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
1116 1117
virConnectClose(virConnectPtr conn)
{
1118 1119
    DEBUG("conn=%p", conn);

1120 1121 1122 1123
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1124
        return (-1);
1125
    }
1126 1127 1128

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
1129 1130
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1131 1132
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1133
    conn->driver->close (conn);
1134

1135
    if (virUnrefConnect(conn) < 0)
1136
        return (-1);
1137
    return (0);
D
Daniel Veillard 已提交
1138 1139
}

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
/**
 * 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 已提交
1169 1170
/*
 * Not for public use.  This function is part of the internal
1171 1172 1173
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1174
virDrvSupportsFeature (virConnectPtr conn, int feature)
1175
{
1176
    int ret;
1177 1178
    DEBUG("conn=%p, feature=%d", conn, feature);

1179 1180 1181 1182
    virResetLastError();

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

1186 1187 1188 1189
    ret = VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return ret;
1190 1191
}

1192 1193 1194 1195 1196 1197 1198
/**
 * 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.
1199 1200 1201
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1202 1203
 */
const char *
1204 1205
virConnectGetType(virConnectPtr conn)
{
1206
    const char *ret;
1207
    DEBUG("conn=%p", conn);
1208

1209 1210
    virResetLastError();

D
Daniel Veillard 已提交
1211
    if (!VIR_IS_CONNECT(conn)) {
1212
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1213
        return (NULL);
D
Daniel Veillard 已提交
1214
    }
1215 1216 1217 1218

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1219
    }
1220
    return conn->driver->name;
1221 1222
}

D
Daniel Veillard 已提交
1223
/**
1224
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1225
 * @conn: pointer to the hypervisor connection
1226
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1227
 *
1228
 * Get the version level of the Hypervisor running. This may work only with
1229
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1230
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1231
 *
1232 1233 1234
 * 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 已提交
1235
 */
1236
int
1237 1238
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1239 1240
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

1241 1242
    virResetLastError();

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

D
Daniel Veillard 已提交
1248 1249
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1250
        goto error;
D
Daniel Veillard 已提交
1251
    }
1252

1253 1254 1255 1256 1257 1258
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1259

1260
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1261 1262 1263 1264

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1265
    return -1;
1266 1267
}

1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
/**
 * 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)
{
1283 1284
    DEBUG("conn=%p", conn);

1285 1286
    virResetLastError();

1287
    if (!VIR_IS_CONNECT(conn)) {
1288
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1289 1290 1291
        return NULL;
    }

1292 1293 1294 1295 1296 1297
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1298 1299

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1300 1301 1302 1303

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
    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)
{
1325
    char *name;
1326 1327
    DEBUG("conn=%p", conn);

1328 1329
    virResetLastError();

1330
    if (!VIR_IS_CONNECT(conn)) {
1331
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1332 1333 1334
        return NULL;
    }

1335
    name = (char *)xmlSaveUri(conn->uri);
1336
    if (!name) {
1337
        virReportOOMError (conn);
1338
        goto error;
1339 1340
    }
    return name;
1341 1342 1343 1344 1345

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

1348 1349 1350 1351 1352
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1353
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1354 1355 1356 1357 1358 1359 1360 1361 1362
 * 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)
{
1363 1364
    DEBUG("conn=%p, type=%s", conn, type);

1365 1366
    virResetLastError();

1367
    if (!VIR_IS_CONNECT(conn)) {
1368
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1369
        return -1;
1370 1371
    }

1372 1373 1374 1375 1376 1377
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1378

1379
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1380 1381 1382
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1383
    return -1;
1384 1385
}

1386
/**
1387
 * virConnectListDomains:
1388 1389 1390 1391 1392 1393 1394 1395 1396
 * @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
1397 1398
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1399 1400
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1401 1402
    virResetLastError();

D
Daniel Veillard 已提交
1403
    if (!VIR_IS_CONNECT(conn)) {
1404
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1405
        return -1;
D
Daniel Veillard 已提交
1406
    }
1407

1408
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1409
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1410
        goto error;
D
Daniel Veillard 已提交
1411
    }
1412

1413 1414 1415 1416 1417 1418
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1419

1420
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1421 1422 1423
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1424
    return -1;
D
Daniel Veillard 已提交
1425 1426
}

K
 
Karel Zak 已提交
1427 1428 1429 1430
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1431 1432
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1433 1434 1435
 * Returns the number of domain found or -1 in case of error
 */
int
1436 1437
virConnectNumOfDomains(virConnectPtr conn)
{
1438 1439
    DEBUG("conn=%p", conn);

1440 1441
    virResetLastError();

D
Daniel Veillard 已提交
1442
    if (!VIR_IS_CONNECT(conn)) {
1443
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1444
        goto error;
D
Daniel Veillard 已提交
1445
    }
K
Karel Zak 已提交
1446

1447 1448 1449 1450 1451 1452
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1453

1454
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1455 1456 1457
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1458
    return -1;
K
 
Karel Zak 已提交
1459 1460
}

1461 1462 1463 1464
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1465
 * Provides the connection pointer associated with a domain.  The
1466 1467 1468
 * reference counter on the connection is not increased by this
 * call.
 *
1469 1470 1471 1472
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1473 1474 1475 1476 1477
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1478 1479
    DEBUG("dom=%p", dom);

1480 1481 1482
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1483
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1484 1485 1486 1487 1488
        return NULL;
    }
    return dom->conn;
}

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

1510 1511
    virResetLastError();

D
Daniel Veillard 已提交
1512
    if (!VIR_IS_CONNECT(conn)) {
1513
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1514
        return (NULL);
D
Daniel Veillard 已提交
1515 1516 1517
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1518
        goto error;
D
Daniel Veillard 已提交
1519
    }
1520 1521
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1522
        goto error;
1523
    }
D
Daniel Veillard 已提交
1524

1525 1526 1527 1528 1529 1530 1531
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1532 1533

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1534 1535 1536
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1537
    return NULL;
D
Daniel Veillard 已提交
1538 1539
}

1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
/**
 * 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));
}
1558

1559
/**
1560
 * virDomainLookupByID:
1561 1562 1563 1564
 * @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 已提交
1565 1566
 * 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.
1567
 *
1568 1569
 * 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.
1570
 */
1571
virDomainPtr
1572 1573
virDomainLookupByID(virConnectPtr conn, int id)
{
1574 1575
    DEBUG("conn=%p, id=%d", conn, id);

1576 1577
    virResetLastError();

D
Daniel Veillard 已提交
1578
    if (!VIR_IS_CONNECT(conn)) {
1579
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1580
        return (NULL);
D
Daniel Veillard 已提交
1581 1582 1583
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1584
        goto error;
D
Daniel Veillard 已提交
1585
    }
1586

1587 1588 1589 1590 1591 1592 1593
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1594

1595
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1596 1597 1598 1599

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1600
    return NULL;
1601 1602 1603 1604 1605
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1606
 * @uuid: the raw UUID for the domain
1607 1608 1609
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1610 1611
 * 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.
1612 1613
 */
virDomainPtr
1614 1615
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1616 1617
    DEBUG("conn=%p, uuid=%s", conn, uuid);

1618 1619
    virResetLastError();

D
Daniel Veillard 已提交
1620
    if (!VIR_IS_CONNECT(conn)) {
1621
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1622
        return (NULL);
D
Daniel Veillard 已提交
1623 1624 1625
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1626
        goto error;
D
Daniel Veillard 已提交
1627
    }
1628

1629 1630 1631 1632 1633 1634 1635
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1636

1637
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1638 1639 1640 1641

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1642
    return NULL;
1643 1644
}

K
Karel Zak 已提交
1645 1646 1647 1648 1649 1650 1651
/**
 * 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.
 *
1652 1653
 * 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 已提交
1654 1655 1656 1657
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1658 1659
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1660 1661
    int ret;

1662 1663
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1664 1665
    virResetLastError();

K
Karel Zak 已提交
1666
    if (!VIR_IS_CONNECT(conn)) {
1667
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1668 1669 1670 1671
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1672
        goto error;
K
Karel Zak 已提交
1673
    }
1674 1675
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
     */
    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);
1687

1688
    if (ret!=VIR_UUID_BUFLEN) {
1689
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1690
        goto error;
K
Karel Zak 已提交
1691
    }
1692
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1693
        uuid[i] = raw[i] & 0xFF;
1694

K
Karel Zak 已提交
1695
    return virDomainLookupByUUID(conn, &uuid[0]);
1696 1697 1698 1699 1700

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

1703 1704 1705 1706 1707
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1708
 * Try to lookup a domain on the given hypervisor based on its name.
1709
 *
1710 1711
 * 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.
1712 1713
 */
virDomainPtr
1714 1715
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1716 1717
    DEBUG("conn=%p, name=%s", conn, name);

1718 1719
    virResetLastError();

D
Daniel Veillard 已提交
1720
    if (!VIR_IS_CONNECT(conn)) {
1721
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1722
        return (NULL);
D
Daniel Veillard 已提交
1723 1724 1725
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1726
        goto error;
D
Daniel Veillard 已提交
1727
    }
1728

1729 1730 1731 1732 1733 1734 1735
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
1736 1737

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1738 1739 1740 1741

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1742
    return NULL;
1743 1744
}

D
Daniel Veillard 已提交
1745
/**
1746
 * virDomainDestroy:
D
Daniel Veillard 已提交
1747 1748 1749
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1750 1751 1752
 * 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 已提交
1753 1754
 *
 * Returns 0 in case of success and -1 in case of failure.
1755
 */
D
Daniel Veillard 已提交
1756
int
1757 1758
virDomainDestroy(virDomainPtr domain)
{
1759
    virConnectPtr conn;
1760

1761 1762
    DEBUG("domain=%p", domain);

1763 1764
    virResetLastError();

D
Daniel Veillard 已提交
1765
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1766
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1767
        return (-1);
D
Daniel Veillard 已提交
1768
    }
1769

1770
    conn = domain->conn;
1771 1772
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1773
        goto error;
1774
    }
1775

1776 1777 1778 1779 1780 1781 1782
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1783

1784
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1785 1786 1787 1788

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1789
    return -1;
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
}

/**
 * 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
1802 1803
virDomainFree(virDomainPtr domain)
{
1804 1805
    DEBUG("domain=%p", domain);

1806 1807 1808
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1809
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1810
        return (-1);
D
Daniel Veillard 已提交
1811
    }
1812
    if (virUnrefDomain(domain) < 0)
1813
        return -1;
1814
    return(0);
D
Daniel Veillard 已提交
1815 1816
}

1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
/**
 * 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 已提交
1847
/**
1848
 * virDomainSuspend:
D
Daniel Veillard 已提交
1849 1850 1851
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1852
 * to CPU resources and I/O but the memory used by the domain at the
1853
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1854
 * the domain.
1855
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1856 1857 1858 1859
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1860 1861
virDomainSuspend(virDomainPtr domain)
{
1862
    virConnectPtr conn;
1863
    DEBUG("domain=%p", domain);
1864

1865 1866
    virResetLastError();

D
Daniel Veillard 已提交
1867
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1868
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1869
        return (-1);
D
Daniel Veillard 已提交
1870
    }
1871 1872
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1873
        goto error;
1874
    }
D
Daniel Veillard 已提交
1875

1876 1877
    conn = domain->conn;

1878 1879 1880 1881 1882 1883 1884
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1885

1886
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1887 1888 1889 1890

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

/**
1895
 * virDomainResume:
D
Daniel Veillard 已提交
1896 1897 1898
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1899
 * it was frozen by calling virSuspendDomain().
1900
 * This function may requires privileged access
D
Daniel Veillard 已提交
1901 1902 1903 1904
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1905 1906
virDomainResume(virDomainPtr domain)
{
1907
    virConnectPtr conn;
1908
    DEBUG("domain=%p", domain);
1909

1910 1911
    virResetLastError();

D
Daniel Veillard 已提交
1912
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1913
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1914
        return (-1);
D
Daniel Veillard 已提交
1915
    }
1916 1917
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1918
        goto error;
1919
    }
D
Daniel Veillard 已提交
1920

1921 1922
    conn = domain->conn;

1923 1924 1925 1926 1927 1928 1929
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1930

1931
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1932 1933 1934 1935

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

1939 1940 1941 1942 1943 1944
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
1945 1946 1947
 * 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.
1948 1949 1950 1951
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1952 1953
virDomainSave(virDomainPtr domain, const char *to)
{
1954
    char filepath[4096];
1955
    virConnectPtr conn;
1956
    DEBUG("domain=%p, to=%s", domain, to);
1957

1958 1959
    virResetLastError();

D
Daniel Veillard 已提交
1960
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1961
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1962
        return (-1);
D
Daniel Veillard 已提交
1963
    }
1964 1965
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1966
        goto error;
1967
    }
1968
    conn = domain->conn;
D
Daniel Veillard 已提交
1969 1970
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
1971
        goto error;
D
Daniel Veillard 已提交
1972
    }
1973

1974 1975 1976 1977 1978
    /*
     * 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] != '/') {
1979
        unsigned int len, t;
1980

1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
        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];
1991 1992 1993

    }

1994 1995 1996 1997 1998 1999 2000
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2001

2002
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2003 2004 2005 2006

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2007
    return -1;
2008 2009 2010 2011
}

/**
 * virDomainRestore:
2012
 * @conn: pointer to the hypervisor connection
2013
 * @from: path to the
2014 2015 2016 2017 2018 2019
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2020 2021
virDomainRestore(virConnectPtr conn, const char *from)
{
2022
    char filepath[4096];
2023
    DEBUG("conn=%p, from=%s", conn, from);
2024

2025 2026
    virResetLastError();

D
Daniel Veillard 已提交
2027
    if (!VIR_IS_CONNECT(conn)) {
2028
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2029
        return (-1);
D
Daniel Veillard 已提交
2030
    }
2031 2032
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2033
        goto error;
2034
    }
D
Daniel Veillard 已提交
2035 2036
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2037
        goto error;
D
Daniel Veillard 已提交
2038 2039
    }

2040 2041 2042 2043 2044
    /*
     * 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] != '/') {
2045 2046 2047
        unsigned int len, t;

        t = strlen(from);
2048 2049 2050 2051 2052
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2053 2054
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2055 2056 2057 2058 2059
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2060 2061 2062 2063 2064
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2065 2066 2067 2068 2069 2070 2071
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2072

2073
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2074 2075 2076 2077

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
2078
    return -1;
D
Daniel Veillard 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097
}

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

2100 2101
    virResetLastError();

D
Daniel Veillard 已提交
2102
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2103
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
2104 2105 2106 2107
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2108
        goto error;
D
Daniel Veillard 已提交
2109 2110 2111 2112
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2113
        goto error;
D
Daniel Veillard 已提交
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
    }

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

    }

2142 2143 2144 2145 2146 2147 2148
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2149

2150
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2151 2152 2153 2154

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2155
    return -1;
2156 2157
}

2158 2159 2160 2161 2162
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2163 2164
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2165 2166 2167 2168 2169 2170 2171
 *
 * 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
2172 2173
virDomainShutdown(virDomainPtr domain)
{
2174
    virConnectPtr conn;
2175
    DEBUG("domain=%p", domain);
2176

2177 2178
    virResetLastError();

D
Daniel Veillard 已提交
2179
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2180
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2181
        return (-1);
D
Daniel Veillard 已提交
2182
    }
2183 2184
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2185
        goto error;
2186
    }
2187

2188 2189
    conn = domain->conn;

2190 2191 2192 2193 2194 2195 2196
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2197

2198
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2199 2200 2201 2202

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2203
    return -1;
2204 2205
}

2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219
/**
 * 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)
{
2220
    virConnectPtr conn;
2221
    DEBUG("domain=%p, flags=%u", domain, flags);
2222

2223 2224
    virResetLastError();

2225
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2226
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2227 2228
        return (-1);
    }
2229 2230
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2231
        goto error;
2232
    }
2233

2234 2235
    conn = domain->conn;

2236 2237 2238 2239 2240 2241 2242
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2243

2244
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2245 2246 2247 2248

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2249
    return -1;
2250 2251
}

2252
/**
2253
 * virDomainGetName:
2254 2255 2256 2257 2258 2259 2260 2261
 * @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 *
2262 2263
virDomainGetName(virDomainPtr domain)
{
2264 2265
    DEBUG("domain=%p", domain);

2266 2267
    virResetLastError();

D
Daniel Veillard 已提交
2268
    if (!VIR_IS_DOMAIN(domain)) {
2269
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2270
        return (NULL);
D
Daniel Veillard 已提交
2271
    }
2272
    return (domain->name);
2273 2274
}

2275 2276 2277
/**
 * virDomainGetUUID:
 * @domain: a domain object
2278
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2279 2280 2281 2282 2283 2284
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2285 2286
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2287 2288
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2289 2290
    virResetLastError();

D
Daniel Veillard 已提交
2291
    if (!VIR_IS_DOMAIN(domain)) {
2292
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2293
        return (-1);
D
Daniel Veillard 已提交
2294 2295 2296
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2297 2298
        /* Copy to connection error object for back compatability */
        virSetConnError(domain->conn);
2299
        return (-1);
D
Daniel Veillard 已提交
2300 2301
    }

2302 2303
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2304
    return (0);
2305 2306
}

K
Karel Zak 已提交
2307 2308 2309
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2310
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2311
 *
2312
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2313 2314 2315 2316 2317 2318 2319
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2320
    unsigned char uuid[VIR_UUID_BUFLEN];
2321
    DEBUG("domain=%p, buf=%p", domain, buf);
2322

2323 2324
    virResetLastError();

K
Karel Zak 已提交
2325
    if (!VIR_IS_DOMAIN(domain)) {
2326
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
2327 2328 2329 2330
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2331
        goto error;
K
Karel Zak 已提交
2332
    }
2333

K
Karel Zak 已提交
2334
    if (virDomainGetUUID(domain, &uuid[0]))
2335
        goto error;
K
Karel Zak 已提交
2336

2337
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2338
    return (0);
2339 2340 2341 2342 2343

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

2346
/**
2347
 * virDomainGetID:
2348 2349 2350 2351 2352 2353 2354
 * @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
2355 2356
virDomainGetID(virDomainPtr domain)
{
2357 2358
    DEBUG("domain=%p", domain);

2359 2360
    virResetLastError();

D
Daniel Veillard 已提交
2361
    if (!VIR_IS_DOMAIN(domain)) {
2362
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2363
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2364
    }
2365
    return (domain->id);
2366 2367
}

2368 2369 2370 2371 2372 2373
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2374 2375
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2376 2377
 */
char *
2378 2379
virDomainGetOSType(virDomainPtr domain)
{
2380
    virConnectPtr conn;
2381
    DEBUG("domain=%p", domain);
2382

2383 2384 2385
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2386
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2387
        return (NULL);
D
Daniel Veillard 已提交
2388
    }
2389

2390 2391
    conn = domain->conn;

2392 2393 2394 2395 2396 2397 2398
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2399

2400
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2401 2402 2403 2404

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

2408
/**
2409
 * virDomainGetMaxMemory:
2410
 * @domain: a domain object or NULL
2411
 *
2412 2413 2414 2415 2416 2417 2418
 * 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
2419 2420
virDomainGetMaxMemory(virDomainPtr domain)
{
2421
    virConnectPtr conn;
2422
    DEBUG("domain=%p", domain);
2423

2424 2425
    virResetLastError();

D
Daniel Veillard 已提交
2426
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2427
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2428
        return (0);
D
Daniel Veillard 已提交
2429
    }
2430

2431 2432
    conn = domain->conn;

2433 2434 2435 2436 2437 2438 2439
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2440

2441
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2442 2443 2444 2445

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2446
    return 0;
2447 2448
}

D
Daniel Veillard 已提交
2449
/**
2450
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2451 2452
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2453
 *
D
Daniel Veillard 已提交
2454 2455 2456
 * 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.
2457
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2458 2459 2460 2461
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2462 2463
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2464
    virConnectPtr conn;
2465
    DEBUG("domain=%p, memory=%lu", domain, memory);
2466

2467 2468
    virResetLastError();

2469
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2470
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2471
        return (-1);
2472
    }
2473 2474
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2475
        goto error;
2476 2477 2478
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2479
        goto error;
2480
    }
2481
    conn = domain->conn;
2482

2483 2484 2485 2486 2487 2488 2489
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2490

2491
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2492 2493 2494 2495

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2496
    return -1;
2497
}
2498

2499 2500 2501 2502
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2503
 *
2504 2505 2506
 * 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.
2507
 * This function may requires privileged access to the hypervisor.
2508 2509 2510 2511 2512 2513 2514
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2515
    DEBUG("domain=%p, memory=%lu", domain, memory);
2516

2517 2518
    virResetLastError();

2519
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2520
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2521
        return (-1);
2522
    }
2523 2524
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2525
        goto error;
2526 2527 2528
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2529
        goto error;
2530 2531 2532
    }

    conn = domain->conn;
2533

2534 2535 2536 2537 2538 2539 2540
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2541

2542
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2543 2544 2545 2546

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

2550 2551
/**
 * virDomainGetInfo:
2552
 * @domain: a domain object
2553
 * @info: pointer to a virDomainInfo structure allocated by the user
2554
 *
2555
 * Extract information about a domain. Note that if the connection
2556
 * used to get the domain is limited only a partial set of the information
2557 2558 2559 2560 2561
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2562 2563
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2564
    virConnectPtr conn;
2565
    DEBUG("domain=%p, info=%p", domain, info);
2566

2567 2568
    virResetLastError();

D
Daniel Veillard 已提交
2569
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2570
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2571
        return (-1);
D
Daniel Veillard 已提交
2572 2573 2574
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2575
        goto error;
D
Daniel Veillard 已提交
2576
    }
2577

2578
    memset(info, 0, sizeof(virDomainInfo));
2579

2580 2581
    conn = domain->conn;

2582 2583 2584 2585 2586 2587 2588
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2589

2590
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2591 2592 2593 2594

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2595
    return -1;
2596
}
2597

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

2615 2616 2617
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2618
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2619
        return (NULL);
D
Daniel Veillard 已提交
2620
    }
2621

2622 2623
    conn = domain->conn;

2624 2625 2626 2627 2628 2629
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

2630 2631 2632 2633 2634 2635 2636
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
2637

2638
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2639 2640 2641 2642

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2643
    return NULL;
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 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
/**
 * 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 已提交
2706 2707
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2708
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
2709
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
2710

2711 2712 2713
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2714
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2715 2716 2717 2718 2719
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
2720
        goto error;
2721 2722
    }

2723 2724
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2725
        goto error;
2726 2727 2728 2729
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, delibrately report error against source object, not dest here */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2730
        goto error;
2731 2732
    }

2733
    /* Check that migration is supported by both drivers. */
D
Daniel Veillard 已提交
2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744
    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 {
2745
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2746
        goto error;
2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759
    }

    /* 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 已提交
2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772
    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);
2773
    }
D
Daniel Veillard 已提交
2774 2775 2776 2777 2778 2779 2780
    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__);
2781
            goto error;
D
Daniel Veillard 已提交
2782 2783 2784
        }
        dom_xml = conn->driver->domainDumpXML (domain,
                                               VIR_DOMAIN_XML_SECURE);
2785

D
Daniel Veillard 已提交
2786
        if (!dom_xml)
2787
            goto error;
D
Daniel Veillard 已提交
2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802

        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);
    }
2803 2804 2805 2806 2807 2808 2809

    /* 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 已提交
2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831
    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);
    }
2832 2833

 done:
2834 2835
    free (uri_out);
    free (cookie);
2836
    return ddomain;
2837 2838 2839 2840 2841

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

D
Daniel Veillard 已提交
2844 2845
/*
 * Not for public use.  This function is part of the internal
2846 2847 2848
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2849
virDomainMigratePrepare (virConnectPtr dconn,
2850 2851 2852 2853 2854 2855 2856 2857
                           char **cookie,
                           int *cookielen,
                           const char *uri_in,
                           char **uri_out,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
J
John Levon 已提交
2858 2859 2860
    VIR_DEBUG("dconn=%p, cookie=%p, cookielen=%p, uri_in=%s, uri_out=%p, "
              "flags=%lu, dname=%s, bandwidth=%lu", dconn, cookie, cookielen,
              NULLSTR(uri_in), uri_out, flags, NULLSTR(dname), bandwidth);
2861

2862 2863
    virResetLastError();

2864
    if (!VIR_IS_CONNECT (dconn)) {
2865
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2866 2867 2868
        return -1;
    }

2869 2870
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2871
        goto error;
2872 2873
    }

2874 2875 2876 2877 2878 2879 2880 2881 2882
    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;
    }
2883 2884

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2885 2886 2887 2888

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
2889 2890 2891
    return -1;
}

D
Daniel Veillard 已提交
2892 2893
/*
 * Not for public use.  This function is part of the internal
2894 2895 2896
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2897
virDomainMigratePerform (virDomainPtr domain,
2898 2899 2900 2901 2902 2903 2904 2905
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
J
John Levon 已提交
2906 2907 2908
    VIR_DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, "
              "dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags,
              NULLSTR(dname), bandwidth);
2909

2910 2911 2912
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2913
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2914 2915 2916 2917
        return -1;
    }
    conn = domain->conn;

2918 2919
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2920
        goto error;
2921 2922
    }

2923 2924 2925 2926 2927 2928 2929 2930 2931
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
2932 2933

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2934 2935 2936 2937

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2938 2939 2940
    return -1;
}

D
Daniel Veillard 已提交
2941 2942
/*
 * Not for public use.  This function is part of the internal
2943 2944 2945
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
2946
virDomainMigrateFinish (virConnectPtr dconn,
2947 2948 2949 2950 2951 2952
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
2953 2954 2955
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
2956

2957 2958
    virResetLastError();

2959
    if (!VIR_IS_CONNECT (dconn)) {
2960
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2961 2962 2963
        return NULL;
    }

2964 2965
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2966
        goto error;
2967 2968
    }

2969 2970 2971 2972 2973 2974 2975 2976 2977
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
2978 2979

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2980 2981 2982 2983

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
2984
    return NULL;
D
Daniel Veillard 已提交
2985 2986 2987
}


D
Daniel Veillard 已提交
2988 2989
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2990 2991 2992
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2993 2994 2995 2996 2997 2998 2999 3000 3001
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 已提交
3002
{
J
John Levon 已提交
3003 3004 3005 3006
    VIR_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, NULLSTR(dname),
              bandwidth, dom_xml);
D
Daniel Veillard 已提交
3007

3008 3009
    virResetLastError();

D
Daniel Veillard 已提交
3010 3011 3012 3013 3014
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

3015 3016
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3017
        goto error;
3018 3019
    }

3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
    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 已提交
3030 3031

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3032 3033 3034 3035

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

D
Daniel Veillard 已提交
3039 3040
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3041 3042 3043
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3044 3045 3046 3047 3048 3049 3050
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3051
{
J
John Levon 已提交
3052 3053 3054
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu, retcode=%d", dconn, NULLSTR(dname), cookie,
              cookielen, uri, flags, retcode);
D
Daniel Veillard 已提交
3055

3056 3057
    virResetLastError();

D
Daniel Veillard 已提交
3058 3059 3060 3061 3062
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3063 3064
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3065
        goto error;
3066 3067
    }

3068 3069 3070 3071 3072 3073 3074 3075 3076 3077
    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 已提交
3078 3079

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3080 3081 3082 3083

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3084
    return NULL;
3085 3086 3087
}


3088 3089 3090 3091
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3092
 *
3093 3094 3095 3096 3097
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3098 3099
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3100 3101
    DEBUG("conn=%p, info=%p", conn, info);

3102 3103
    virResetLastError();

3104
    if (!VIR_IS_CONNECT(conn)) {
3105
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3106 3107 3108 3109
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3110
        goto error;
3111 3112
    }

3113 3114 3115 3116 3117 3118 3119
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3120

3121
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3122 3123 3124 3125

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3126
    return -1;
3127
}
3128

3129 3130 3131 3132 3133 3134
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
3135 3136
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
3137 3138 3139 3140 3141
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
3142 3143
    DEBUG("conn=%p", conn);

3144 3145
    virResetLastError();

3146
    if (!VIR_IS_CONNECT (conn)) {
3147
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3148 3149 3150
        return NULL;
    }

3151 3152 3153 3154 3155 3156 3157
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3158

3159
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3160 3161 3162 3163

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3164 3165 3166
    return NULL;
}

3167 3168 3169
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
3170
 *
D
Daniel Veillard 已提交
3171
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
3172 3173
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
3174
 *
D
Daniel Veillard 已提交
3175
 * Returns the available free memory in bytes or 0 in case of error
3176 3177 3178 3179
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
3180 3181
    DEBUG("conn=%p", conn);

3182 3183
    virResetLastError();

3184 3185 3186 3187 3188
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3189 3190 3191 3192 3193 3194 3195
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3196 3197

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3198 3199 3200 3201

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3202 3203 3204
    return 0;
}

3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218
/**
 * 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;
3219
    DEBUG("domain=%p, nparams=%p", domain, nparams);
3220

3221 3222
    virResetLastError();

3223
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3224
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3225 3226 3227 3228 3229 3230
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3231 3232
        if (!schedtype)
            goto error;
3233 3234 3235
        return schedtype;
    }

3236
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3237 3238 3239 3240

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
    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,
3261
                                virSchedParameterPtr params, int *nparams)
3262 3263
{
    virConnectPtr conn;
3264
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
3265

3266 3267
    virResetLastError();

3268
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3269
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3270 3271 3272 3273
        return -1;
    }
    conn = domain->conn;

3274 3275 3276 3277 3278 3279 3280
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3281

3282
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3283 3284 3285 3286

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302
    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
3303
virDomainSetSchedulerParameters(virDomainPtr domain,
3304
                                virSchedParameterPtr params, int nparams)
3305 3306
{
    virConnectPtr conn;
3307
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
3308

3309 3310
    virResetLastError();

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

3321 3322 3323 3324 3325 3326 3327
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3328

3329
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3330 3331 3332 3333

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3334 3335 3336 3337
    return -1;
}


3338
/**
3339
 * virDomainBlockStats:
3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368
 * @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);

3369 3370
    virResetLastError();

3371
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3372
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3373 3374
        return -1;
    }
3375 3376 3377 3378
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3379 3380 3381 3382
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3383
            goto error;
3384 3385 3386 3387 3388 3389

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3390 3391 3392 3393

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3394 3395 3396 3397
    return -1;
}

/**
3398
 * virDomainInterfaceStats:
3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
 * @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);

3427 3428
    virResetLastError();

3429
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3430
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3431 3432
        return -1;
    }
3433 3434 3435 3436
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3437 3438 3439 3440
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3441
            goto error;
3442 3443 3444 3445 3446 3447

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3448 3449 3450 3451

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3452 3453 3454
    return -1;
}

R
Richard W.M. Jones 已提交
3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487
/**
 * 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 已提交
3488 3489 3490 3491
 * 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 已提交
3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505
 * 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);

3506 3507
    virResetLastError();

R
Richard W.M. Jones 已提交
3508 3509 3510 3511 3512
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3513

3514 3515
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3516
        goto error;
3517 3518
    }

R
Richard W.M. Jones 已提交
3519 3520 3521
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
3522
        goto error;
R
Richard W.M. Jones 已提交
3523 3524 3525 3526 3527
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
3528
        goto error;
R
Richard W.M. Jones 已提交
3529 3530 3531 3532 3533 3534
    }

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

3538 3539 3540 3541 3542 3543 3544 3545
    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 已提交
3546 3547

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3548 3549 3550 3551

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

R
Richard W.M. Jones 已提交
3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596
/**
 * 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);

3597 3598
    virResetLastError();

R
Richard W.M. Jones 已提交
3599 3600 3601 3602 3603 3604
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3605 3606
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3607
        goto error;
3608 3609
    }

R
Richard W.M. Jones 已提交
3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
    /* 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"));
3634
        goto error;
R
Richard W.M. Jones 已提交
3635 3636 3637 3638 3639 3640
    }

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

3644 3645 3646 3647 3648 3649 3650 3651
    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 已提交
3652 3653

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3654 3655 3656 3657

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

3661

3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672
/************************************************************************
 *									*
 *		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
 *
3673 3674
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
3675 3676
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
3677 3678 3679 3680 3681
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3682 3683
    DEBUG("conn=%p, xml=%s", conn, xml);

3684 3685
    virResetLastError();

3686
    if (!VIR_IS_CONNECT(conn)) {
3687
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3688 3689
        return (NULL);
    }
3690 3691
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3692
        goto error;
3693
    }
3694 3695
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3696
        goto error;
3697 3698
    }

3699 3700 3701 3702 3703 3704 3705
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3706

3707
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3708 3709 3710 3711

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3712
    return NULL;
3713 3714 3715 3716 3717 3718
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3719
 * Undefine a domain but does not stop it if it is running
3720 3721 3722 3723 3724
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3725
    virConnectPtr conn;
3726
    DEBUG("domain=%p", domain);
3727

3728 3729
    virResetLastError();

3730
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3731
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3732 3733
        return (-1);
    }
3734 3735
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3736
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3737
        goto error;
3738 3739
    }

3740 3741 3742 3743 3744 3745 3746
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3747

3748
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3749 3750 3751 3752

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3753
    return -1;
3754 3755 3756 3757 3758 3759
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3760
 * Provides the number of defined but inactive domains.
3761 3762 3763 3764 3765 3766
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3767 3768
    DEBUG("conn=%p", conn);

3769 3770
    virResetLastError();

3771
    if (!VIR_IS_CONNECT(conn)) {
3772
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3773 3774 3775
        return (-1);
    }

3776 3777 3778 3779 3780 3781 3782
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
3783

3784
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3785 3786 3787 3788

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3789
    return -1;
3790 3791 3792 3793 3794 3795 3796 3797
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
3798 3799
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
3800
 *
3801 3802 3803
 * Returns the number of names provided in the array or -1 in case of error
 */
int
3804
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
3805
                             int maxnames) {
3806 3807
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

3808 3809
    virResetLastError();

3810
    if (!VIR_IS_CONNECT(conn)) {
3811
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3812 3813 3814
        return (-1);
    }

3815
    if ((names == NULL) || (maxnames < 0)) {
3816
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3817
        goto error;
3818 3819
    }

3820 3821 3822 3823 3824 3825 3826
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
3827

3828
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3829 3830 3831 3832

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3833
    return -1;
3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
}

/**
 * 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) {
3847
    virConnectPtr conn;
3848
    DEBUG("domain=%p", domain);
3849

3850 3851
    virResetLastError();

3852
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3853
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3854 3855
        return (-1);
    }
3856 3857
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3858
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3859
        goto error;
3860
    }
3861

3862 3863 3864 3865 3866 3867 3868
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3869

3870
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3871 3872 3873 3874

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3875
    return -1;
3876 3877
}

3878 3879 3880
/**
 * virDomainGetAutostart:
 * @domain: a domain object
3881
 * @autostart: the value returned
3882
 *
3883
 * Provides a boolean value indicating whether the domain
3884 3885 3886 3887 3888 3889 3890
 * 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,
3891 3892 3893
                      int *autostart)
{
    virConnectPtr conn;
3894
    DEBUG("domain=%p, autostart=%p", domain, autostart);
3895

3896 3897 3898
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3899
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3900 3901 3902 3903
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
3904
        goto error;
3905 3906
    }

3907 3908
    conn = domain->conn;

3909 3910 3911 3912 3913 3914 3915
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
3916

3917
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3918 3919 3920 3921

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3922
    return -1;
3923 3924 3925 3926 3927
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
3928
 * @autostart: whether the domain should be automatically started 0 or 1
3929 3930 3931 3932 3933 3934 3935 3936
 *
 * 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,
3937 3938 3939
                      int autostart)
{
    virConnectPtr conn;
3940
    DEBUG("domain=%p, autostart=%d", domain, autostart);
3941

3942 3943 3944
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3945
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3946 3947 3948
        return (-1);
    }

3949 3950
    conn = domain->conn;

3951 3952
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3953
        goto error;
3954 3955
    }

3956 3957 3958 3959 3960 3961 3962
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
3963

3964
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3965 3966 3967 3968

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3969
    return -1;
3970 3971
}

3972 3973 3974 3975 3976 3977 3978 3979
/**
 * 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.
3980
 * This function requires privileged access to the hypervisor.
3981 3982 3983 3984 3985 3986 3987
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3988
    virConnectPtr conn;
3989
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3990

3991 3992
    virResetLastError();

3993
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3994
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3995 3996
        return (-1);
    }
3997 3998
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3999
        goto error;
4000
    }
4001

4002 4003
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4004
        goto error;
4005
    }
4006
    conn = domain->conn;
4007

4008 4009 4010 4011 4012 4013 4014
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4015

4016
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4017 4018 4019 4020

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4021
    return -1;
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035
}

/**
 * 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.
4036
 *
4037
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
4038
 * This function requires privileged access to the hypervisor.
4039 4040 4041 4042 4043 4044 4045
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
4046
    virConnectPtr conn;
4047
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
4048

4049 4050
    virResetLastError();

4051
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4052
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4053 4054
        return (-1);
    }
4055 4056
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4057
        goto error;
4058
    }
4059

4060
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4061
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4062
       goto error;
4063
    }
4064

4065 4066
    conn = domain->conn;

4067 4068 4069 4070 4071 4072 4073
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4074

4075
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4076 4077 4078 4079

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4080
    return -1;
4081 4082 4083 4084 4085 4086 4087 4088 4089
}

/**
 * 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 已提交
4090
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
4091 4092 4093 4094 4095 4096 4097
 *	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...).
4098
 *
4099
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
4100
 * and also in cpumaps if this pointer isn't NULL.
4101 4102 4103 4104 4105
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
4106
                  unsigned char *cpumaps, int maplen)
4107
{
4108
    virConnectPtr conn;
4109
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
4110

4111 4112
    virResetLastError();

4113
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4114
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4115 4116 4117 4118
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4119
        goto error;
4120 4121 4122
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4123
        goto error;
4124
    }
4125

4126 4127
    conn = domain->conn;

4128 4129 4130 4131 4132 4133 4134 4135
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4136

4137
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4138 4139 4140 4141

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4142
    return -1;
4143
}
4144

4145 4146 4147
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
4148
 *
4149 4150 4151 4152 4153
 * 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.
4154 4155 4156 4157
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
4158 4159
virDomainGetMaxVcpus(virDomainPtr domain)
{
4160
    virConnectPtr conn;
4161
    DEBUG("domain=%p", domain);
4162

4163 4164
    virResetLastError();

4165
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4166
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4167 4168 4169 4170 4171
        return (-1);
    }

    conn = domain->conn;

4172 4173 4174 4175 4176 4177 4178
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4179

4180
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4181 4182 4183 4184

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4185
    return -1;
4186 4187
}

4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
 * Extract security label of an active domain.
 *
 * Returns 0 in case of success, -1 in case of failure, and -2
 * if the operation is not supported (caller decides if that's
 * an error).
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

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

    if (seclabel == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return -1;
    }

    conn = domain->conn;

    if (conn->driver->domainGetSecurityLabel)
        return conn->driver->domainGetSecurityLabel(domain, seclabel);

    virLibConnWarning(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4220
    return -1;
4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
 * Extract the security model of a hypervisor.
 *
 * Returns 0 in case of success, -1 in case of failure, and -2 if the
 * operation is not supported (caller decides if that's an error).
 */
int
virNodeGetSecurityModel(virConnectPtr conn, virSecurityModelPtr secmodel)
{
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

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

    if (conn->driver->nodeGetSecurityModel)
        return conn->driver->nodeGetSecurityModel(conn, secmodel);

    virLibConnWarning(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4250
    return -1;
4251
}
4252

4253 4254 4255 4256
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4257
 *
4258 4259 4260 4261 4262
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4263
virDomainAttachDevice(virDomainPtr domain, const char *xml)
4264 4265
{
    virConnectPtr conn;
4266
    DEBUG("domain=%p, xml=%s", domain, xml);
4267

4268 4269
    virResetLastError();

4270
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4271
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4272 4273 4274 4275
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4276
        goto error;
4277 4278 4279
    }
    conn = domain->conn;

4280 4281 4282 4283 4284 4285 4286
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4287

4288
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4289 4290 4291 4292

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4293
    return -1;
4294 4295 4296 4297 4298 4299
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4300
 *
4301 4302 4303 4304 4305
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4306
virDomainDetachDevice(virDomainPtr domain, const char *xml)
4307 4308
{
    virConnectPtr conn;
4309
    DEBUG("domain=%p, xml=%s", domain, xml);
4310

4311 4312
    virResetLastError();

4313
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4314
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4315 4316 4317 4318
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4319
        goto error;
4320 4321 4322
    }
    conn = domain->conn;

4323 4324 4325 4326 4327 4328 4329
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4330

4331
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4332 4333 4334 4335

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4336
    return -1;
4337
}
4338

4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360
/**
 * 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)
{
4361 4362 4363
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

4364 4365
    virResetLastError();

4366 4367 4368 4369 4370
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4371
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4372
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4373
        goto error;
4374 4375
    }

4376 4377 4378 4379 4380 4381 4382
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4383 4384

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4385 4386 4387 4388

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4389 4390 4391
    return -1;
}

4392 4393 4394 4395
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
4396
 * Provides the connection pointer associated with a network.  The
4397 4398 4399
 * reference counter on the connection is not increased by this
 * call.
 *
4400 4401 4402 4403
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
4404 4405 4406 4407 4408
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
4409 4410
    DEBUG("net=%p", net);

4411 4412 4413
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4414
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4415 4416 4417 4418 4419
        return NULL;
    }
    return net->conn;
}

4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430
/**
 * 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)
{
4431 4432
    DEBUG("conn=%p", conn);

4433 4434
    virResetLastError();

4435
    if (!VIR_IS_CONNECT(conn)) {
4436
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4437 4438 4439
        return (-1);
    }

4440 4441 4442 4443 4444 4445 4446
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4447

4448
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4449 4450 4451 4452

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4453
    return -1;
4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466
}

/**
 * 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
4467
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4468
{
4469 4470
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4471 4472
    virResetLastError();

4473
    if (!VIR_IS_CONNECT(conn)) {
4474
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4475 4476 4477
        return (-1);
    }

4478
    if ((names == NULL) || (maxnames < 0)) {
4479
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4480
        goto error;
4481 4482
    }

4483 4484 4485 4486 4487 4488 4489
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4490

4491
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4492 4493 4494 4495

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4496
    return -1;
4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509
}

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

4512 4513
    virResetLastError();

4514
    if (!VIR_IS_CONNECT(conn)) {
4515
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4516 4517 4518
        return (-1);
    }

4519 4520 4521 4522 4523 4524 4525
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4526

4527
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4528 4529 4530 4531

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4532
    return -1;
4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545
}

/**
 * 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
4546
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4547 4548
                              int maxnames)
{
4549 4550
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4551 4552
    virResetLastError();

4553
    if (!VIR_IS_CONNECT(conn)) {
4554
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4555 4556 4557
        return (-1);
    }

4558
    if ((names == NULL) || (maxnames < 0)) {
4559
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4560
        goto error;
4561 4562
    }

4563 4564 4565 4566 4567 4568 4569 4570
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4571

4572
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4573 4574 4575 4576

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4577
    return -1;
4578 4579 4580 4581 4582 4583 4584 4585 4586
}

/**
 * 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.
 *
4587 4588
 * 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.
4589 4590 4591 4592
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
4593 4594
    DEBUG("conn=%p, name=%s", conn, name);

4595 4596
    virResetLastError();

4597
    if (!VIR_IS_CONNECT(conn)) {
4598
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4599 4600 4601 4602
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4603
        goto  error;
4604 4605
    }

4606 4607 4608 4609 4610 4611 4612
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
4613

4614
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4615 4616 4617 4618

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4619
    return NULL;
4620 4621 4622 4623 4624 4625 4626 4627 4628
}

/**
 * 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.
 *
4629 4630
 * 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.
4631 4632 4633 4634
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
4635 4636
    DEBUG("conn=%p, uuid=%s", conn, uuid);

4637 4638
    virResetLastError();

4639
    if (!VIR_IS_CONNECT(conn)) {
4640
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4641 4642 4643 4644
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4645
        goto error;
4646 4647
    }

4648 4649 4650 4651 4652 4653 4654
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4655

4656
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4657 4658 4659 4660

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4661
    return NULL;
4662 4663 4664 4665 4666 4667 4668 4669 4670
}

/**
 * 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.
 *
4671 4672
 * 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.
4673 4674 4675 4676 4677 4678 4679
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
4680
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
4681

4682 4683
    virResetLastError();

4684
    if (!VIR_IS_CONNECT(conn)) {
4685
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4686 4687 4688 4689
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4690
        goto error;
4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707
    }

    /* 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) {
4708
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4709
        goto error;
4710 4711 4712 4713 4714
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

    return virNetworkLookupByUUID(conn, &uuid[0]);
4715 4716 4717 4718 4719

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

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

4737 4738
    virResetLastError();

4739
    if (!VIR_IS_CONNECT(conn)) {
4740
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4741 4742 4743 4744
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4745
        goto error;
4746 4747 4748
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4749
        goto error;
4750 4751
    }

4752 4753 4754 4755 4756 4757 4758
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
4759

4760
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4761 4762 4763 4764

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4765
    return NULL;
4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777
}

/**
 * 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
4778 4779
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
4780 4781
    DEBUG("conn=%p, xml=%s", conn, xml);

4782 4783
    virResetLastError();

4784
    if (!VIR_IS_CONNECT(conn)) {
4785
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4786 4787 4788 4789
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4790
        goto error;
4791 4792 4793
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4794
        goto error;
4795 4796
    }

4797 4798 4799 4800 4801 4802 4803
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4804

4805
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4806 4807 4808 4809

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4810
    return NULL;
4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823
}

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

4826 4827
    virResetLastError();

4828
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4829
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4830 4831 4832 4833 4834
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4835
        goto error;
4836 4837
    }

4838 4839 4840 4841 4842 4843 4844
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4845

4846
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4847 4848 4849 4850

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

/**
 * 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
4864 4865
virNetworkCreate(virNetworkPtr network)
{
4866
    virConnectPtr conn;
4867 4868
    DEBUG("network=%p", network);

4869 4870
    virResetLastError();

4871
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4872
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4873 4874 4875 4876 4877
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4878
        goto error;
4879 4880
    }

4881 4882 4883 4884 4885 4886 4887
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4888

4889
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4890 4891 4892 4893

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4894
    return -1;
4895 4896 4897 4898 4899 4900 4901
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
4902 4903 4904
 * 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
4905 4906 4907 4908 4909 4910 4911
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
4912
    DEBUG("network=%p", network);
4913

4914 4915
    virResetLastError();

4916
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4917
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4918 4919 4920 4921 4922 4923
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4924
        goto error;
4925 4926
    }

4927 4928 4929 4930 4931 4932 4933
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4934

4935
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4936 4937 4938 4939

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4940
    return -1;
4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954
}

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

4957 4958 4959
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4960
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4961 4962
        return (-1);
    }
4963
    if (virUnrefNetwork(network) < 0)
4964 4965 4966 4967
        return (-1);
    return(0);
}

4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996
/**
 * 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;
}

4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008
/**
 * 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)
{
5009 5010
    DEBUG("network=%p", network);

5011 5012
    virResetLastError();

5013
    if (!VIR_IS_NETWORK(network)) {
5014
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031
        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)
{
5032 5033
    DEBUG("network=%p, uuid=%p", network, uuid);

5034 5035
    virResetLastError();

5036
    if (!VIR_IS_NETWORK(network)) {
5037
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5038 5039 5040 5041
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5042
        goto error;
5043 5044 5045 5046 5047
    }

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

    return (0);
5048 5049 5050 5051 5052

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068
}

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

5071 5072
    virResetLastError();

5073
    if (!VIR_IS_NETWORK(network)) {
5074
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5075 5076 5077 5078
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5079
        goto error;
5080 5081 5082
    }

    if (virNetworkGetUUID(network, &uuid[0]))
5083
        return (-1);
5084

5085
    virUUIDFormat(uuid, buf);
5086
    return (0);
5087 5088 5089 5090 5091

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107
}

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

5111 5112 5113
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5114
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5115 5116 5117 5118
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5119
        goto error;
5120 5121
    }

5122 5123
    conn = network->conn;

5124 5125 5126 5127 5128 5129 5130
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5131

5132
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5133 5134 5135 5136

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5137
    return NULL;
5138
}
5139 5140 5141 5142 5143

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5144
 * Provides a bridge interface name to which a domain may connect
5145 5146 5147 5148 5149 5150 5151 5152
 * 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)
{
5153
    virConnectPtr conn;
5154
    DEBUG("network=%p", network);
5155

5156 5157 5158
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5159
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5160 5161 5162
        return (NULL);
    }

5163 5164
    conn = network->conn;

5165 5166 5167 5168 5169 5170 5171
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5172

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

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

/**
 * virNetworkGetAutostart:
 * @network: a network object
5184
 * @autostart: the value returned
5185
 *
5186
 * Provides a boolean value indicating whether the network
5187 5188 5189 5190 5191 5192 5193
 * 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,
5194 5195 5196
                       int *autostart)
{
    virConnectPtr conn;
5197
    DEBUG("network=%p, autostart=%p", network, autostart);
5198

5199 5200 5201
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5202
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5203 5204 5205 5206
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5207
        goto error;
5208 5209
    }

5210 5211
    conn = network->conn;

5212 5213 5214 5215 5216 5217 5218
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5219

5220
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5221 5222 5223 5224

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5225
    return -1;
5226 5227 5228 5229 5230
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
5231
 * @autostart: whether the network should be automatically started 0 or 1
5232 5233 5234 5235 5236 5237 5238 5239
 *
 * 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,
5240 5241 5242
                       int autostart)
{
    virConnectPtr conn;
5243
    DEBUG("network=%p, autostart=%d", network, autostart);
5244

5245 5246 5247
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5248
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5249 5250 5251
        return (-1);
    }

5252 5253
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5254
        goto error;
5255 5256
    }

5257 5258
    conn = network->conn;

5259 5260 5261 5262 5263 5264 5265
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5266

5267
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5268 5269 5270 5271

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5272
    return -1;
5273
}
5274

5275 5276 5277

/**
 * virStoragePoolGetConnect:
5278
 * @pool: pointer to a pool
5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294
 *
 * 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);

5295 5296 5297
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316
        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);

5317 5318
    virResetLastError();

5319 5320 5321 5322 5323
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

5324 5325 5326 5327 5328 5329 5330
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5331 5332

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5333 5334 5335 5336

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358
    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);

5359 5360
    virResetLastError();

5361 5362 5363 5364 5365 5366 5367
    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__);
5368
        goto error;
5369 5370
    }

5371 5372 5373 5374 5375 5376 5377
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5378 5379 5380

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5381 5382 5383 5384
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return -1;
5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400
}


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

5401 5402
    virResetLastError();

5403 5404 5405 5406 5407
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

5408 5409 5410 5411 5412 5413 5414
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5415 5416

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5417 5418 5419 5420

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443
    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);

5444 5445
    virResetLastError();

5446 5447 5448 5449 5450 5451 5452
    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__);
5453
        goto error;
5454 5455
    }

5456 5457 5458 5459 5460 5461 5462
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5463 5464

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5465 5466 5467 5468

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5469 5470 5471 5472
    return -1;
}


5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499
/**
 * 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)
{
5500 5501 5502 5503
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

5504 5505
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5506
        goto error;
5507 5508 5509
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5510
        goto error;
5511 5512
    }

5513 5514
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5515
        goto error;
5516 5517
    }

5518 5519 5520 5521 5522 5523 5524
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
5525 5526

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5527 5528 5529 5530

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5531 5532 5533 5534
    return NULL;
}


5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549
/**
 * 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);

5550 5551
    virResetLastError();

5552 5553 5554 5555 5556 5557
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5558
        goto error;
5559 5560
    }

5561 5562 5563 5564 5565 5566 5567
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
5568 5569

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5570 5571 5572 5573

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592
    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);

5593 5594
    virResetLastError();

5595 5596 5597 5598 5599 5600
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5601
        goto error;
5602 5603
    }

5604 5605 5606 5607 5608 5609 5610
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
5611 5612 5613

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5614 5615 5616 5617
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631
}


/**
 * 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,
5632
                                 const char *uuidstr)
5633 5634 5635 5636
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

5637 5638
    virResetLastError();

5639 5640 5641 5642 5643 5644
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5645
        goto error;
5646 5647 5648 5649
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5650
        goto error;
5651 5652 5653
    }

    return virStoragePoolLookupByUUID(conn, uuid);
5654 5655 5656 5657 5658

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674
}


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

5675 5676 5677
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
5678 5679 5680 5681
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

5682 5683 5684 5685 5686 5687 5688
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
5689 5690 5691

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

5692 5693 5694 5695
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
5696 5697 5698 5699 5700 5701
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
5702
 * @flags: future flags, use 0 for now
5703 5704
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
5705
 * pool is not persistent, so its definition will disappear
5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716
 * 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);

5717 5718
    virResetLastError();

5719 5720 5721 5722 5723 5724
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5725
        goto error;
5726 5727 5728
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5729
        goto error;
5730 5731
    }

5732 5733 5734 5735 5736 5737 5738
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
5739 5740

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5741 5742 5743 5744

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5745 5746 5747 5748 5749 5750 5751
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
5752
 * @flags: future flags, use 0 for now
5753 5754
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
5755
 * pool is persistent, until explicitly undefined.
5756 5757 5758 5759 5760 5761 5762 5763 5764 5765
 *
 * 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);

5766 5767
    virResetLastError();

5768 5769 5770 5771 5772 5773
    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__);
5774
        goto error;
5775 5776 5777
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5778
        goto error;
5779 5780
    }

5781 5782 5783 5784 5785 5786 5787
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
5788 5789 5790

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5791 5792 5793 5794
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5795 5796 5797 5798 5799
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
5800
 * @flags: future flags, use 0 for now
5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812
 *
 * 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);

5813 5814
    virResetLastError();

5815 5816 5817 5818 5819 5820 5821
    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__);
5822
        goto error;
5823 5824
    }

5825 5826 5827 5828 5829 5830 5831
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
5832 5833 5834

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

5856 5857
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5878 5879 5880 5881
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5882 5883 5884 5885 5886 5887
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
5888
 * @flags: future flags, use 0 for now
5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900
 *
 * 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);

5901 5902
    virResetLastError();

5903 5904 5905 5906 5907 5908 5909
    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    conn = pool->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5910
        goto error;
5911 5912
    }

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5923 5924 5925 5926
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947
}


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

5948 5949
    virResetLastError();

5950 5951 5952 5953 5954 5955 5956 5957
    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__);
5958
        goto error;
5959 5960
    }

5961 5962 5963 5964 5965 5966 5967
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
5968 5969

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5970 5971 5972 5973

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994
    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);

5995 5996
    virResetLastError();

5997 5998 5999 6000 6001 6002 6003 6004
    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__);
6005
        goto error;
6006 6007
    }

6008 6009 6010 6011 6012 6013 6014
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6015 6016

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6017 6018 6019 6020

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038
    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);

6039 6040 6041
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6042 6043 6044 6045 6046 6047 6048 6049 6050 6051
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080
/**
 * 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;
}

6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098
/**
 * 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);

6099 6100
    virResetLastError();

6101 6102 6103 6104 6105 6106 6107 6108
    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__);
6109
        goto error;
6110 6111
    }

6112 6113 6114 6115 6116 6117 6118
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6119 6120

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6121 6122 6123 6124

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141
    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);

6142 6143
    virResetLastError();

6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166
    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);

6167 6168
    virResetLastError();

6169 6170 6171 6172 6173 6174
    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__);
6175
        goto error;
6176 6177 6178 6179 6180 6181
    }

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

    return (0);

6182 6183 6184 6185
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203
}

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

6204 6205
    virResetLastError();

6206 6207 6208 6209 6210 6211
    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__);
6212
        goto error;
6213 6214 6215
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
6216
        goto error;
6217 6218 6219 6220

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

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


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

6245 6246
    virResetLastError();

6247 6248 6249 6250 6251 6252
    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__);
6253
        goto error;
6254 6255 6256 6257 6258 6259
    }

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

    conn = pool->conn;

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6270 6271 6272 6273
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6274 6275 6276 6277 6278 6279
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
6280
 * @flags: flags for XML format options (set of virDomainXMLFlags)
6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294
 *
 * 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);

6295 6296 6297
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6298 6299 6300 6301 6302
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
6303
        goto error;
6304 6305 6306 6307
    }

    conn = pool->conn;

6308 6309 6310 6311 6312 6313 6314
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
6315 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);
    return NULL;
6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341
}


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

6342 6343 6344
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6345 6346 6347 6348 6349
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
6350
        goto error;
6351 6352 6353 6354
    }

    conn = pool->conn;

6355 6356 6357 6358 6359 6360 6361
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6362 6363

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6364 6365 6366 6367

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387
    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);

6388 6389 6390
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6391
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
6392
        goto error;
6393 6394
    }

6395 6396
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6397
        goto error;
6398 6399
    }

6400 6401
    conn = pool->conn;

6402 6403 6404 6405 6406 6407 6408
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6409 6410

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6411 6412 6413 6414

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431
    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);

6432 6433
    virResetLastError();

6434 6435 6436 6437 6438
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

6439 6440 6441 6442 6443 6444 6445
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6446 6447

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6448 6449 6450 6451

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473
    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);

6474 6475
    virResetLastError();

6476 6477 6478 6479 6480 6481 6482
    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__);
6483
        goto error;
6484 6485
    }

6486 6487 6488 6489 6490 6491 6492
    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;
    }
6493 6494

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6495 6496 6497 6498

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6499 6500 6501 6502 6503 6504
    return -1;
}


/**
 * virStorageVolGetConnect:
6505
 * @vol: pointer to a pool
6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521
 *
 * 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);

6522 6523
    virResetLastError();

6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547
    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);

6548 6549
    virResetLastError();

6550 6551 6552 6553 6554 6555
    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__);
6556
        goto error;
6557 6558
    }

6559 6560 6561 6562 6563 6564 6565
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
6566 6567

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6568 6569 6570 6571

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592
    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);

6593 6594
    virResetLastError();

6595 6596 6597 6598 6599 6600
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6601
        goto error;
6602 6603
    }

6604 6605 6606 6607 6608 6609 6610
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
6611 6612

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6613 6614 6615 6616

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635
    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);

6636 6637
    virResetLastError();

6638 6639 6640 6641 6642 6643
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6644
        goto error;
6645 6646
    }

6647 6648 6649 6650 6651 6652 6653
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
6654 6655

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6656 6657 6658 6659

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677
    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);

6678 6679
    virResetLastError();

6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692
    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
6693
 * unique, so the same volume will have the same
6694 6695 6696 6697 6698 6699 6700 6701 6702
 * 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);

6703 6704
    virResetLastError();

6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731
    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);

6732 6733
    virResetLastError();

6734 6735 6736 6737 6738 6739 6740
    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__);
6741
        goto error;
6742 6743
    }

6744 6745 6746 6747 6748 6749 6750
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6751 6752

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6753 6754 6755 6756

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6757 6758 6759 6760 6761 6762 6763
    return NULL;
}


/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
6764
 * @flags: future flags, use 0 for now
6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776
 *
 * 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);

6777 6778
    virResetLastError();

6779 6780 6781 6782 6783 6784 6785 6786
    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__);
6787
        goto error;
6788 6789
    }

6790 6791 6792 6793 6794 6795 6796
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6797 6798

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6799 6800 6801 6802

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6803 6804 6805 6806 6807 6808 6809 6810 6811
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
6812
 * storage volume continues to exist.
6813 6814 6815 6816 6817 6818 6819 6820
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

6821 6822
    virResetLastError();

6823 6824 6825 6826 6827 6828 6829 6830 6831 6832
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861
/**
 * 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;
}

6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878
/**
 * 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);

6879 6880
    virResetLastError();

6881 6882 6883 6884 6885 6886
    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__);
6887
        goto error;
6888 6889 6890 6891 6892 6893
    }

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

    conn = vol->conn;

6894 6895 6896 6897 6898 6899 6900
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6901 6902

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6903 6904 6905 6906

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927
    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);

6928 6929
    virResetLastError();

6930 6931 6932 6933 6934 6935
    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__);
6936
        goto error;
6937 6938 6939 6940
    }

    conn = vol->conn;

6941 6942 6943 6944 6945 6946 6947
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
6948 6949 6950

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6951 6952 6953 6954
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975
}


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

6976 6977
    virResetLastError();

6978 6979 6980 6981 6982 6983 6984
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

6985 6986 6987 6988 6989 6990 6991
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
6992 6993

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6994 6995 6996 6997

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6998 6999
    return NULL;
}
7000 7001 7002



7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019

/**
 * 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)
{
J
John Levon 已提交
7020
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
7021

7022 7023
    virResetLastError();

7024 7025 7026 7027 7028 7029
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7030
        goto error;
7031 7032
    }

7033 7034 7035 7036 7037 7038 7039
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7040 7041

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

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

7074 7075
    virResetLastError();

7076 7077 7078 7079 7080 7081
    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__);
7082
        goto error;
7083 7084
    }

7085 7086 7087 7088 7089 7090 7091
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7092 7093

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7094 7095 7096 7097

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114
    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);

7115 7116
    virResetLastError();

7117 7118 7119 7120 7121 7122 7123
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7124
        goto error;
7125 7126
    }

7127 7128 7129 7130 7131 7132 7133
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7134 7135

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7136 7137 7138 7139

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157
    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);

7158 7159
    virResetLastError();

7160 7161 7162 7163 7164
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7165 7166 7167 7168 7169 7170 7171
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
7172 7173

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7174 7175 7176 7177

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7178 7179 7180 7181 7182 7183 7184 7185
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7186 7187 7188
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205
 */
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 已提交
7206 7207
 * Accessor for the parent of the device
 *
7208 7209 7210 7211 7212 7213 7214
 * 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);

7215 7216
    virResetLastError();

7217 7218 7219 7220 7221
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7222 7223 7224 7225 7226
    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__);
7227
            virSetConnError(dev->conn);
7228 7229 7230 7231
            return NULL;
        }
    }
    return dev->parent;
7232 7233 7234 7235 7236 7237
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7238 7239
 * Accessor for the number of capabilities supported by the device.
 *
7240 7241 7242 7243 7244 7245
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

7246 7247
    virResetLastError();

7248 7249 7250 7251 7252
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

7253 7254 7255 7256 7257 7258 7259
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
7260 7261

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7262 7263 7264 7265

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285
    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);

7286 7287
    virResetLastError();

7288 7289 7290 7291 7292
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

7293 7294 7295 7296 7297 7298 7299
    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;
    }
7300 7301

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7302 7303 7304 7305

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322
    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);

7323 7324
    virResetLastError();

7325 7326 7327 7328 7329 7330 7331 7332 7333 7334
    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);
}


7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363
/**
 * 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;
}

7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492
/**
 * virNodeDeviceAttach:
 * @dev: pointer to the node device
 *
 * Dettach the node device from the node itself so that it may be
 * assigned to a guest domain.
 *
 * Depending on the hypervisor, this may involve operations such
 * as unbinding any device drivers from the device, binding the
 * device to a dummy device driver and resetting the device.
 *
 * If the device is currently in use by the node, this method may
 * fail.
 *
 * Once the device is not assigned to any guest, it may be re-attached
 * to the node using the virNodeDeviceReattach() method.
 */
int
virNodeDeviceDettach(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

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

    if (dev->conn->driver->nodeDeviceDettach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceDettach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

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

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

/**
 * virNodeDeviceReAttach:
 * @dev: pointer to the node device
 *
 * Re-attach a previously dettached node device to the node so that it
 * may be used by the node again.
 *
 * Depending on the hypervisor, this may involve operations such
 * as resetting the device, unbinding it from a dummy device driver
 * and binding it to its appropriate driver.
 *
 * If the device is currently in use by a guest, this method may fail.
 */
int
virNodeDeviceReAttach(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

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

    if (dev->conn->driver->nodeDeviceReAttach) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReAttach (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

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

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

/**
 * virNodeDeviceReset:
 * @dev: pointer to the node device
 *
 * Reset a previously dettached node device to the node before or
 * after assigning it to a guest.
 *
 * The exact reset semantics depends on the hypervisor and device
 * type but, for example, KVM will attempt to reset PCI devices with
 * a Function Level Reset, Secondary Bus Reset or a Power Management
 * D-State reset.
 *
 * If the reset will affect other devices which are currently in use,
 * this function may fail.
 */
int
virNodeDeviceReset(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

    virResetLastError();

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

    if (dev->conn->driver->nodeDeviceReset) {
        int ret;
        ret = dev->conn->driver->nodeDeviceReset (dev);
        if (ret < 0)
            goto error;
        return ret;
    }

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

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

7493

7494 7495 7496 7497 7498 7499 7500 7501 7502
/*
 * 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 已提交
7503
 * @freecb: optional function to deallocate opaque when not used anymore
7504 7505 7506 7507
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
7508 7509 7510 7511 7512 7513 7514
 * 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.
 *
7515 7516 7517 7518 7519
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
7520 7521
                              void *opaque,
                              virFreeCallback freecb)
7522
{
7523 7524
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
7525 7526 7527 7528 7529 7530 7531

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7532
        goto error;
7533 7534
    }

7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546
    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);
7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564
    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)
{
7565 7566 7567
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
7568 7569 7570 7571 7572 7573 7574

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7575 7576 7577 7578 7579 7580 7581 7582
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
7583 7584
    }

7585 7586 7587 7588
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7589 7590
    return -1;
}