libvirt.c 204.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
/**
 * 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.
D
Daniel Veillard 已提交
1154 1155
 *
 * Returns 0 in case of success, -1 in case of failure
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
 */
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 已提交
1171 1172
/*
 * Not for public use.  This function is part of the internal
1173 1174 1175
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1176
virDrvSupportsFeature (virConnectPtr conn, int feature)
1177
{
1178
    int ret;
1179 1180
    DEBUG("conn=%p, feature=%d", conn, feature);

1181 1182 1183 1184
    virResetLastError();

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

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

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

1211 1212
    virResetLastError();

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

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

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

1243 1244
    virResetLastError();

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

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

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

1262
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1263 1264 1265 1266

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

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

1287 1288
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1302 1303 1304 1305

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

1330 1331
    virResetLastError();

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

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

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

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

1367 1368
    virResetLastError();

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

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

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

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

1403 1404
    virResetLastError();

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

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

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

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

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

1442 1443
    virResetLastError();

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

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

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

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

1482 1483 1484
    virResetLastError();

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

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

1512 1513
    virResetLastError();

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

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

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

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

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

1578 1579
    virResetLastError();

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

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

1597
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1598 1599 1600 1601

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

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

1620 1621
    virResetLastError();

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

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

1639
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1640 1641 1642 1643

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

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

1664 1665
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1666 1667
    virResetLastError();

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

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

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

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

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

1720 1721
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1740 1741 1742 1743

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

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

1763 1764
    DEBUG("domain=%p", domain);

1765 1766
    virResetLastError();

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

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

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

1786
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1787 1788 1789 1790

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

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

1808 1809 1810
    virResetLastError();

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

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

1869 1870
    virResetLastError();

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

1880 1881
    conn = domain->conn;

1882 1883 1884 1885 1886 1887 1888
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1889

1890
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1891 1892 1893 1894

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

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

1914 1915
    virResetLastError();

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

1925 1926
    conn = domain->conn;

1927 1928 1929 1930 1931 1932 1933
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1934

1935
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1936 1937 1938 1939

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

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

1962 1963
    virResetLastError();

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

1978 1979 1980 1981 1982
    /*
     * 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] != '/') {
1983
        unsigned int len, t;
1984

1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
        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];
1995 1996 1997

    }

1998 1999 2000 2001 2002 2003 2004
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2005

2006
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2007 2008 2009 2010

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2011
    return -1;
2012 2013 2014 2015
}

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

2029 2030
    virResetLastError();

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

2044 2045 2046 2047 2048
    /*
     * 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] != '/') {
2049 2050 2051
        unsigned int len, t;

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

2069 2070 2071 2072 2073 2074 2075
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2076

2077
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2078 2079 2080 2081

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

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

2104 2105
    virResetLastError();

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

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

    }

2146 2147 2148 2149 2150 2151 2152
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2153

2154
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2155 2156 2157 2158

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

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

2181 2182
    virResetLastError();

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

2192 2193
    conn = domain->conn;

2194 2195 2196 2197 2198 2199 2200
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2201

2202
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2203 2204 2205 2206

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

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

2227 2228
    virResetLastError();

2229
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2230
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2231 2232
        return (-1);
    }
2233 2234
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2235
        goto error;
2236
    }
2237

2238 2239
    conn = domain->conn;

2240 2241 2242 2243 2244 2245 2246
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2247

2248
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2249 2250 2251 2252

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

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

2270 2271
    virResetLastError();

D
Daniel Veillard 已提交
2272
    if (!VIR_IS_DOMAIN(domain)) {
2273
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2274
        return (NULL);
D
Daniel Veillard 已提交
2275
    }
2276
    return (domain->name);
2277 2278
}

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

2293 2294
    virResetLastError();

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

2306 2307
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2308
    return (0);
2309 2310
}

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

2327 2328
    virResetLastError();

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

K
Karel Zak 已提交
2338
    if (virDomainGetUUID(domain, &uuid[0]))
2339
        goto error;
K
Karel Zak 已提交
2340

2341
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2342
    return (0);
2343 2344 2345 2346 2347

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

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

2363 2364
    virResetLastError();

D
Daniel Veillard 已提交
2365
    if (!VIR_IS_DOMAIN(domain)) {
2366
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2367
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2368
    }
2369
    return (domain->id);
2370 2371
}

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

2387 2388 2389
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2390
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2391
        return (NULL);
D
Daniel Veillard 已提交
2392
    }
2393

2394 2395
    conn = domain->conn;

2396 2397 2398 2399 2400 2401 2402
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2403

2404
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2405 2406 2407 2408

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

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

2428 2429
    virResetLastError();

D
Daniel Veillard 已提交
2430
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2431
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2432
        return (0);
D
Daniel Veillard 已提交
2433
    }
2434

2435 2436
    conn = domain->conn;

2437 2438 2439 2440 2441 2442 2443
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2444

2445
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2446 2447 2448 2449

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2450
    return 0;
2451 2452
}

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

2471 2472
    virResetLastError();

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

2487 2488 2489 2490 2491 2492 2493
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2494

2495
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2496 2497 2498 2499

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

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

2521 2522
    virResetLastError();

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

    conn = domain->conn;
2537

2538 2539 2540 2541 2542 2543 2544
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2545

2546
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2547 2548 2549 2550

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

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

2571 2572
    virResetLastError();

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

2582
    memset(info, 0, sizeof(virDomainInfo));
2583

2584 2585
    conn = domain->conn;

2586 2587 2588 2589 2590 2591 2592
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2593

2594
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2595 2596 2597 2598

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

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

2619 2620 2621
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2622
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2623
        return (NULL);
D
Daniel Veillard 已提交
2624
    }
2625

2626 2627
    conn = domain->conn;

2628 2629 2630 2631 2632 2633
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

2634 2635 2636 2637 2638 2639 2640
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
2641

2642
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2643 2644 2645 2646

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2647
    return NULL;
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 2706 2707 2708 2709
/**
 * 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 已提交
2710 2711
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2712
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
2713
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
2714

2715 2716 2717
    virResetLastError();

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

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

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

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

D
Daniel Veillard 已提交
2790
        if (!dom_xml)
2791
            goto error;
D
Daniel Veillard 已提交
2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806

        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);
    }
2807 2808 2809 2810 2811 2812 2813

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

 done:
2838 2839
    free (uri_out);
    free (cookie);
2840
    return ddomain;
2841 2842 2843 2844 2845

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

D
Daniel Veillard 已提交
2848 2849
/*
 * Not for public use.  This function is part of the internal
2850 2851 2852
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2853
virDomainMigratePrepare (virConnectPtr dconn,
2854 2855 2856 2857 2858 2859 2860 2861
                           char **cookie,
                           int *cookielen,
                           const char *uri_in,
                           char **uri_out,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
J
John Levon 已提交
2862 2863 2864
    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);
2865

2866 2867
    virResetLastError();

2868
    if (!VIR_IS_CONNECT (dconn)) {
2869
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2870 2871 2872
        return -1;
    }

2873 2874
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2875
        goto error;
2876 2877
    }

2878 2879 2880 2881 2882 2883 2884 2885 2886
    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;
    }
2887 2888

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2889 2890 2891 2892

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
2893 2894 2895
    return -1;
}

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

2914 2915 2916
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2917
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2918 2919 2920 2921
        return -1;
    }
    conn = domain->conn;

2922 2923
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2924
        goto error;
2925 2926
    }

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

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2938 2939 2940 2941

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

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

2961 2962
    virResetLastError();

2963
    if (!VIR_IS_CONNECT (dconn)) {
2964
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2965 2966 2967
        return NULL;
    }

2968 2969
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2970
        goto error;
2971 2972
    }

2973 2974 2975 2976 2977 2978 2979 2980 2981
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
2982 2983

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2984 2985 2986 2987

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
2988
    return NULL;
D
Daniel Veillard 已提交
2989 2990 2991
}


D
Daniel Veillard 已提交
2992 2993
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
2994 2995 2996
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
2997 2998 2999 3000 3001 3002 3003 3004 3005
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 已提交
3006
{
J
John Levon 已提交
3007 3008 3009 3010
    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 已提交
3011

3012 3013
    virResetLastError();

D
Daniel Veillard 已提交
3014 3015 3016 3017 3018
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

3019 3020
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3021
        goto error;
3022 3023
    }

3024 3025 3026 3027 3028 3029 3030 3031 3032 3033
    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 已提交
3034 3035

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3036 3037 3038 3039

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

D
Daniel Veillard 已提交
3043 3044
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3045 3046 3047
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3048 3049 3050 3051 3052 3053 3054
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3055
{
J
John Levon 已提交
3056 3057 3058
    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 已提交
3059

3060 3061
    virResetLastError();

D
Daniel Veillard 已提交
3062 3063 3064 3065 3066
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3067 3068
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3069
        goto error;
3070 3071
    }

3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
    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 已提交
3082 3083

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3084 3085 3086 3087

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3088
    return NULL;
3089 3090 3091
}


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

3106 3107
    virResetLastError();

3108
    if (!VIR_IS_CONNECT(conn)) {
3109
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3110 3111 3112 3113
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3114
        goto error;
3115 3116
    }

3117 3118 3119 3120 3121 3122 3123
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3124

3125
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3126 3127 3128 3129

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

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

3148 3149
    virResetLastError();

3150
    if (!VIR_IS_CONNECT (conn)) {
3151
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3152 3153 3154
        return NULL;
    }

3155 3156 3157 3158 3159 3160 3161
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3162

3163
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3164 3165 3166 3167

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3168 3169 3170
    return NULL;
}

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

3186 3187
    virResetLastError();

3188 3189 3190 3191 3192
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3193 3194 3195 3196 3197 3198 3199
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3200 3201

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3202 3203 3204 3205

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3206 3207 3208
    return 0;
}

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

3225 3226
    virResetLastError();

3227
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3228
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3229 3230 3231 3232 3233 3234
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3235 3236
        if (!schedtype)
            goto error;
3237 3238 3239
        return schedtype;
    }

3240
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3241 3242 3243 3244

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

3270 3271
    virResetLastError();

3272
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3273
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3274 3275 3276 3277
        return -1;
    }
    conn = domain->conn;

3278 3279 3280 3281 3282 3283 3284
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3285

3286
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3287 3288 3289 3290

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

3313 3314
    virResetLastError();

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

3325 3326 3327 3328 3329 3330 3331
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3332

3333
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3334 3335 3336 3337

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3338 3339 3340 3341
    return -1;
}


3342
/**
3343
 * virDomainBlockStats:
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 3369 3370 3371 3372
 * @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);

3373 3374
    virResetLastError();

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

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3387
            goto error;
3388 3389 3390 3391 3392 3393

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3394 3395 3396 3397

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3398 3399 3400 3401
    return -1;
}

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

3431 3432
    virResetLastError();

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

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3445
            goto error;
3446 3447 3448 3449 3450 3451

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3452 3453 3454 3455

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

R
Richard W.M. Jones 已提交
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 3488 3489 3490 3491
/**
 * 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 已提交
3492 3493 3494 3495
 * 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 已提交
3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509
 * 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);

3510 3511
    virResetLastError();

R
Richard W.M. Jones 已提交
3512 3513 3514 3515 3516
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3517

3518 3519
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3520
        goto error;
3521 3522
    }

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

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

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

3542 3543 3544 3545 3546 3547 3548 3549
    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 已提交
3550 3551

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3552 3553 3554 3555

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

R
Richard W.M. Jones 已提交
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 3597 3598 3599 3600
/**
 * 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);

3601 3602
    virResetLastError();

R
Richard W.M. Jones 已提交
3603 3604 3605 3606 3607 3608
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3609 3610
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3611
        goto error;
3612 3613
    }

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

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

3648 3649 3650 3651 3652 3653 3654 3655
    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 已提交
3656 3657

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3658 3659 3660 3661

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

3665

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

3688 3689
    virResetLastError();

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

3703 3704 3705 3706 3707 3708 3709
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3710

3711
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3712 3713 3714 3715

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3716
    return NULL;
3717 3718 3719 3720 3721 3722
}

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

3732 3733
    virResetLastError();

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

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

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

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

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

3773 3774
    virResetLastError();

3775
    if (!VIR_IS_CONNECT(conn)) {
3776
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3777 3778 3779
        return (-1);
    }

3780 3781 3782 3783 3784 3785 3786
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
3787

3788
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3789 3790 3791 3792

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3793
    return -1;
3794 3795 3796 3797 3798 3799 3800 3801
}

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

3812 3813
    virResetLastError();

3814
    if (!VIR_IS_CONNECT(conn)) {
3815
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3816 3817 3818
        return (-1);
    }

3819
    if ((names == NULL) || (maxnames < 0)) {
3820
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3821
        goto error;
3822 3823
    }

3824 3825 3826 3827 3828 3829 3830
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
3831

3832
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3833 3834 3835 3836

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3837
    return -1;
3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
}

/**
 * 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) {
3851
    virConnectPtr conn;
3852
    DEBUG("domain=%p", domain);
3853

3854 3855
    virResetLastError();

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

3866 3867 3868 3869 3870 3871 3872
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3873

3874
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3875 3876 3877 3878

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

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

3900 3901 3902
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3903
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3904 3905 3906 3907
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
3908
        goto error;
3909 3910
    }

3911 3912
    conn = domain->conn;

3913 3914 3915 3916 3917 3918 3919
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
3920

3921
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3922 3923 3924 3925

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3926
    return -1;
3927 3928 3929 3930 3931
}

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

3946 3947 3948
    virResetLastError();

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

3953 3954
    conn = domain->conn;

3955 3956
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3957
        goto error;
3958 3959
    }

3960 3961 3962 3963 3964 3965 3966
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
3967

3968
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3969 3970 3971 3972

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

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

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
3992
    virConnectPtr conn;
3993
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
3994

3995 3996
    virResetLastError();

3997
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3998
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3999 4000
        return (-1);
    }
4001 4002
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4003
        goto error;
4004
    }
4005

4006 4007
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4008
        goto error;
4009
    }
4010
    conn = domain->conn;
4011

4012 4013 4014 4015 4016 4017 4018
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4019

4020
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4021 4022 4023 4024

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

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

4053 4054
    virResetLastError();

4055
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4056
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4057 4058
        return (-1);
    }
4059 4060
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4061
        goto error;
4062
    }
4063

4064
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4065
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4066
       goto error;
4067
    }
4068

4069 4070
    conn = domain->conn;

4071 4072 4073 4074 4075 4076 4077
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4078

4079
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4080 4081 4082 4083

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4084
    return -1;
4085 4086 4087 4088 4089 4090 4091 4092 4093
}

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

4115 4116
    virResetLastError();

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

4130 4131
    conn = domain->conn;

4132 4133 4134 4135 4136 4137 4138 4139
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4140

4141
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4142 4143 4144 4145

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

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

4167 4168
    virResetLastError();

4169
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4170
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4171 4172 4173 4174 4175
        return (-1);
    }

    conn = domain->conn;

4176 4177 4178 4179 4180 4181 4182
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4183

4184
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4185 4186 4187 4188

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4189
    return -1;
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 4220 4221 4222 4223
/**
 * 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__);
4224
    return -1;
4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253
}

/**
 * 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__);
4254
    return -1;
4255
}
4256

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

4272 4273
    virResetLastError();

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

4284 4285 4286 4287 4288 4289 4290
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4291

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4297
    return -1;
4298 4299 4300 4301 4302 4303
}

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

4315 4316
    virResetLastError();

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

4327 4328 4329 4330 4331 4332 4333
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4334

4335
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4336 4337 4338 4339

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

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

4368 4369
    virResetLastError();

4370 4371 4372 4373 4374
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4375
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4376
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4377
        goto error;
4378 4379
    }

4380 4381 4382 4383 4384 4385 4386
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4387 4388

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4389 4390 4391 4392

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

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

4415 4416 4417
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4418
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4419 4420 4421 4422 4423
        return NULL;
    }
    return net->conn;
}

4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434
/**
 * 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)
{
4435 4436
    DEBUG("conn=%p", conn);

4437 4438
    virResetLastError();

4439
    if (!VIR_IS_CONNECT(conn)) {
4440
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4441 4442 4443
        return (-1);
    }

4444 4445 4446 4447 4448 4449 4450
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4451

4452
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4453 4454 4455 4456

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4457
    return -1;
4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470
}

/**
 * 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
4471
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4472
{
4473 4474
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4475 4476
    virResetLastError();

4477
    if (!VIR_IS_CONNECT(conn)) {
4478
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4479 4480 4481
        return (-1);
    }

4482
    if ((names == NULL) || (maxnames < 0)) {
4483
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4484
        goto error;
4485 4486
    }

4487 4488 4489 4490 4491 4492 4493
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4494

4495
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4496 4497 4498 4499

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4500
    return -1;
4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513
}

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

4516 4517
    virResetLastError();

4518
    if (!VIR_IS_CONNECT(conn)) {
4519
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4520 4521 4522
        return (-1);
    }

4523 4524 4525 4526 4527 4528 4529
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4530

4531
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4532 4533 4534 4535

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4536
    return -1;
4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549
}

/**
 * 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
4550
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4551 4552
                              int maxnames)
{
4553 4554
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4555 4556
    virResetLastError();

4557
    if (!VIR_IS_CONNECT(conn)) {
4558
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4559 4560 4561
        return (-1);
    }

4562
    if ((names == NULL) || (maxnames < 0)) {
4563
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4564
        goto error;
4565 4566
    }

4567 4568 4569 4570 4571 4572 4573 4574
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4575

4576
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4577 4578 4579 4580

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4581
    return -1;
4582 4583 4584 4585 4586 4587 4588 4589 4590
}

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

4599 4600
    virResetLastError();

4601
    if (!VIR_IS_CONNECT(conn)) {
4602
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4603 4604 4605 4606
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4607
        goto  error;
4608 4609
    }

4610 4611 4612 4613 4614 4615 4616
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
4617

4618
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4619 4620 4621 4622

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4623
    return NULL;
4624 4625 4626 4627 4628 4629 4630 4631 4632
}

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

4641 4642
    virResetLastError();

4643
    if (!VIR_IS_CONNECT(conn)) {
4644
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4645 4646 4647 4648
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4649
        goto error;
4650 4651
    }

4652 4653 4654 4655 4656 4657 4658
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4659

4660
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4661 4662 4663 4664

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4665
    return NULL;
4666 4667 4668 4669 4670 4671 4672 4673 4674
}

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

4686 4687
    virResetLastError();

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

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

    return virNetworkLookupByUUID(conn, &uuid[0]);
4719 4720 4721 4722 4723

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738
}

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

4741 4742
    virResetLastError();

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

4756 4757 4758 4759 4760 4761 4762
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
4763

4764
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4765 4766 4767 4768

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4769
    return NULL;
4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781
}

/**
 * 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
4782 4783
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
4784 4785
    DEBUG("conn=%p, xml=%s", conn, xml);

4786 4787
    virResetLastError();

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

4801 4802 4803 4804 4805 4806 4807
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
4808

4809
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4810 4811 4812 4813

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4814
    return NULL;
4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827
}

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

4830 4831
    virResetLastError();

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

4842 4843 4844 4845 4846 4847 4848
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4849

4850
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4851 4852 4853 4854

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4855
    return -1;
4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867
}

/**
 * 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
4868 4869
virNetworkCreate(virNetworkPtr network)
{
4870
    virConnectPtr conn;
4871 4872
    DEBUG("network=%p", network);

4873 4874
    virResetLastError();

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

4885 4886 4887 4888 4889 4890 4891
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4892

4893
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4894 4895 4896 4897

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
4898
    return -1;
4899 4900 4901 4902 4903 4904 4905
}

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

4918 4919
    virResetLastError();

4920
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4921
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4922 4923 4924 4925 4926 4927
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4928
        goto error;
4929 4930
    }

4931 4932 4933 4934 4935 4936 4937
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
4938

4939
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4940 4941 4942 4943

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

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

4961 4962 4963
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
4964
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4965 4966
        return (-1);
    }
4967
    if (virUnrefNetwork(network) < 0)
4968 4969 4970 4971
        return (-1);
    return(0);
}

4972 4973
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
4974
 * @network: the network to hold a reference on
4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985
 *
 * 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.
D
Daniel Veillard 已提交
4986 4987
 *
 * Returns 0 in case of success, -1 in case of failure.
4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002
 */
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;
}

5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014
/**
 * 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)
{
5015 5016
    DEBUG("network=%p", network);

5017 5018
    virResetLastError();

5019
    if (!VIR_IS_NETWORK(network)) {
5020
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037
        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)
{
5038 5039
    DEBUG("network=%p, uuid=%p", network, uuid);

5040 5041
    virResetLastError();

5042
    if (!VIR_IS_NETWORK(network)) {
5043
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5044 5045 5046 5047
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5048
        goto error;
5049 5050 5051 5052 5053
    }

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

    return (0);
5054 5055 5056 5057 5058

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074
}

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

5077 5078
    virResetLastError();

5079
    if (!VIR_IS_NETWORK(network)) {
5080
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5081 5082 5083 5084
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5085
        goto error;
5086 5087 5088
    }

    if (virNetworkGetUUID(network, &uuid[0]))
5089
        return (-1);
5090

5091
    virUUIDFormat(uuid, buf);
5092
    return (0);
5093 5094 5095 5096 5097

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113
}

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

5117 5118 5119
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5120
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5121 5122 5123 5124
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5125
        goto error;
5126 5127
    }

5128 5129
    conn = network->conn;

5130 5131 5132 5133 5134 5135 5136
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5137

5138
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5139 5140 5141 5142

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5143
    return NULL;
5144
}
5145 5146 5147 5148 5149

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5150
 * Provides a bridge interface name to which a domain may connect
5151 5152 5153 5154 5155 5156 5157 5158
 * 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)
{
5159
    virConnectPtr conn;
5160
    DEBUG("network=%p", network);
5161

5162 5163 5164
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5165
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5166 5167 5168
        return (NULL);
    }

5169 5170
    conn = network->conn;

5171 5172 5173 5174 5175 5176 5177
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5178

5179
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5180 5181 5182 5183

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5184
    return NULL;
5185
}
5186 5187 5188 5189

/**
 * virNetworkGetAutostart:
 * @network: a network object
5190
 * @autostart: the value returned
5191
 *
5192
 * Provides a boolean value indicating whether the network
5193 5194 5195 5196 5197 5198 5199
 * 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,
5200 5201 5202
                       int *autostart)
{
    virConnectPtr conn;
5203
    DEBUG("network=%p, autostart=%p", network, autostart);
5204

5205 5206 5207
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5208
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5209 5210 5211 5212
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5213
        goto error;
5214 5215
    }

5216 5217
    conn = network->conn;

5218 5219 5220 5221 5222 5223 5224
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5225

5226
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5227 5228 5229 5230

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5231
    return -1;
5232 5233 5234 5235 5236
}

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

5251 5252 5253
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5254
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5255 5256 5257
        return (-1);
    }

5258 5259
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5260
        goto error;
5261 5262
    }

5263 5264
    conn = network->conn;

5265 5266 5267 5268 5269 5270 5271
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5272

5273
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5274 5275 5276 5277

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

5281 5282 5283

/**
 * virStoragePoolGetConnect:
5284
 * @pool: pointer to a pool
5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300
 *
 * 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);

5301 5302 5303
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322
        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);

5323 5324
    virResetLastError();

5325 5326 5327 5328 5329
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

5330 5331 5332 5333 5334 5335 5336
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5337 5338

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5339 5340 5341 5342

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364
    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);

5365 5366
    virResetLastError();

5367 5368 5369 5370 5371 5372 5373
    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__);
5374
        goto error;
5375 5376
    }

5377 5378 5379 5380 5381 5382 5383
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5384 5385 5386

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5387 5388 5389 5390
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return -1;
5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406
}


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

5407 5408
    virResetLastError();

5409 5410 5411 5412 5413
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

5414 5415 5416 5417 5418 5419 5420
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
5421 5422

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5423 5424 5425 5426

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449
    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);

5450 5451
    virResetLastError();

5452 5453 5454 5455 5456 5457 5458
    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__);
5459
        goto error;
5460 5461
    }

5462 5463 5464 5465 5466 5467 5468
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
5469 5470

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5471 5472 5473 5474

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5475 5476 5477 5478
    return -1;
}


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

    virResetLastError();

5510 5511
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5512
        goto error;
5513 5514 5515
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5516
        goto error;
5517 5518
    }

5519 5520
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5521
        goto error;
5522 5523
    }

5524 5525 5526 5527 5528 5529 5530
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
5531 5532

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5533 5534 5535 5536

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5537 5538 5539 5540
    return NULL;
}


5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555
/**
 * 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);

5556 5557
    virResetLastError();

5558 5559 5560 5561 5562 5563
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5564
        goto error;
5565 5566
    }

5567 5568 5569 5570 5571 5572 5573
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
5574 5575

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5576 5577 5578 5579

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598
    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);

5599 5600
    virResetLastError();

5601 5602 5603 5604 5605 5606
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5607
        goto error;
5608 5609
    }

5610 5611 5612 5613 5614 5615 5616
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
5617 5618 5619

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5620 5621 5622 5623
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637
}


/**
 * 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,
5638
                                 const char *uuidstr)
5639 5640 5641 5642
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

5643 5644
    virResetLastError();

5645 5646 5647 5648 5649 5650
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5651
        goto error;
5652 5653 5654 5655
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5656
        goto error;
5657 5658 5659
    }

    return virStoragePoolLookupByUUID(conn, uuid);
5660 5661 5662 5663 5664

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680
}


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

5681 5682 5683
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
5684 5685 5686 5687
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

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

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

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

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

5723 5724
    virResetLastError();

5725 5726 5727 5728 5729 5730
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5731
        goto error;
5732 5733 5734
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5735
        goto error;
5736 5737
    }

5738 5739 5740 5741 5742 5743 5744
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
5745 5746

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5747 5748 5749 5750

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5751 5752 5753 5754 5755 5756 5757
    return NULL;
}

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

5772 5773
    virResetLastError();

5774 5775 5776 5777 5778 5779
    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__);
5780
        goto error;
5781 5782 5783
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5784
        goto error;
5785 5786
    }

5787 5788 5789 5790 5791 5792 5793
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
5794 5795 5796

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5797 5798 5799 5800
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
5801 5802 5803 5804 5805
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
5806
 * @flags: future flags, use 0 for now
5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818
 *
 * 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);

5819 5820
    virResetLastError();

5821 5822 5823 5824 5825 5826 5827
    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__);
5828
        goto error;
5829 5830
    }

5831 5832 5833 5834 5835 5836 5837
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
5838 5839 5840

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5841 5842 5843 5844
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861
}


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

5862 5863
    virResetLastError();

5864 5865 5866 5867 5868 5869 5870
    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__);
5871
        goto error;
5872 5873
    }

5874 5875 5876 5877 5878 5879 5880
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
5881 5882 5883

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5884 5885 5886 5887
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5888 5889 5890 5891 5892 5893
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
5894
 * @flags: future flags, use 0 for now
5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906
 *
 * 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);

5907 5908
    virResetLastError();

5909 5910 5911 5912 5913 5914 5915
    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__);
5916
        goto error;
5917 5918
    }

5919 5920 5921 5922 5923 5924 5925
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
5926 5927 5928

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

5929 5930 5931 5932
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953
}


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

5954 5955
    virResetLastError();

5956 5957 5958 5959 5960 5961 5962 5963
    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__);
5964
        goto error;
5965 5966
    }

5967 5968 5969 5970 5971 5972 5973
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
5974 5975

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5976 5977 5978 5979

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000
    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);

6001 6002
    virResetLastError();

6003 6004 6005 6006 6007 6008 6009 6010
    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__);
6011
        goto error;
6012 6013
    }

6014 6015 6016 6017 6018 6019 6020
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6021 6022

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6023 6024 6025 6026

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

6045 6046 6047
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6048 6049 6050 6051 6052 6053 6054 6055 6056 6057
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


6058 6059
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
6060
 * @pool: the pool to hold a reference on
6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071
 *
 * 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.
D
Daniel Veillard 已提交
6072 6073
 *
 * Returns 0 in case of success, -1 in case of failure.
6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088
 */
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;
}

6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106
/**
 * 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);

6107 6108
    virResetLastError();

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

6120 6121 6122 6123 6124 6125 6126
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6127 6128

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6129 6130 6131 6132

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149
    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);

6150 6151
    virResetLastError();

6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174
    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);

6175 6176
    virResetLastError();

6177 6178 6179 6180 6181 6182
    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__);
6183
        goto error;
6184 6185 6186 6187 6188 6189
    }

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

    return (0);

6190 6191 6192 6193
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211
}

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

6212 6213
    virResetLastError();

6214 6215 6216 6217 6218 6219
    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__);
6220
        goto error;
6221 6222 6223
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
6224
        goto error;
6225 6226 6227 6228

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

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


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

6253 6254
    virResetLastError();

6255 6256 6257 6258 6259 6260
    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__);
6261
        goto error;
6262 6263 6264 6265 6266 6267
    }

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

    conn = pool->conn;

6268 6269 6270 6271 6272 6273 6274
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6275 6276 6277

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6278 6279 6280 6281
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6282 6283 6284 6285 6286 6287
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
6288
 * @flags: flags for XML format options (set of virDomainXMLFlags)
6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302
 *
 * 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);

6303 6304 6305
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6306 6307 6308 6309 6310
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
6311
        goto error;
6312 6313 6314 6315
    }

    conn = pool->conn;

6316 6317 6318 6319 6320 6321 6322
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
6323 6324 6325

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6326 6327 6328 6329
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return NULL;
6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349
}


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

6350 6351 6352
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6353 6354 6355 6356 6357
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
6358
        goto error;
6359 6360 6361 6362
    }

    conn = pool->conn;

6363 6364 6365 6366 6367 6368 6369
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6370 6371

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6372 6373 6374 6375

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395
    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);

6396 6397 6398
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6399
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
6400
        goto error;
6401 6402
    }

6403 6404
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6405
        goto error;
6406 6407
    }

6408 6409
    conn = pool->conn;

6410 6411 6412 6413 6414 6415 6416
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
6417 6418

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6419 6420 6421 6422

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439
    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);

6440 6441
    virResetLastError();

6442 6443 6444 6445 6446
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

6447 6448 6449 6450 6451 6452 6453
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6454 6455

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6456 6457 6458 6459

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481
    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);

6482 6483
    virResetLastError();

6484 6485 6486 6487 6488 6489 6490
    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__);
6491
        goto error;
6492 6493
    }

6494 6495 6496 6497 6498 6499 6500
    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;
    }
6501 6502

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6503 6504 6505 6506

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6507 6508 6509 6510 6511 6512
    return -1;
}


/**
 * virStorageVolGetConnect:
6513
 * @vol: pointer to a pool
6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529
 *
 * 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);

6530 6531
    virResetLastError();

6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555
    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);

6556 6557
    virResetLastError();

6558 6559 6560 6561 6562 6563
    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__);
6564
        goto error;
6565 6566
    }

6567 6568 6569 6570 6571 6572 6573
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
6574 6575

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6576 6577 6578 6579

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600
    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);

6601 6602
    virResetLastError();

6603 6604 6605 6606 6607 6608
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6609
        goto error;
6610 6611
    }

6612 6613 6614 6615 6616 6617 6618
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
6619 6620

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6621 6622 6623 6624

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643
    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);

6644 6645
    virResetLastError();

6646 6647 6648 6649 6650 6651
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6652
        goto error;
6653 6654
    }

6655 6656 6657 6658 6659 6660 6661
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
6662 6663

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6664 6665 6666 6667

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685
    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);

6686 6687
    virResetLastError();

6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700
    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
6701
 * unique, so the same volume will have the same
6702 6703 6704 6705 6706 6707 6708 6709 6710
 * 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);

6711 6712
    virResetLastError();

6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (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);

6740 6741
    virResetLastError();

6742 6743 6744 6745 6746 6747 6748
    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__);
6749
        goto error;
6750 6751
    }

6752 6753 6754 6755 6756 6757 6758
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6759 6760

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6761 6762 6763 6764

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6765 6766 6767 6768 6769 6770 6771
    return NULL;
}


/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
6772
 * @flags: future flags, use 0 for now
6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784
 *
 * 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);

6785 6786
    virResetLastError();

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

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

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6811 6812 6813 6814 6815 6816 6817 6818 6819
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
6820
 * storage volume continues to exist.
6821 6822 6823 6824 6825 6826 6827 6828
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

6829 6830
    virResetLastError();

6831 6832 6833 6834 6835 6836 6837 6838 6839 6840
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


6841 6842
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
6843
 * @vol: the vol to hold a reference on
6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854
 *
 * 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.
D
Daniel Veillard 已提交
6855 6856
 *
 * Returns 0 in case of success, -1 in case of failure.
6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871
 */
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;
}

6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888
/**
 * 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);

6889 6890
    virResetLastError();

6891 6892 6893 6894 6895 6896
    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__);
6897
        goto error;
6898 6899 6900 6901 6902 6903
    }

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

    conn = vol->conn;

6904 6905 6906 6907 6908 6909 6910
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6911 6912

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6913 6914 6915 6916

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937
    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);

6938 6939
    virResetLastError();

6940 6941 6942 6943 6944 6945
    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__);
6946
        goto error;
6947 6948 6949 6950
    }

    conn = vol->conn;

6951 6952 6953 6954 6955 6956 6957
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
6958 6959 6960

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6961 6962 6963 6964
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985
}


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

6986 6987
    virResetLastError();

6988 6989 6990 6991 6992 6993 6994
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

6995 6996 6997 6998 6999 7000 7001
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
7002 7003

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7004 7005 7006 7007

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7008 7009
    return NULL;
}
7010 7011 7012



7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029

/**
 * 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 已提交
7030
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
7031

7032 7033
    virResetLastError();

7034 7035 7036 7037 7038 7039
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7040
        goto error;
7041 7042
    }

7043 7044 7045 7046 7047 7048 7049
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7050 7051

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7052 7053 7054 7055

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083
    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);

7084 7085
    virResetLastError();

7086 7087 7088 7089 7090 7091
    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__);
7092
        goto error;
7093 7094
    }

7095 7096 7097 7098 7099 7100 7101
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7102 7103

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7104 7105 7106 7107

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124
    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);

7125 7126
    virResetLastError();

7127 7128 7129 7130 7131 7132 7133
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7134
        goto error;
7135 7136
    }

7137 7138 7139 7140 7141 7142 7143
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7144 7145

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7146 7147 7148 7149

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167
    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);

7168 7169
    virResetLastError();

7170 7171 7172 7173 7174
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7175 7176 7177 7178 7179 7180 7181
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
7182 7183

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7184 7185 7186 7187

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7188 7189 7190 7191 7192 7193 7194 7195
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7196 7197 7198
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215
 */
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 已提交
7216 7217
 * Accessor for the parent of the device
 *
7218 7219 7220 7221 7222 7223 7224
 * 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);

7225 7226
    virResetLastError();

7227 7228 7229 7230 7231
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7232 7233 7234 7235 7236
    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__);
7237
            virSetConnError(dev->conn);
7238 7239 7240 7241
            return NULL;
        }
    }
    return dev->parent;
7242 7243 7244 7245 7246 7247
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7248 7249
 * Accessor for the number of capabilities supported by the device.
 *
7250 7251 7252 7253 7254 7255
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

7256 7257
    virResetLastError();

7258 7259 7260 7261 7262
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

7263 7264 7265 7266 7267 7268 7269
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
7270 7271

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7272 7273 7274 7275

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295
    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);

7296 7297
    virResetLastError();

7298 7299 7300 7301 7302
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

7303 7304 7305 7306 7307 7308 7309
    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;
    }
7310 7311

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7312 7313 7314 7315

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332
    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);

7333 7334
    virResetLastError();

7335 7336 7337 7338 7339 7340 7341 7342 7343 7344
    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);
}


7345 7346
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
7347
 * @dev: the dev to hold a reference on
7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358
 *
 * 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.
D
Daniel Veillard 已提交
7359 7360
 *
 * Returns 0 in case of success, -1 in case of failure.
7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375
 */
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;
}

7376
/**
D
Daniel Veillard 已提交
7377
 * virNodeDeviceDettach:
7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391
 * @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.
D
Daniel Veillard 已提交
7392 7393
 *
 * Returns 0 in case of success, -1 in case of failure.
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
 */
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.
D
Daniel Veillard 已提交
7435 7436
 *
 * Returns 0 in case of success, -1 in case of failure.
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
 */
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.
D
Daniel Veillard 已提交
7480 7481
 *
 * Returns 0 in case of success, -1 in case of failure.
7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510
 */
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);
}

7511

7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608
/**
 * virNodeDeviceCreateXML:
 * @conn: pointer to the hypervisor connection
 * @xmlDesc: string containing an XML description of the device to be created
 * @flags: callers should always pass 0
 *
 * Create a new device on the VM host machine, for example, virtual
 * HBAs created using vport_create.
 *
 * Returns a node device object if successful, NULL in case of failure
 */
virNodeDevicePtr
virNodeDeviceCreateXML(virConnectPtr conn,
                       const char *xmlDesc,
                       unsigned int flags)
{
    VIR_DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

    virResetLastError();

    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__);
        goto error;
    }

    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->deviceMonitor &&
        conn->deviceMonitor->deviceCreateXML) {
        virNodeDevicePtr dev = conn->deviceMonitor->deviceCreateXML(conn, xmlDesc, flags);
        if (dev == NULL)
            goto error;
        return dev;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/**
 * virNodeDeviceDestroy:
 * @dev: a device object
 *
 * Destroy the device object. The virtual device is removed from the host operating system.
 * This function may require privileged access
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNodeDeviceDestroy(virNodeDevicePtr dev)
{
    DEBUG("dev=%p", dev);

    virResetLastError();

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

    if (dev->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(dev->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
        goto error;
    }

    if (dev->conn->deviceMonitor &&
        dev->conn->deviceMonitor->deviceDestroy) {
        int retval = dev->conn->deviceMonitor->deviceDestroy(dev);
        if (retval < 0) {
            goto error;
        }

        return 0;
    }

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

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


7609 7610 7611 7612 7613 7614 7615 7616 7617
/*
 * 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 已提交
7618
 * @freecb: optional function to deallocate opaque when not used anymore
7619 7620 7621 7622
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
7623 7624 7625 7626 7627 7628 7629
 * 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.
 *
7630 7631 7632 7633 7634
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
7635 7636
                              void *opaque,
                              virFreeCallback freecb)
7637
{
7638 7639
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
7640 7641 7642 7643 7644 7645 7646

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7647
        goto error;
7648 7649
    }

7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661
    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);
7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679
    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)
{
7680 7681 7682
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
7683 7684 7685 7686 7687 7688 7689

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7690 7691 7692 7693 7694 7695 7696 7697
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
7698 7699
    }

7700 7701 7702 7703
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7704 7705
    return -1;
}