libvirt.c 229.0 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;
D
Daniel Veillard 已提交
77 78
static virInterfaceDriverPtr virInterfaceDriverTab[MAX_DRIVERS];
static int virInterfaceDriverTabCount = 0;
79 80
static virStorageDriverPtr virStorageDriverTab[MAX_DRIVERS];
static int virStorageDriverTabCount = 0;
81 82
static virDeviceMonitorPtr virDeviceMonitorTab[MAX_DRIVERS];
static int virDeviceMonitorTabCount = 0;
A
Atsushi SAKAI 已提交
83
#ifdef WITH_LIBVIRTD
84 85
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
A
Atsushi SAKAI 已提交
86
#endif
87 88
static int initialized = 0;

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 120 121
#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

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

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

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

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

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

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

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

        default:
            return -1;
185 186
        }

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

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

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;

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

247 248 249 250 251 252 253 254 255 256 257 258
/**
 * 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)
{
259
    char *debugEnv;
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
    debugEnv = getenv("LIBVIRT_DEBUG");
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
    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);
287 288 289

    DEBUG0("register drivers");

290 291 292 293
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

294 295 296
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

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

330 331 332
    return(0);
}

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
#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
366 367


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

D
Daniel Veillard 已提交
381 382 383
    if (error == VIR_ERR_OK)
        return;

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

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

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

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

D
Daniel Veillard 已提交
425 426 427
    if (error == VIR_ERR_OK)
        return;

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

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

    if (error == VIR_ERR_OK)
        return;

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

D
Daniel Veillard 已提交
462 463 464 465 466 467 468 469 470
/**
 * virLibInterfaceError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
471
virLibInterfaceError(virInterfacePtr iface, virErrorNumber error,
D
Daniel Veillard 已提交
472 473 474 475 476 477 478 479 480 481
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

    errmsg = virErrorMsg(error, info);
    if (error != VIR_ERR_INVALID_INTERFACE) {
482
        conn = iface->conn;
D
Daniel Veillard 已提交
483 484 485 486 487
    }
    virRaiseError(conn, NULL, NULL, VIR_FROM_INTERFACE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

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

506
    errmsg = virErrorMsg(error, info);
507 508 509
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

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

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
517
 * @error: the error number
518 519 520 521 522 523 524 525 526 527 528 529 530 531
 * @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;

532
    errmsg = virErrorMsg(error, info);
533 534 535
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

536 537
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
538 539
}

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * 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);
}

566 567 568 569 570 571 572 573 574 575 576
/**
 * 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)
{
577 578 579 580 581
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
582
        return(-1);
583 584 585
    }

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
586 587
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
588 589
    }

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

593 594
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
595 596
}

D
Daniel Veillard 已提交
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
/**
 * virRegisterInterfaceDriver:
 * @driver: pointer to a interface driver block
 *
 * Register a interface virtualization driver
 *
 * Returns the driver priority or -1 in case of error.
 */
int
virRegisterInterfaceDriver(virInterfaceDriverPtr driver)
{
    if (virInitialize() < 0)
      return -1;

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

    if (virInterfaceDriverTabCount >= MAX_DRIVERS) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }

    DEBUG ("registering %s as interface driver %d",
           driver->name, virInterfaceDriverTabCount);

    virInterfaceDriverTab[virInterfaceDriverTabCount] = driver;
    return virInterfaceDriverTabCount++;
}

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
/**
 * 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) {
648
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
649 650 651
        return(-1);
    }

652 653 654
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

655 656 657 658
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
/**
 * 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);
    }

683 684 685
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

686 687 688 689
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

690 691 692 693 694 695 696 697 698 699 700
/**
 * 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)
{
701 702 703 704 705
    if (virInitialize() < 0)
      return -1;

    if (driver == NULL) {
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
706
        return(-1);
707 708 709
    }

    if (virDriverTabCount >= MAX_DRIVERS) {
710 711
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
712 713
    }

714
    if (driver->no < 0) {
715
        virLibConnError
716 717 718 719 720
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

721 722 723
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

724 725
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
726 727
}

A
Atsushi SAKAI 已提交
728
#ifdef WITH_LIBVIRTD
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
/**
 * 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) {
749
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
750 751 752 753 754 755 756
        return(-1);
    }

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

757 758
/**
 * virStateInitialize:
759
 * @privileged: set to 1 if running with root priviledge, 0 otherwise
760 761 762 763 764
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
765
int virStateInitialize(int privileged) {
766 767 768 769 770 771
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
772
        if (virStateDriverTab[i]->initialize &&
773
            virStateDriverTab[i]->initialize(privileged) < 0)
774 775 776 777 778
            ret = -1;
    }
    return ret;
}

779 780 781 782 783 784 785
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
786
int virStateCleanup(void) {
787 788 789
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
790 791
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
792 793 794 795 796
            ret = -1;
    }
    return ret;
}

797 798 799 800 801 802 803
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
804
int virStateReload(void) {
805 806 807
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
808 809
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
810 811 812 813 814
            ret = -1;
    }
    return ret;
}

815 816 817 818 819 820 821
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
 * Return 0 if none are active, 1 if at least one is.
 */
D
Daniel P. Berrange 已提交
822
int virStateActive(void) {
823 824 825
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
826 827
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
828 829 830 831 832
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
833
#endif
834

835 836


837 838 839
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
840
 * @type: the type of connection/driver looked at
841 842 843 844 845
 * @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 已提交
846
 * @type is unknown or not available, an error code will be returned and
847 848 849 850 851 852
 * @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
853 854 855
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
856
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
857

858
    if (!initialized)
859
        if (virInitialize() < 0)
860
            return -1;
861

862
    if (libVer == NULL)
863
        return (-1);
864 865 866
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
867
        if (type == NULL)
868
            type = "Xen";
869 870 871 872 873

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

876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
#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
896 897 898 899
#if WITH_VBOX
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
900 901 902 903
#if WITH_UML
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
D
Daniel Veillard 已提交
904 905 906 907
#if WITH_ONE
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
908 909 910 911 912
#if WITH_REMOTE
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
#endif
        if (*typeVer == 0) {
913
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
914 915
            return (-1);
        }
916
#endif /* WITH_DRIVER_MODULES */
917 918
    }
    return (0);
919 920
}

921
static virConnectPtr
922 923 924
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
925
{
926
    int i, res;
927 928
    virConnectPtr ret;

929 930
    virResetLastError();

931 932 933
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
934

935 936 937 938 939 940 941 942
    /*
     *  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) {
943
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
944 945
            name = defname;
        } else {
946
            name = NULL;
947
        }
948
    }
949

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
    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;
        }
967

968 969 970 971 972 973 974 975 976
        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,
977 978 979 980
              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));
981 982
    } else {
        DEBUG0("no name, allowing driver auto-select");
983 984
    }

985 986 987
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

988
    for (i = 0; i < virDriverTabCount; i++) {
989 990
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
991
        res = virDriverTab[i]->open (ret, auth, flags);
992 993 994 995 996
        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")));
997 998 999 1000 1001
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1002 1003
    }

1004
    if (!ret->driver) {
1005 1006
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
1007
        goto failed;
1008 1009
    }

1010
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1011
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1012 1013 1014 1015 1016
        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")));
1017
        if (res == VIR_DRV_OPEN_ERROR) {
1018
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
1019
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
1020 1021
                                   "Is the daemon running ?");
            }
1022 1023
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1024 1025 1026
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1027
    }
1028

D
Daniel Veillard 已提交
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
    for (i = 0; i < virInterfaceDriverTabCount; i++) {
        res = virInterfaceDriverTab[i]->open (ret, auth, flags);
        DEBUG("interface driver %d %s returned %s",
              i, virInterfaceDriverTab[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(virInterfaceDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_INTERFACE,
                                   "Is the daemon running ?");
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->interfaceDriver = virInterfaceDriverTab[i];
            break;
        }
    }
1047 1048 1049

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1050
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
        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")));
        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;
        }
    }

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
    /* 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;
1082 1083
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1095
    return ret;
1096 1097

failed:
1098
    if (ret->driver) ret->driver->close (ret);
1099

1100 1101
    /* Ensure a global error is set in case driver forgot */
    virSetGlobalError();
1102 1103 1104

    virUnrefConnect(ret);

1105
    return NULL;
1106 1107
}

1108 1109
/**
 * virConnectOpen:
1110
 * @name: URI of the hypervisor
1111
 *
1112
 * This function should be called first to get a connection to the
1113 1114 1115
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1116
 *
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
 * If @name is NULL then probing will be done to determine a suitable
 * default driver to activate. This involves trying each hypervisor
 * in turn until one successfully opens. If the LIBVIRT_DEFAULT_URI
 * environment variable is set, then it will be used in preference
 * to probing for a driver.
 *
 * If connecting to an unprivileged hypervisor driver which requires
 * the libvirtd daemon to be active, it will automatically be launched
 * if not already running. This can be prevented by setting the
 * environment variable LIBVIRT_AUTOSTART=0
 *
1128
 * URIs are documented at http://libvirt.org/uri.html
1129 1130 1131 1132
 */
virConnectPtr
virConnectOpen (const char *name)
{
1133 1134 1135 1136
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1137
    DEBUG("name=%s", name);
1138
    return do_open (name, NULL, 0);
1139 1140
}

1141
/**
1142
 * virConnectOpenReadOnly:
1143
 * @name: URI of the hypervisor
1144
 *
1145
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1146
 * library functionalities. The set of APIs usable are then restricted
1147
 * on the available methods to control the domains.
1148
 *
1149 1150 1151
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1152
 * Returns a pointer to the hypervisor connection or NULL in case of error
1153 1154
 *
 * URIs are documented at http://libvirt.org/uri.html
1155
 */
1156
virConnectPtr
1157 1158
virConnectOpenReadOnly(const char *name)
{
1159 1160 1161 1162
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1163
    DEBUG("name=%s", name);
1164 1165 1166 1167 1168 1169 1170 1171 1172
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1173
 * This function should be called first to get a connection to the
1174
 * Hypervisor. If necessary, authentication will be performed fetching
1175 1176
 * credentials via the callback
 *
1177 1178 1179
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1180 1181 1182 1183 1184 1185 1186 1187 1188
 * 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)
{
1189 1190 1191 1192
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1193
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1194
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1195 1196 1197
}

/**
1198
 * virConnectClose:
D
Daniel Veillard 已提交
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
 * @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
1209 1210
virConnectClose(virConnectPtr conn)
{
1211 1212
    DEBUG("conn=%p", conn);

1213 1214 1215 1216
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1217
        return (-1);
1218
    }
1219 1220 1221

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
D
Daniel Veillard 已提交
1222 1223
    if (conn->interfaceDriver)
        conn->interfaceDriver->close (conn);
1224 1225
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1226 1227
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1228
    conn->driver->close (conn);
1229

1230
    if (virUnrefConnect(conn) < 0)
1231
        return (-1);
1232
    return (0);
D
Daniel Veillard 已提交
1233 1234
}

1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
/**
 * 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 已提交
1249 1250
 *
 * Returns 0 in case of success, -1 in case of failure
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
 */
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 已提交
1266 1267
/*
 * Not for public use.  This function is part of the internal
1268 1269 1270
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1271
virDrvSupportsFeature (virConnectPtr conn, int feature)
1272
{
1273
    int ret;
1274 1275
    DEBUG("conn=%p, feature=%d", conn, feature);

1276 1277 1278 1279
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1280
        return (-1);
1281
    }
1282

1283 1284 1285 1286
    ret = VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return ret;
1287 1288
}

1289 1290 1291 1292 1293 1294 1295
/**
 * 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.
1296 1297 1298
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1299 1300
 */
const char *
1301 1302
virConnectGetType(virConnectPtr conn)
{
1303
    const char *ret;
1304
    DEBUG("conn=%p", conn);
1305

1306 1307
    virResetLastError();

D
Daniel Veillard 已提交
1308
    if (!VIR_IS_CONNECT(conn)) {
1309
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1310
        return (NULL);
D
Daniel Veillard 已提交
1311
    }
1312 1313 1314 1315

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1316
    }
1317
    return conn->driver->name;
1318 1319
}

D
Daniel Veillard 已提交
1320
/**
1321
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1322
 * @conn: pointer to the hypervisor connection
1323
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1324
 *
1325
 * Get the version level of the Hypervisor running. This may work only with
1326
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1327
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1328
 *
1329 1330 1331
 * 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 已提交
1332
 */
1333
int
1334 1335
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1336 1337
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

1338 1339
    virResetLastError();

D
Daniel Veillard 已提交
1340
    if (!VIR_IS_CONNECT(conn)) {
1341
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1342
        return -1;
D
Daniel Veillard 已提交
1343
    }
1344

D
Daniel Veillard 已提交
1345 1346
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1347
        goto error;
D
Daniel Veillard 已提交
1348
    }
1349

1350 1351 1352 1353 1354 1355
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1356

1357
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1358 1359 1360 1361

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

1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
/**
 * 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)
{
1380 1381
    DEBUG("conn=%p", conn);

1382 1383
    virResetLastError();

1384
    if (!VIR_IS_CONNECT(conn)) {
1385
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1386 1387 1388
        return NULL;
    }

1389 1390 1391 1392 1393 1394
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1395 1396

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1397 1398 1399 1400

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
    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)
{
1422
    char *name;
1423 1424
    DEBUG("conn=%p", conn);

1425 1426
    virResetLastError();

1427
    if (!VIR_IS_CONNECT(conn)) {
1428
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1429 1430 1431
        return NULL;
    }

1432
    name = (char *)xmlSaveUri(conn->uri);
1433
    if (!name) {
1434
        virReportOOMError (conn);
1435
        goto error;
1436 1437
    }
    return name;
1438 1439 1440 1441 1442

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

1445 1446 1447 1448 1449
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1450
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1451 1452 1453 1454 1455 1456 1457 1458 1459
 * 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)
{
1460 1461
    DEBUG("conn=%p, type=%s", conn, type);

1462 1463
    virResetLastError();

1464
    if (!VIR_IS_CONNECT(conn)) {
1465
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1466
        return -1;
1467 1468
    }

1469 1470 1471 1472 1473 1474
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1475

1476
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1477 1478 1479
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1480
    return -1;
1481 1482
}

1483
/**
1484
 * virConnectListDomains:
1485 1486 1487 1488 1489 1490 1491 1492 1493
 * @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
1494 1495
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1496 1497
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1498 1499
    virResetLastError();

D
Daniel Veillard 已提交
1500
    if (!VIR_IS_CONNECT(conn)) {
1501
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1502
        return -1;
D
Daniel Veillard 已提交
1503
    }
1504

1505
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1506
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1507
        goto error;
D
Daniel Veillard 已提交
1508
    }
1509

1510 1511 1512 1513 1514 1515
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1516

1517
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1518 1519 1520
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1521
    return -1;
D
Daniel Veillard 已提交
1522 1523
}

K
 
Karel Zak 已提交
1524 1525 1526 1527
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1528 1529
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1530 1531 1532
 * Returns the number of domain found or -1 in case of error
 */
int
1533 1534
virConnectNumOfDomains(virConnectPtr conn)
{
1535 1536
    DEBUG("conn=%p", conn);

1537 1538
    virResetLastError();

D
Daniel Veillard 已提交
1539
    if (!VIR_IS_CONNECT(conn)) {
1540
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1541
        goto error;
D
Daniel Veillard 已提交
1542
    }
K
Karel Zak 已提交
1543

1544 1545 1546 1547 1548 1549
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1550

1551
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1552 1553 1554
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1555
    return -1;
K
 
Karel Zak 已提交
1556 1557
}

1558 1559 1560 1561
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1562
 * Provides the connection pointer associated with a domain.  The
1563 1564 1565
 * reference counter on the connection is not increased by this
 * call.
 *
1566 1567 1568 1569
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1570 1571 1572 1573 1574
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1575 1576
    DEBUG("dom=%p", dom);

1577 1578 1579
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1580
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1581 1582 1583 1584 1585
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1586
/**
1587
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1588
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1589
 * @xmlDesc: string containing an XML description of the domain
1590
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1591
 *
1592
 * Launch a new guest domain, based on an XML description similar
1593
 * to the one returned by virDomainGetXMLDesc()
1594
 * This function may requires privileged access to the hypervisor.
1595 1596 1597
 * 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).
1598
 *
D
Daniel Veillard 已提交
1599 1600
 * Returns a new domain object or NULL in case of failure
 */
1601
virDomainPtr
1602 1603
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1604
{
1605 1606
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

1607 1608
    virResetLastError();

D
Daniel Veillard 已提交
1609
    if (!VIR_IS_CONNECT(conn)) {
1610
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1611
        return (NULL);
D
Daniel Veillard 已提交
1612 1613 1614
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1615
        goto error;
D
Daniel Veillard 已提交
1616
    }
1617 1618
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1619
        goto error;
1620
    }
D
Daniel Veillard 已提交
1621

1622 1623 1624 1625 1626 1627 1628
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1629 1630

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1631 1632 1633
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1634
    return NULL;
D
Daniel Veillard 已提交
1635 1636
}

1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
/**
 * 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));
}
1655

1656
/**
1657
 * virDomainLookupByID:
1658 1659 1660 1661
 * @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 已提交
1662 1663
 * 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.
1664
 *
1665 1666
 * 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.
1667
 */
1668
virDomainPtr
1669 1670
virDomainLookupByID(virConnectPtr conn, int id)
{
1671 1672
    DEBUG("conn=%p, id=%d", conn, id);

1673 1674
    virResetLastError();

D
Daniel Veillard 已提交
1675
    if (!VIR_IS_CONNECT(conn)) {
1676
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1677
        return (NULL);
D
Daniel Veillard 已提交
1678 1679 1680
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1681
        goto error;
D
Daniel Veillard 已提交
1682
    }
1683

1684 1685 1686 1687 1688 1689 1690
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1691

1692
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1693 1694 1695 1696

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1697
    return NULL;
1698 1699 1700 1701 1702
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1703
 * @uuid: the raw UUID for the domain
1704 1705 1706
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1707 1708
 * 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.
1709 1710
 */
virDomainPtr
1711 1712
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1713 1714
    DEBUG("conn=%p, uuid=%s", conn, uuid);

1715 1716
    virResetLastError();

D
Daniel Veillard 已提交
1717
    if (!VIR_IS_CONNECT(conn)) {
1718
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1719
        return (NULL);
D
Daniel Veillard 已提交
1720 1721 1722
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1723
        goto error;
D
Daniel Veillard 已提交
1724
    }
1725

1726 1727 1728 1729 1730 1731 1732
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1733

1734
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1735 1736 1737 1738

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

K
Karel Zak 已提交
1742 1743 1744 1745 1746 1747 1748
/**
 * 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.
 *
1749 1750
 * 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 已提交
1751 1752 1753 1754
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1755 1756
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1757 1758
    int ret;

1759 1760
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1761 1762
    virResetLastError();

K
Karel Zak 已提交
1763
    if (!VIR_IS_CONNECT(conn)) {
1764
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1765 1766 1767 1768
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1769
        goto error;
K
Karel Zak 已提交
1770
    }
1771 1772
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
     */
    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);
1784

1785
    if (ret!=VIR_UUID_BUFLEN) {
1786
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1787
        goto error;
K
Karel Zak 已提交
1788
    }
1789
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1790
        uuid[i] = raw[i] & 0xFF;
1791

K
Karel Zak 已提交
1792
    return virDomainLookupByUUID(conn, &uuid[0]);
1793 1794 1795 1796 1797

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

1800 1801 1802 1803 1804
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1805
 * Try to lookup a domain on the given hypervisor based on its name.
1806
 *
1807 1808
 * 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.
1809 1810
 */
virDomainPtr
1811 1812
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1813 1814
    DEBUG("conn=%p, name=%s", conn, name);

1815 1816
    virResetLastError();

D
Daniel Veillard 已提交
1817
    if (!VIR_IS_CONNECT(conn)) {
1818
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1819
        return (NULL);
D
Daniel Veillard 已提交
1820 1821 1822
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1823
        goto error;
D
Daniel Veillard 已提交
1824
    }
1825

1826 1827 1828 1829 1830 1831 1832
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
1833 1834

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1835 1836 1837 1838

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

D
Daniel Veillard 已提交
1842
/**
1843
 * virDomainDestroy:
D
Daniel Veillard 已提交
1844 1845 1846
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1847 1848 1849
 * 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 已提交
1850 1851
 *
 * Returns 0 in case of success and -1 in case of failure.
1852
 */
D
Daniel Veillard 已提交
1853
int
1854 1855
virDomainDestroy(virDomainPtr domain)
{
1856
    virConnectPtr conn;
1857

1858 1859
    DEBUG("domain=%p", domain);

1860 1861
    virResetLastError();

D
Daniel Veillard 已提交
1862
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1863
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1864
        return (-1);
D
Daniel Veillard 已提交
1865
    }
1866

1867
    conn = domain->conn;
1868 1869
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1870
        goto error;
1871
    }
1872

1873 1874 1875 1876 1877 1878 1879
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1880

1881
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1882 1883 1884 1885

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1886
    return -1;
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
}

/**
 * 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
1899 1900
virDomainFree(virDomainPtr domain)
{
1901 1902
    DEBUG("domain=%p", domain);

1903 1904 1905
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1906
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1907
        return (-1);
D
Daniel Veillard 已提交
1908
    }
1909
    if (virUnrefDomain(domain) < 0)
1910
        return -1;
1911
    return(0);
D
Daniel Veillard 已提交
1912 1913
}

1914 1915
/**
 * virDomainRef:
D
Daniel Veillard 已提交
1916
 * @domain: the domain to hold a reference on
1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
 *
 * 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 已提交
1928 1929
 *
 * Returns 0 in case of success and -1 in case of failure.
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945
 */
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 已提交
1946
/**
1947
 * virDomainSuspend:
D
Daniel Veillard 已提交
1948 1949 1950
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1951
 * to CPU resources and I/O but the memory used by the domain at the
1952
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1953
 * the domain.
1954
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1955 1956 1957 1958
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1959 1960
virDomainSuspend(virDomainPtr domain)
{
1961
    virConnectPtr conn;
1962
    DEBUG("domain=%p", domain);
1963

1964 1965
    virResetLastError();

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

1975 1976
    conn = domain->conn;

1977 1978 1979 1980 1981 1982 1983
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1984

1985
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1986 1987 1988 1989

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

/**
1994
 * virDomainResume:
D
Daniel Veillard 已提交
1995 1996 1997
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
1998
 * it was frozen by calling virSuspendDomain().
1999
 * This function may requires privileged access
D
Daniel Veillard 已提交
2000 2001 2002 2003
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2004 2005
virDomainResume(virDomainPtr domain)
{
2006
    virConnectPtr conn;
2007
    DEBUG("domain=%p", domain);
2008

2009 2010
    virResetLastError();

D
Daniel Veillard 已提交
2011
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2012
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2013
        return (-1);
D
Daniel Veillard 已提交
2014
    }
2015 2016
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2017
        goto error;
2018
    }
D
Daniel Veillard 已提交
2019

2020 2021
    conn = domain->conn;

2022 2023 2024 2025 2026 2027 2028
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2029

2030
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2031 2032 2033 2034

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

2038 2039 2040 2041 2042 2043
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2044 2045 2046
 * 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.
2047 2048 2049 2050
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2051 2052
virDomainSave(virDomainPtr domain, const char *to)
{
2053
    char filepath[4096];
2054
    virConnectPtr conn;
2055
    DEBUG("domain=%p, to=%s", domain, to);
2056

2057 2058
    virResetLastError();

D
Daniel Veillard 已提交
2059
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2060
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2061
        return (-1);
D
Daniel Veillard 已提交
2062
    }
2063 2064
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2065
        goto error;
2066
    }
2067
    conn = domain->conn;
D
Daniel Veillard 已提交
2068 2069
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2070
        goto error;
D
Daniel Veillard 已提交
2071
    }
2072

2073 2074 2075 2076 2077
    /*
     * 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] != '/') {
2078
        unsigned int len, t;
2079

2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
        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];
2090 2091 2092

    }

2093 2094 2095 2096 2097 2098 2099
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2100

2101
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2102 2103 2104 2105

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2106
    return -1;
2107 2108 2109 2110
}

/**
 * virDomainRestore:
2111
 * @conn: pointer to the hypervisor connection
2112
 * @from: path to the
2113 2114 2115 2116 2117 2118
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2119 2120
virDomainRestore(virConnectPtr conn, const char *from)
{
2121
    char filepath[4096];
2122
    DEBUG("conn=%p, from=%s", conn, from);
2123

2124 2125
    virResetLastError();

D
Daniel Veillard 已提交
2126
    if (!VIR_IS_CONNECT(conn)) {
2127
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2128
        return (-1);
D
Daniel Veillard 已提交
2129
    }
2130 2131
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2132
        goto error;
2133
    }
D
Daniel Veillard 已提交
2134 2135
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2136
        goto error;
D
Daniel Veillard 已提交
2137 2138
    }

2139 2140 2141 2142 2143
    /*
     * 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] != '/') {
2144 2145 2146
        unsigned int len, t;

        t = strlen(from);
2147 2148 2149 2150 2151
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2152 2153
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2154 2155 2156 2157 2158
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2159 2160 2161 2162 2163
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2164 2165 2166 2167 2168 2169 2170
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2171

2172
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2173 2174 2175 2176

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
2177
    return -1;
D
Daniel Veillard 已提交
2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196
}

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

2199 2200
    virResetLastError();

D
Daniel Veillard 已提交
2201
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2202
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
2203 2204 2205 2206
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2207
        goto error;
D
Daniel Veillard 已提交
2208 2209 2210 2211
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2212
        goto error;
D
Daniel Veillard 已提交
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
    }

    /*
     * 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);
2223 2224 2225 2226 2227
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibDomainError(domain, VIR_ERR_SYSTEM_ERROR,
                              _("cannot get current directory"));
            goto error;
        }
D
Daniel Veillard 已提交
2228 2229
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2230 2231 2232 2233 2234
        if (len > sizeof(filepath) - (t + 3)) {
            virLibDomainError(domain, VIR_ERR_INTERNAL_ERROR,
                              _("path too long"));
            goto error;
        }
D
Daniel Veillard 已提交
2235 2236 2237 2238 2239 2240
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

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

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

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

2257 2258 2259 2260 2261
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2262 2263
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2264 2265 2266 2267 2268 2269 2270
 *
 * 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
2271 2272
virDomainShutdown(virDomainPtr domain)
{
2273
    virConnectPtr conn;
2274
    DEBUG("domain=%p", domain);
2275

2276 2277
    virResetLastError();

D
Daniel Veillard 已提交
2278
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2279
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2280
        return (-1);
D
Daniel Veillard 已提交
2281
    }
2282 2283
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2284
        goto error;
2285
    }
2286

2287 2288
    conn = domain->conn;

2289 2290 2291 2292 2293 2294 2295
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2296

2297
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2298 2299 2300 2301

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

2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
/**
 * 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)
{
2319
    virConnectPtr conn;
2320
    DEBUG("domain=%p, flags=%u", domain, flags);
2321

2322 2323
    virResetLastError();

2324
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2325
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2326 2327
        return (-1);
    }
2328 2329
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2330
        goto error;
2331
    }
2332

2333 2334
    conn = domain->conn;

2335 2336 2337 2338 2339 2340 2341
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2342

2343
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2344 2345 2346 2347

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

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

2365 2366
    virResetLastError();

D
Daniel Veillard 已提交
2367
    if (!VIR_IS_DOMAIN(domain)) {
2368
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2369
        return (NULL);
D
Daniel Veillard 已提交
2370
    }
2371
    return (domain->name);
2372 2373
}

2374 2375 2376
/**
 * virDomainGetUUID:
 * @domain: a domain object
2377
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2378 2379 2380 2381 2382 2383
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2384 2385
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2386 2387
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2388 2389
    virResetLastError();

D
Daniel Veillard 已提交
2390
    if (!VIR_IS_DOMAIN(domain)) {
2391
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2392
        return (-1);
D
Daniel Veillard 已提交
2393 2394 2395
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2396 2397
        /* Copy to connection error object for back compatability */
        virSetConnError(domain->conn);
2398
        return (-1);
D
Daniel Veillard 已提交
2399 2400
    }

2401 2402
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2403
    return (0);
2404 2405
}

K
Karel Zak 已提交
2406 2407 2408
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2409
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2410
 *
2411
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2412 2413 2414 2415 2416 2417 2418
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2419
    unsigned char uuid[VIR_UUID_BUFLEN];
2420
    DEBUG("domain=%p, buf=%p", domain, buf);
2421

2422 2423
    virResetLastError();

K
Karel Zak 已提交
2424
    if (!VIR_IS_DOMAIN(domain)) {
2425
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
2426 2427 2428 2429
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2430
        goto error;
K
Karel Zak 已提交
2431
    }
2432

K
Karel Zak 已提交
2433
    if (virDomainGetUUID(domain, &uuid[0]))
2434
        goto error;
K
Karel Zak 已提交
2435

2436
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2437
    return (0);
2438 2439 2440 2441 2442

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

2445
/**
2446
 * virDomainGetID:
2447 2448 2449 2450 2451 2452 2453
 * @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
2454 2455
virDomainGetID(virDomainPtr domain)
{
2456 2457
    DEBUG("domain=%p", domain);

2458 2459
    virResetLastError();

D
Daniel Veillard 已提交
2460
    if (!VIR_IS_DOMAIN(domain)) {
2461
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2462
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2463
    }
2464
    return (domain->id);
2465 2466
}

2467 2468 2469 2470 2471 2472
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2473 2474
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2475 2476
 */
char *
2477 2478
virDomainGetOSType(virDomainPtr domain)
{
2479
    virConnectPtr conn;
2480
    DEBUG("domain=%p", domain);
2481

2482 2483 2484
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2485
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2486
        return (NULL);
D
Daniel Veillard 已提交
2487
    }
2488

2489 2490
    conn = domain->conn;

2491 2492 2493 2494 2495 2496 2497
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2498

2499
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2500 2501 2502 2503

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

2507
/**
2508
 * virDomainGetMaxMemory:
2509
 * @domain: a domain object or NULL
2510
 *
2511 2512 2513 2514 2515 2516 2517
 * 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
2518 2519
virDomainGetMaxMemory(virDomainPtr domain)
{
2520
    virConnectPtr conn;
2521
    DEBUG("domain=%p", domain);
2522

2523 2524
    virResetLastError();

D
Daniel Veillard 已提交
2525
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2526
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2527
        return (0);
D
Daniel Veillard 已提交
2528
    }
2529

2530 2531
    conn = domain->conn;

2532 2533 2534 2535 2536 2537 2538
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2539

2540
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2541 2542 2543 2544

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2545
    return 0;
2546 2547
}

D
Daniel Veillard 已提交
2548
/**
2549
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2550 2551
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2552
 *
D
Daniel Veillard 已提交
2553 2554 2555
 * 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.
2556
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2557 2558 2559 2560
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2561 2562
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2563
    virConnectPtr conn;
2564
    DEBUG("domain=%p, memory=%lu", domain, memory);
2565

2566 2567
    virResetLastError();

2568
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2569
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2570
        return (-1);
2571
    }
2572 2573
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2574
        goto error;
2575 2576 2577
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2578
        goto error;
2579
    }
2580
    conn = domain->conn;
2581

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

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

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

2598 2599 2600 2601
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2602
 *
2603 2604 2605
 * 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.
2606
 * This function may requires privileged access to the hypervisor.
2607 2608 2609 2610 2611 2612 2613
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2614
    DEBUG("domain=%p, memory=%lu", domain, memory);
2615

2616 2617
    virResetLastError();

2618
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2619
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2620
        return (-1);
2621
    }
2622 2623
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2624
        goto error;
2625 2626 2627
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2628
        goto error;
2629 2630 2631
    }

    conn = domain->conn;
2632

2633 2634 2635 2636 2637 2638 2639
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2640

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

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

2649 2650
/**
 * virDomainGetInfo:
2651
 * @domain: a domain object
2652
 * @info: pointer to a virDomainInfo structure allocated by the user
2653
 *
2654
 * Extract information about a domain. Note that if the connection
2655
 * used to get the domain is limited only a partial set of the information
2656 2657 2658 2659 2660
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2661 2662
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2663
    virConnectPtr conn;
2664
    DEBUG("domain=%p, info=%p", domain, info);
2665

2666 2667
    virResetLastError();

D
Daniel Veillard 已提交
2668
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2669
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2670
        return (-1);
D
Daniel Veillard 已提交
2671 2672 2673
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2674
        goto error;
D
Daniel Veillard 已提交
2675
    }
2676

2677
    memset(info, 0, sizeof(virDomainInfo));
2678

2679 2680
    conn = domain->conn;

2681 2682 2683 2684 2685 2686 2687
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2688

2689
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2690 2691 2692 2693

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

2697 2698 2699
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2700
 * @flags: an OR'ed set of virDomainXMLFlags
2701 2702
 *
 * Provide an XML description of the domain. The description may be reused
2703
 * later to relaunch the domain with virDomainCreateXML().
2704 2705 2706 2707 2708
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2709 2710
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2711
    virConnectPtr conn;
2712
    DEBUG("domain=%p, flags=%d", domain, flags);
2713

2714 2715 2716
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2717
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2718
        return (NULL);
D
Daniel Veillard 已提交
2719
    }
2720

2721 2722
    conn = domain->conn;

2723 2724 2725 2726 2727 2728
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

2729 2730 2731 2732 2733 2734 2735
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
2736

2737
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2738 2739 2740 2741

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

2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849
/**
 * virConnectDomainXMLFromNative:
 * @conn: a connection object
 * @nativeFormat: configuration format importing from
 * @nativeConfig: the configuration data to import
 * @flags: currently unused, pass 0
 *
 * Reads native configuration data  describing a domain, and
 * generates libvirt domain XML. The format of the native
 * data is hypervisor dependant.
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *virConnectDomainXMLFromNative(virConnectPtr conn,
                                    const char *nativeFormat,
                                    const char *nativeConfig,
                                    unsigned int flags)
{
    DEBUG("conn=%p, format=%s config=%s flags=%u", conn, nativeFormat, nativeConfig, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

    if (nativeFormat == NULL || nativeConfig == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->driver->domainXMLFromNative) {
        char *ret;
        ret = conn->driver->domainXMLFromNative (conn,
                                                 nativeFormat,
                                                 nativeConfig,
                                                 flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virConnectDomainXMLToNative:
 * @conn: a connection object
 * @nativeFormat: configuration format exporting to
 * @domainXml: the domain configuration to export
 * @flags: currently unused, pass 0
 *
 * Reads a domain XML configuration document, and generates
 * generates a native configuration file describing the domain.
 * The format of the native data is hypervisor dependant.
 *
 * Returns a 0 terminated UTF-8 encoded native config datafile, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *virConnectDomainXMLToNative(virConnectPtr conn,
                                  const char *nativeFormat,
                                  const char *domainXml,
                                  unsigned int flags)
{
    DEBUG("conn=%p, format=%s xml=%s flags=%u", conn, nativeFormat, domainXml, flags);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

    if (nativeFormat == NULL || domainXml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return (NULL);
    }

    if (conn->driver->domainXMLToNative) {
        char *ret;
        ret = conn->driver->domainXMLToNative(conn,
                                              nativeFormat,
                                              domainXml,
                                              flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
/**
 * 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 已提交
2910 2911
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2912
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
2913
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
2914

2915 2916 2917
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2918
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2919 2920 2921 2922 2923
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
2924
        goto error;
2925 2926
    }

2927 2928
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2929
        goto error;
2930 2931 2932 2933
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, delibrately report error against source object, not dest here */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2934
        goto error;
2935 2936
    }

2937
    /* Check that migration is supported by both drivers. */
D
Daniel Veillard 已提交
2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948
    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 {
2949
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2950
        goto error;
2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963
    }

    /* 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 已提交
2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
    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);
2977
    }
D
Daniel Veillard 已提交
2978 2979 2980 2981 2982 2983 2984
    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__);
2985
            goto error;
D
Daniel Veillard 已提交
2986 2987 2988
        }
        dom_xml = conn->driver->domainDumpXML (domain,
                                               VIR_DOMAIN_XML_SECURE);
2989

D
Daniel Veillard 已提交
2990
        if (!dom_xml)
2991
            goto error;
D
Daniel Veillard 已提交
2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006

        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);
    }
3007 3008 3009 3010 3011 3012 3013

    /* 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 已提交
3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035
    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);
    }
3036 3037

 done:
3038 3039
    free (uri_out);
    free (cookie);
3040
    return ddomain;
3041 3042 3043 3044 3045

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

D
Daniel Veillard 已提交
3048 3049
/*
 * Not for public use.  This function is part of the internal
3050 3051 3052
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3053
virDomainMigratePrepare (virConnectPtr dconn,
3054 3055 3056 3057 3058 3059 3060 3061
                           char **cookie,
                           int *cookielen,
                           const char *uri_in,
                           char **uri_out,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
J
John Levon 已提交
3062 3063 3064
    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);
3065

3066 3067
    virResetLastError();

3068
    if (!VIR_IS_CONNECT (dconn)) {
3069
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3070 3071 3072
        return -1;
    }

3073 3074
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3075
        goto error;
3076 3077
    }

3078 3079 3080 3081 3082 3083 3084 3085 3086
    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;
    }
3087 3088

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3089 3090 3091 3092

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3093 3094 3095
    return -1;
}

D
Daniel Veillard 已提交
3096 3097
/*
 * Not for public use.  This function is part of the internal
3098 3099 3100
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3101
virDomainMigratePerform (virDomainPtr domain,
3102 3103 3104 3105 3106 3107 3108 3109
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
J
John Levon 已提交
3110 3111 3112
    VIR_DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, "
              "dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags,
              NULLSTR(dname), bandwidth);
3113

3114 3115 3116
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3117
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3118 3119 3120 3121
        return -1;
    }
    conn = domain->conn;

3122 3123
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3124
        goto error;
3125 3126
    }

3127 3128 3129 3130 3131 3132 3133 3134 3135
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3136 3137

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3138 3139 3140 3141

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

D
Daniel Veillard 已提交
3145 3146
/*
 * Not for public use.  This function is part of the internal
3147 3148 3149
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3150
virDomainMigrateFinish (virConnectPtr dconn,
3151 3152 3153 3154 3155 3156
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3157 3158 3159
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3160

3161 3162
    virResetLastError();

3163
    if (!VIR_IS_CONNECT (dconn)) {
3164
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3165 3166 3167
        return NULL;
    }

3168 3169
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3170
        goto error;
3171 3172
    }

3173 3174 3175 3176 3177 3178 3179 3180 3181
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3182 3183

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3184 3185 3186 3187

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3188
    return NULL;
D
Daniel Veillard 已提交
3189 3190 3191
}


D
Daniel Veillard 已提交
3192 3193
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3194 3195 3196
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3197 3198 3199 3200 3201 3202 3203 3204 3205
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 已提交
3206
{
J
John Levon 已提交
3207 3208 3209 3210
    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 已提交
3211

3212 3213
    virResetLastError();

D
Daniel Veillard 已提交
3214 3215 3216 3217 3218
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

3219 3220
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3221
        goto error;
3222 3223
    }

3224 3225 3226 3227 3228 3229 3230 3231 3232 3233
    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 已提交
3234 3235

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3236 3237 3238 3239

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

D
Daniel Veillard 已提交
3243 3244
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3245 3246 3247
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3248 3249 3250 3251 3252 3253 3254
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3255
{
J
John Levon 已提交
3256 3257 3258
    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 已提交
3259

3260 3261
    virResetLastError();

D
Daniel Veillard 已提交
3262 3263 3264 3265 3266
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3267 3268
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3269
        goto error;
3270 3271
    }

3272 3273 3274 3275 3276 3277 3278 3279 3280 3281
    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 已提交
3282 3283

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3284 3285 3286 3287

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3288
    return NULL;
3289 3290 3291
}


3292 3293 3294 3295
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3296
 *
3297 3298 3299 3300 3301
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3302 3303
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3304 3305
    DEBUG("conn=%p, info=%p", conn, info);

3306 3307
    virResetLastError();

3308
    if (!VIR_IS_CONNECT(conn)) {
3309
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3310 3311 3312 3313
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3314
        goto error;
3315 3316
    }

3317 3318 3319 3320 3321 3322 3323
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3324

3325
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3326 3327 3328 3329

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

3333 3334 3335 3336 3337 3338
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
3339 3340
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
3341 3342 3343 3344 3345
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
3346 3347
    DEBUG("conn=%p", conn);

3348 3349
    virResetLastError();

3350
    if (!VIR_IS_CONNECT (conn)) {
3351
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3352 3353 3354
        return NULL;
    }

3355 3356 3357 3358 3359 3360 3361
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3362

3363
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3364 3365 3366 3367

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

3371 3372 3373
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
3374
 *
D
Daniel Veillard 已提交
3375
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
3376 3377
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
3378
 *
D
Daniel Veillard 已提交
3379
 * Returns the available free memory in bytes or 0 in case of error
3380 3381 3382 3383
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
3384 3385
    DEBUG("conn=%p", conn);

3386 3387
    virResetLastError();

3388 3389 3390 3391 3392
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3393 3394 3395 3396 3397 3398 3399
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3400 3401

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3402 3403 3404 3405

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3406 3407 3408
    return 0;
}

3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422
/**
 * 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;
3423
    DEBUG("domain=%p, nparams=%p", domain, nparams);
3424

3425 3426
    virResetLastError();

3427
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3428
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3429 3430 3431 3432 3433 3434
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3435 3436
        if (!schedtype)
            goto error;
3437 3438 3439
        return schedtype;
    }

3440
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3441 3442 3443 3444

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464
    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,
3465
                                virSchedParameterPtr params, int *nparams)
3466 3467
{
    virConnectPtr conn;
3468
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
3469

3470 3471
    virResetLastError();

3472
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3473
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3474 3475 3476 3477
        return -1;
    }
    conn = domain->conn;

3478 3479 3480 3481 3482 3483 3484
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3485

3486
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3487 3488 3489 3490

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506
    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
3507
virDomainSetSchedulerParameters(virDomainPtr domain,
3508
                                virSchedParameterPtr params, int nparams)
3509 3510
{
    virConnectPtr conn;
3511
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
3512

3513 3514
    virResetLastError();

3515
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3516
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3517 3518
        return -1;
    }
3519 3520
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3521
        goto error;
3522
    }
3523 3524
    conn = domain->conn;

3525 3526 3527 3528 3529 3530 3531
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3532

3533
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3534 3535 3536 3537

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3538 3539 3540 3541
    return -1;
}


3542
/**
3543
 * virDomainBlockStats:
3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
 * @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);

3573 3574
    virResetLastError();

3575
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3576
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3577 3578
        return -1;
    }
3579 3580 3581 3582
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3583 3584 3585 3586
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3587
            goto error;
3588 3589 3590 3591 3592 3593

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3594 3595 3596 3597

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3598 3599 3600 3601
    return -1;
}

/**
3602
 * virDomainInterfaceStats:
3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630
 * @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);

3631 3632
    virResetLastError();

3633
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3634
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3635 3636
        return -1;
    }
3637 3638 3639 3640
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3641 3642 3643 3644
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3645
            goto error;
3646 3647 3648 3649 3650 3651

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3652 3653 3654 3655

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

R
Richard W.M. Jones 已提交
3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691
/**
 * 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 已提交
3692 3693 3694 3695
 * 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 已提交
3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709
 * 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);

3710 3711
    virResetLastError();

R
Richard W.M. Jones 已提交
3712 3713 3714 3715 3716
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3717

3718 3719
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3720
        goto error;
3721 3722
    }

R
Richard W.M. Jones 已提交
3723 3724 3725
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
3726
        goto error;
R
Richard W.M. Jones 已提交
3727 3728 3729 3730 3731
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
3732
        goto error;
R
Richard W.M. Jones 已提交
3733 3734 3735 3736 3737 3738
    }

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

3742 3743 3744 3745 3746 3747 3748 3749
    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 已提交
3750 3751

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3752 3753 3754 3755

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

R
Richard W.M. Jones 已提交
3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800
/**
 * 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);

3801 3802
    virResetLastError();

R
Richard W.M. Jones 已提交
3803 3804 3805 3806 3807 3808
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3809 3810
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3811
        goto error;
3812 3813
    }

R
Richard W.M. Jones 已提交
3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837
    /* 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"));
3838
        goto error;
R
Richard W.M. Jones 已提交
3839 3840 3841 3842 3843 3844
    }

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

3848 3849 3850 3851 3852 3853 3854 3855
    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 已提交
3856 3857

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3858 3859 3860 3861

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

3865

3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876
/************************************************************************
 *									*
 *		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
 *
3877 3878
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
3879 3880
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
3881 3882 3883 3884 3885
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3886 3887
    DEBUG("conn=%p, xml=%s", conn, xml);

3888 3889
    virResetLastError();

3890
    if (!VIR_IS_CONNECT(conn)) {
3891
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3892 3893
        return (NULL);
    }
3894 3895
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3896
        goto error;
3897
    }
3898 3899
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3900
        goto error;
3901 3902
    }

3903 3904 3905 3906 3907 3908 3909
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3910

3911
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3912 3913 3914 3915

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3916
    return NULL;
3917 3918 3919 3920 3921 3922
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3923
 * Undefine a domain but does not stop it if it is running
3924 3925 3926 3927 3928
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3929
    virConnectPtr conn;
3930
    DEBUG("domain=%p", domain);
3931

3932 3933
    virResetLastError();

3934
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3935
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3936 3937
        return (-1);
    }
3938 3939
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3940
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3941
        goto error;
3942 3943
    }

3944 3945 3946 3947 3948 3949 3950
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3951

3952
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3953 3954 3955 3956

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3957
    return -1;
3958 3959 3960 3961 3962 3963
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3964
 * Provides the number of defined but inactive domains.
3965 3966 3967 3968 3969 3970
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3971 3972
    DEBUG("conn=%p", conn);

3973 3974
    virResetLastError();

3975
    if (!VIR_IS_CONNECT(conn)) {
3976
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3977 3978 3979
        return (-1);
    }

3980 3981 3982 3983 3984 3985 3986
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
3987

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3993
    return -1;
3994 3995 3996 3997 3998 3999 4000 4001
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4002 4003
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
4004
 *
4005 4006 4007
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4008
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
4009
                             int maxnames) {
4010 4011
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4012 4013
    virResetLastError();

4014
    if (!VIR_IS_CONNECT(conn)) {
4015
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4016 4017 4018
        return (-1);
    }

4019
    if ((names == NULL) || (maxnames < 0)) {
4020
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4021
        goto error;
4022 4023
    }

4024 4025 4026 4027 4028 4029 4030
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4031

4032
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4033 4034 4035 4036

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4037
    return -1;
4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050
}

/**
 * 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) {
4051
    virConnectPtr conn;
4052
    DEBUG("domain=%p", domain);
4053

4054 4055
    virResetLastError();

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

4066 4067 4068 4069 4070 4071 4072
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4073

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

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

4082 4083 4084
/**
 * virDomainGetAutostart:
 * @domain: a domain object
4085
 * @autostart: the value returned
4086
 *
4087
 * Provides a boolean value indicating whether the domain
4088 4089 4090 4091 4092 4093 4094
 * 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,
4095 4096 4097
                      int *autostart)
{
    virConnectPtr conn;
4098
    DEBUG("domain=%p, autostart=%p", domain, autostart);
4099

4100 4101 4102
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4103
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4104 4105 4106 4107
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4108
        goto error;
4109 4110
    }

4111 4112
    conn = domain->conn;

4113 4114 4115 4116 4117 4118 4119
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4120

4121
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4122 4123 4124 4125

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4126
    return -1;
4127 4128 4129 4130 4131
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
4132
 * @autostart: whether the domain should be automatically started 0 or 1
4133 4134 4135 4136 4137 4138 4139 4140
 *
 * 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,
4141 4142 4143
                      int autostart)
{
    virConnectPtr conn;
4144
    DEBUG("domain=%p, autostart=%d", domain, autostart);
4145

4146 4147 4148
    virResetLastError();

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

4153 4154
    conn = domain->conn;

4155 4156
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4157
        goto error;
4158 4159
    }

4160 4161 4162 4163 4164 4165 4166
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4167

4168
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4169 4170 4171 4172

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

4176 4177 4178 4179 4180 4181 4182 4183
/**
 * 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.
4184
 * This function requires privileged access to the hypervisor.
4185 4186 4187 4188 4189 4190 4191
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
4192
    virConnectPtr conn;
4193
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
4194

4195 4196
    virResetLastError();

4197
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4198
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4199 4200
        return (-1);
    }
4201 4202
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4203
        goto error;
4204
    }
4205

4206 4207
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4208
        goto error;
4209
    }
4210
    conn = domain->conn;
4211

4212 4213 4214 4215 4216 4217 4218
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4219

4220
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4221 4222 4223 4224

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4225
    return -1;
4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239
}

/**
 * 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.
4240
 *
4241
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
4242
 * This function requires privileged access to the hypervisor.
4243 4244 4245 4246 4247 4248 4249
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
4250
    virConnectPtr conn;
4251
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
4252

4253 4254
    virResetLastError();

4255
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4256
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4257 4258
        return (-1);
    }
4259 4260
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4261
        goto error;
4262
    }
4263

4264
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4265
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4266
       goto error;
4267
    }
4268

4269 4270
    conn = domain->conn;

4271 4272 4273 4274 4275 4276 4277
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4278

4279
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4280 4281 4282 4283

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4284
    return -1;
4285 4286 4287 4288 4289 4290 4291 4292 4293
}

/**
 * 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 已提交
4294
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
4295 4296 4297 4298 4299 4300 4301
 *	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...).
4302
 *
4303
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
4304
 * and also in cpumaps if this pointer isn't NULL.
4305 4306 4307 4308 4309
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
4310
                  unsigned char *cpumaps, int maplen)
4311
{
4312
    virConnectPtr conn;
4313
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
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 ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4323
        goto error;
4324 4325 4326
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4327
        goto error;
4328
    }
4329

4330 4331
    conn = domain->conn;

4332 4333 4334 4335 4336 4337 4338 4339
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4340

4341
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4342 4343 4344 4345

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

4349 4350 4351
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
4352
 *
4353 4354 4355 4356 4357
 * 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.
4358 4359 4360 4361
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
4362 4363
virDomainGetMaxVcpus(virDomainPtr domain)
{
4364
    virConnectPtr conn;
4365
    DEBUG("domain=%p", domain);
4366

4367 4368
    virResetLastError();

4369
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4370
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4371 4372 4373 4374 4375
        return (-1);
    }

    conn = domain->conn;

4376 4377 4378 4379 4380 4381 4382
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4383

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

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

4392 4393 4394 4395 4396
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
4397 4398 4399
 * Extract security label of an active domain. The 'label' field
 * in the @seclabel argument will be initialized to the empty
 * string if the domain is not running under a security model.
4400
 *
4401
 * Returns 0 in case of success, -1 in case of failure
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414
 */
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__);
4415
        goto error;
4416 4417 4418 4419
    }

    conn = domain->conn;

4420 4421 4422 4423 4424 4425 4426 4427 4428
    if (conn->driver->domainGetSecurityLabel) {
        int ret;
        ret = conn->driver->domainGetSecurityLabel(domain, seclabel);
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4429

4430 4431 4432
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4433
    return -1;
4434 4435 4436 4437 4438 4439 4440
}

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
4441 4442 4443
 * Extract the security model of a hypervisor. The 'model' field
 * in the @secmodel argument may be initialized to the empty
 * string if the driver has not activated a security model.
4444
 *
4445
 * Returns 0 in case of success, -1 in case of failure
4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456
 */
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__);
4457 4458 4459 4460 4461 4462 4463 4464 4465
        goto error;
    }

    if (conn->driver->nodeGetSecurityModel) {
        int ret;
        ret = conn->driver->nodeGetSecurityModel(conn, secmodel);
        if (ret < 0)
            goto error;
        return ret;
4466 4467
    }

4468
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4469

4470 4471 4472
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4473
    return -1;
4474
}
4475

4476 4477 4478 4479
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4480
 *
4481 4482 4483 4484 4485
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4486
virDomainAttachDevice(virDomainPtr domain, const char *xml)
4487 4488
{
    virConnectPtr conn;
4489
    DEBUG("domain=%p, xml=%s", domain, xml);
4490

4491 4492
    virResetLastError();

4493
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4494
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4495 4496 4497 4498
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4499
        goto error;
4500 4501 4502
    }
    conn = domain->conn;

4503 4504 4505 4506 4507 4508 4509
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4510

4511
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4512 4513 4514 4515

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4516
    return -1;
4517 4518 4519 4520 4521 4522
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4523
 *
4524 4525 4526 4527 4528
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4529
virDomainDetachDevice(virDomainPtr domain, const char *xml)
4530 4531
{
    virConnectPtr conn;
4532
    DEBUG("domain=%p, xml=%s", domain, xml);
4533

4534 4535
    virResetLastError();

4536
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4537
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4538 4539 4540 4541
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4542
        goto error;
4543 4544 4545
    }
    conn = domain->conn;

4546 4547 4548 4549 4550 4551 4552
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4553

4554
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4555 4556 4557 4558

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

4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583
/**
 * 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)
{
4584 4585 4586
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

4587 4588
    virResetLastError();

4589 4590 4591 4592 4593
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4594
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4595
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4596
        goto error;
4597 4598
    }

4599 4600 4601 4602 4603 4604 4605
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4606 4607

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4608 4609 4610 4611

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

4615 4616 4617 4618
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
4619
 * Provides the connection pointer associated with a network.  The
4620 4621 4622
 * reference counter on the connection is not increased by this
 * call.
 *
4623 4624 4625 4626
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
4627 4628 4629 4630 4631
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
4632 4633
    DEBUG("net=%p", net);

4634 4635 4636
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4637
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4638 4639 4640 4641 4642
        return NULL;
    }
    return net->conn;
}

4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653
/**
 * 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)
{
4654 4655
    DEBUG("conn=%p", conn);

4656 4657
    virResetLastError();

4658
    if (!VIR_IS_CONNECT(conn)) {
4659
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4660 4661 4662
        return (-1);
    }

4663 4664 4665 4666 4667 4668 4669
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4670

4671
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4672 4673 4674 4675

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4676
    return -1;
4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689
}

/**
 * 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
4690
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4691
{
4692 4693
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4694 4695
    virResetLastError();

4696
    if (!VIR_IS_CONNECT(conn)) {
4697
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4698 4699 4700
        return (-1);
    }

4701
    if ((names == NULL) || (maxnames < 0)) {
4702
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4703
        goto error;
4704 4705
    }

4706 4707 4708 4709 4710 4711 4712
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4713

4714
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4715 4716 4717 4718

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

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

4735 4736
    virResetLastError();

4737
    if (!VIR_IS_CONNECT(conn)) {
4738
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4739 4740 4741
        return (-1);
    }

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

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

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

/**
 * 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
4769
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4770 4771
                              int maxnames)
{
4772 4773
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4774 4775
    virResetLastError();

4776
    if (!VIR_IS_CONNECT(conn)) {
4777
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4778 4779 4780
        return (-1);
    }

4781
    if ((names == NULL) || (maxnames < 0)) {
4782
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4783
        goto error;
4784 4785
    }

4786 4787 4788 4789 4790 4791 4792 4793
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4794

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

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

/**
 * 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.
 *
4810 4811
 * 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.
4812 4813 4814 4815
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
4816 4817
    DEBUG("conn=%p, name=%s", conn, name);

4818 4819
    virResetLastError();

4820
    if (!VIR_IS_CONNECT(conn)) {
4821
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4822 4823 4824 4825
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4826
        goto  error;
4827 4828
    }

4829 4830 4831 4832 4833 4834 4835
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
4836

4837
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4838 4839 4840 4841

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4842
    return NULL;
4843 4844 4845 4846 4847 4848 4849 4850 4851
}

/**
 * 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.
 *
4852 4853
 * 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.
4854 4855 4856 4857
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
4858 4859
    DEBUG("conn=%p, uuid=%s", conn, uuid);

4860 4861
    virResetLastError();

4862
    if (!VIR_IS_CONNECT(conn)) {
4863
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4864 4865 4866 4867
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4868
        goto error;
4869 4870
    }

4871 4872 4873 4874 4875 4876 4877
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4878

4879
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4880 4881 4882 4883

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4884
    return NULL;
4885 4886 4887 4888 4889 4890 4891 4892 4893
}

/**
 * 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.
 *
4894 4895
 * 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.
4896 4897 4898 4899 4900 4901 4902
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
4903
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
4904

4905 4906
    virResetLastError();

4907
    if (!VIR_IS_CONNECT(conn)) {
4908
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4909 4910 4911 4912
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4913
        goto error;
4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930
    }

    /* 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) {
4931
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4932
        goto error;
4933 4934 4935 4936 4937
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

    return virNetworkLookupByUUID(conn, &uuid[0]);
4938 4939 4940 4941 4942

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

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

4960 4961
    virResetLastError();

4962
    if (!VIR_IS_CONNECT(conn)) {
4963
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4964 4965 4966 4967
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4968
        goto error;
4969 4970 4971
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4972
        goto error;
4973 4974
    }

4975 4976 4977 4978 4979 4980 4981
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
4982

4983
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4984 4985 4986 4987

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4988
    return NULL;
4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000
}

/**
 * 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
5001 5002
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
5003 5004
    DEBUG("conn=%p, xml=%s", conn, xml);

5005 5006
    virResetLastError();

5007
    if (!VIR_IS_CONNECT(conn)) {
5008
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5009 5010 5011 5012
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5013
        goto error;
5014 5015 5016
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5017
        goto error;
5018 5019
    }

5020 5021 5022 5023 5024 5025 5026
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
5027

5028
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5029 5030 5031 5032

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5033
    return NULL;
5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046
}

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

5049 5050
    virResetLastError();

5051
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5052
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5053 5054 5055 5056 5057
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5058
        goto error;
5059 5060
    }

5061 5062 5063 5064 5065 5066 5067
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5068

5069
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5070 5071 5072 5073

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5074
    return -1;
5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086
}

/**
 * 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
5087 5088
virNetworkCreate(virNetworkPtr network)
{
5089
    virConnectPtr conn;
5090 5091
    DEBUG("network=%p", network);

5092 5093
    virResetLastError();

5094
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5095
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5096 5097 5098 5099 5100
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5101
        goto error;
5102 5103
    }

5104 5105 5106 5107 5108 5109 5110
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5111

5112
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5113 5114 5115 5116

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5117
    return -1;
5118 5119 5120 5121 5122 5123 5124
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
5125 5126 5127
 * 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
5128 5129 5130 5131 5132 5133 5134
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
5135
    DEBUG("network=%p", network);
5136

5137 5138
    virResetLastError();

5139
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5140
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5141 5142 5143 5144 5145 5146
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5147
        goto error;
5148 5149
    }

5150 5151 5152 5153 5154 5155 5156
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5157

5158
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5159 5160 5161 5162

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5163
    return -1;
5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
}

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

5180 5181 5182
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5183
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5184 5185
        return (-1);
    }
5186
    if (virUnrefNetwork(network) < 0)
5187 5188 5189 5190
        return (-1);
    return(0);
}

5191 5192
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
5193
 * @network: the network to hold a reference on
5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204
 *
 * 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 已提交
5205 5206
 *
 * Returns 0 in case of success, -1 in case of failure.
5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221
 */
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;
}

5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233
/**
 * 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)
{
5234 5235
    DEBUG("network=%p", network);

5236 5237
    virResetLastError();

5238
    if (!VIR_IS_NETWORK(network)) {
5239
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256
        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)
{
5257 5258
    DEBUG("network=%p, uuid=%p", network, uuid);

5259 5260
    virResetLastError();

5261
    if (!VIR_IS_NETWORK(network)) {
5262
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5263 5264 5265 5266
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5267
        goto error;
5268 5269 5270 5271 5272
    }

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

    return (0);
5273 5274 5275 5276 5277

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293
}

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

5296 5297
    virResetLastError();

5298
    if (!VIR_IS_NETWORK(network)) {
5299
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5300 5301 5302 5303
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5304
        goto error;
5305 5306 5307
    }

    if (virNetworkGetUUID(network, &uuid[0]))
5308
        return (-1);
5309

5310
    virUUIDFormat(uuid, buf);
5311
    return (0);
5312 5313 5314 5315 5316

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332
}

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

5336 5337 5338
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5339
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5340 5341 5342 5343
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5344
        goto error;
5345 5346
    }

5347 5348
    conn = network->conn;

5349 5350 5351 5352 5353 5354 5355
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5356

5357
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5358 5359 5360 5361

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5362
    return NULL;
5363
}
5364 5365 5366 5367 5368

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5369
 * Provides a bridge interface name to which a domain may connect
5370 5371 5372 5373 5374 5375 5376 5377
 * 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)
{
5378
    virConnectPtr conn;
5379
    DEBUG("network=%p", network);
5380

5381 5382 5383
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5384
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5385 5386 5387
        return (NULL);
    }

5388 5389
    conn = network->conn;

5390 5391 5392 5393 5394 5395 5396
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5397

5398
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5399 5400 5401 5402

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5403
    return NULL;
5404
}
5405 5406 5407 5408

/**
 * virNetworkGetAutostart:
 * @network: a network object
5409
 * @autostart: the value returned
5410
 *
5411
 * Provides a boolean value indicating whether the network
5412 5413 5414 5415 5416 5417 5418
 * 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,
5419 5420 5421
                       int *autostart)
{
    virConnectPtr conn;
5422
    DEBUG("network=%p, autostart=%p", network, autostart);
5423

5424 5425 5426
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5427
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5428 5429 5430 5431
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5432
        goto error;
5433 5434
    }

5435 5436
    conn = network->conn;

5437 5438 5439 5440 5441 5442 5443
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5444

5445
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5446 5447 5448 5449

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5450
    return -1;
5451 5452 5453 5454 5455
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
5456
 * @autostart: whether the network should be automatically started 0 or 1
5457 5458 5459 5460 5461 5462 5463 5464
 *
 * 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,
5465 5466 5467
                       int autostart)
{
    virConnectPtr conn;
5468
    DEBUG("network=%p, autostart=%d", network, autostart);
5469

5470 5471 5472
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5473
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5474 5475 5476
        return (-1);
    }

5477 5478
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5479
        goto error;
5480 5481
    }

5482 5483
    conn = network->conn;

5484 5485 5486 5487 5488 5489 5490
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5491

5492
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5493 5494 5495 5496

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

D
Daniel Veillard 已提交
5500 5501
/**
 * virInterfaceGetConnect:
D
Daniel Veillard 已提交
5502
 * @iface: pointer to a interface
D
Daniel Veillard 已提交
5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514
 *
 * Provides the connection pointer associated with an interface.  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 interface object together.
 *
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
5515
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
5516
{
5517
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5518 5519 5520

    virResetLastError();

5521
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
D
Daniel Veillard 已提交
5522 5523 5524
        virLibInterfaceError (NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return NULL;
    }
5525
    return iface->conn;
D
Daniel Veillard 已提交
5526 5527 5528 5529 5530 5531
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
5532
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
5533
 *
5534
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569
 */
int
virConnectNumOfInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

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

    if (conn->interfaceDriver && conn->interfaceDriver->numOfInterfaces) {
        int ret;
        ret = conn->interfaceDriver->numOfInterfaces (conn);
        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);
    return -1;
}

/**
 * virConnectListInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
5570 5571
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListInterfaces(virConnectPtr conn, char **const names, int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    virResetLastError();

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

    if (conn->interfaceDriver && conn->interfaceDriver->listInterfaces) {
        int ret;
        ret = conn->interfaceDriver->listInterfaces (conn, names, maxnames);
        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);
    return -1;
}

5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689
/**
 * virConnectNumOfDefinedInterfaces:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of defined (inactive) interfaces on the physical host.
 *
 * Returns the number of defined interface found or -1 in case of error
 */
int
virConnectNumOfDefinedInterfaces(virConnectPtr conn)
{
    DEBUG("conn=%p", conn);

    virResetLastError();

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

    if (conn->interfaceDriver && conn->interfaceDriver->numOfDefinedInterfaces) {
        int ret;
        ret = conn->interfaceDriver->numOfDefinedInterfaces (conn);
        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);
    return -1;
}

/**
 * virConnectListDefinedInterfaces:
 * @conn: pointer to the hypervisor connection
 * @names: array to collect the list of names of interfaces
 * @maxnames: size of @names
 *
 * Collect the list of defined (inactive) physical host interfaces,
 * and store their names in @names.
 *
 * Returns the number of interfaces found or -1 in case of error
 */
int
virConnectListDefinedInterfaces(virConnectPtr conn,
                                char **const names,
                                int maxnames)
{
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

    virResetLastError();

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

    if (conn->interfaceDriver && conn->interfaceDriver->listDefinedInterfaces) {
        int ret;
        ret = conn->interfaceDriver->listDefinedInterfaces (conn, names, maxnames);
        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);
    return -1;
}

D
Daniel Veillard 已提交
5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775
/**
 * virInterfaceLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the interface
 *
 * Try to lookup an interface on the given hypervisor based on its name.
 *
 * Returns a new interface object or NULL in case of failure.  If the
 * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
 */
virInterfacePtr
virInterfaceLookupByName(virConnectPtr conn, const char *name)
{
    DEBUG("conn=%p, name=%s", conn, name);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto  error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceLookupByName) {
        virInterfacePtr ret;
        ret = conn->interfaceDriver->interfaceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceLookupByMACString:
 * @conn: pointer to the hypervisor connection
 * @macstr: the MAC for the interface (null-terminated ASCII format)
 *
 * Try to lookup an interface on the given hypervisor based on its MAC.
 *
 * Returns a new interface object or NULL in case of failure.  If the
 * interface cannot be found, then VIR_ERR_NO_INTERFACE error is raised.
 */
virInterfacePtr
virInterfaceLookupByMACString(virConnectPtr conn, const char *macstr)
{
    DEBUG("conn=%p, macstr=%s", conn, macstr);

    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (macstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto  error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceLookupByMACString) {
        virInterfacePtr ret;
        ret = conn->interfaceDriver->interfaceLookupByMACString (conn, macstr);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceGetName:
5776
 * @iface: a interface object
D
Daniel Veillard 已提交
5777 5778 5779 5780 5781 5782 5783
 *
 * Get the public name for that interface
 *
 * Returns a pointer to the name or NULL, the string need not be deallocated
 * its lifetime will be the same as the interface object.
 */
const char *
5784
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
5785
{
5786
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5787 5788 5789

    virResetLastError();

5790
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5791 5792 5793
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5794
    return (iface->name);
D
Daniel Veillard 已提交
5795 5796 5797 5798
}

/**
 * virInterfaceGetMACString:
5799
 * @iface: a interface object
D
Daniel Veillard 已提交
5800 5801 5802 5803 5804 5805 5806 5807 5808
 *
 * Get the MAC for a interface as string. For more information about
 * MAC see RFC4122.
 *
 * Returns a pointer to the MAC address (in null-terminated ASCII
 * format) or NULL, the string need not be deallocated its lifetime
 * will be the same as the interface object.
 */
const char *
5809
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
5810
{
5811
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5812 5813 5814

    virResetLastError();

5815
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5816 5817 5818
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5819
    return (iface->mac);
D
Daniel Veillard 已提交
5820 5821 5822 5823
}

/**
 * virInterfaceGetXMLDesc:
5824
 * @iface: a interface object
D
Daniel Veillard 已提交
5825 5826 5827 5828 5829 5830 5831 5832 5833
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Provide an XML description of the interface. The description may be reused
 * later to recreate the interface with virInterfaceCreateXML().
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
5834
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5835 5836
{
    virConnectPtr conn;
5837
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5838 5839 5840

    virResetLastError();

5841
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5842 5843 5844 5845
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
5846
        virLibInterfaceError(iface, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
5847 5848 5849
        goto error;
    }

5850
    conn = iface->conn;
D
Daniel Veillard 已提交
5851 5852 5853

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
5854
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
5855 5856 5857 5858 5859 5860 5861 5862 5863
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5864
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915
    return NULL;
}

/**
 * virInterfaceDefineXML:
 * @conn: pointer to the hypervisor connection
 * @xml: the XML description for the interface, preferably in UTF-8
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Define an interface (or modify existing interface configuration)
 *
 * Returns NULL in case of error, a pointer to the interface otherwise
 */
virInterfacePtr
virInterfaceDefineXML(virConnectPtr conn, const char *xml, unsigned int flags)
{
    DEBUG("conn=%p, xml=%s, flags=%d", conn, xml, 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 (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDefineXML) {
        virInterfacePtr ret;
        ret = conn->interfaceDriver->interfaceDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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

/**
 * virInterfaceUndefine:
5916
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
5917 5918 5919 5920 5921 5922 5923
 *
 * Undefine an interface, ie remove it from the config.
 * This does not free the associated virInterfacePtr object.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
5924
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
5925
    virConnectPtr conn;
5926
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5927 5928 5929

    virResetLastError();

5930
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5931 5932 5933
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
5934
    conn = iface->conn;
D
Daniel Veillard 已提交
5935
    if (conn->flags & VIR_CONNECT_RO) {
5936
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
5937 5938 5939 5940 5941
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
5942
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
5943 5944 5945 5946 5947 5948 5949 5950 5951
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5952
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5953 5954 5955 5956 5957
    return -1;
}

/**
 * virInterfaceCreate:
5958
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
5959 5960 5961 5962 5963 5964 5965
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * Activate an interface (ie call "ifup")
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
5966
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5967 5968
{
    virConnectPtr conn;
5969
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5970 5971 5972

    virResetLastError();

5973
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5974 5975 5976
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
5977
    conn = iface->conn;
D
Daniel Veillard 已提交
5978
    if (conn->flags & VIR_CONNECT_RO) {
5979
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
5980 5981 5982 5983 5984
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
5985
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
5986 5987 5988 5989 5990 5991 5992 5993 5994
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5995
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5996 5997 5998 5999 6000
    return -1;
}

/**
 * virInterfaceDestroy:
6001
 * @iface: an interface object
D
Daniel Veillard 已提交
6002 6003 6004 6005 6006 6007 6008 6009 6010
 * @flags: and OR'ed set of extraction flags, not used yet
 *
 * deactivate an interface (ie call "ifdown")
 * This does not remove the interface from the config, and
 * does not free the associated virInterfacePtr object.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
6011
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6012 6013
{
    virConnectPtr conn;
6014
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6015 6016 6017

    virResetLastError();

6018
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6019 6020 6021 6022
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }

6023
    conn = iface->conn;
D
Daniel Veillard 已提交
6024
    if (conn->flags & VIR_CONNECT_RO) {
6025
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6026 6027 6028 6029 6030
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
6031
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
6032 6033 6034 6035 6036 6037 6038 6039 6040
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
6041
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
6042 6043 6044 6045 6046
    return -1;
}

/**
 * virInterfaceRef:
6047
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062
 *
 * Increment the reference count on the interface. For each
 * additional call to this method, there shall be a corresponding
 * call to virInterfaceFree 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 interface would increment
 * the reference count.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
6063
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
6064
{
6065
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
D
Daniel Veillard 已提交
6066 6067 6068
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
6069 6070 6071 6072
    virMutexLock(&iface->conn->lock);
    DEBUG("iface=%p refs=%d", iface, iface->refs);
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
6073 6074 6075 6076 6077
    return 0;
}

/**
 * virInterfaceFree:
6078
 * @iface: a interface object
D
Daniel Veillard 已提交
6079 6080 6081 6082 6083 6084 6085
 *
 * Free the interface object. The interface itself is unaltered.
 * The data structure is freed and should not be used thereafter.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
6086
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
6087
{
6088
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6089 6090 6091

    virResetLastError();

6092
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6093 6094 6095
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
6096
    if (virUnrefInterface(iface) < 0)
D
Daniel Veillard 已提交
6097 6098 6099 6100
        return (-1);
    return(0);
}

6101 6102 6103

/**
 * virStoragePoolGetConnect:
6104
 * @pool: pointer to a pool
6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120
 *
 * 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);

6121 6122 6123
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142
        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);

6143 6144
    virResetLastError();

6145 6146 6147 6148 6149
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6150 6151 6152 6153 6154 6155 6156
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6157 6158

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6159 6160 6161 6162

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184
    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);

6185 6186
    virResetLastError();

6187 6188 6189 6190 6191 6192 6193
    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__);
6194
        goto error;
6195 6196
    }

6197 6198 6199 6200 6201 6202 6203
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6204 6205 6206

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6207 6208 6209 6210
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return -1;
6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226
}


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

6227 6228
    virResetLastError();

6229 6230 6231 6232 6233
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6234 6235 6236 6237 6238 6239 6240
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6241 6242

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6243 6244 6245 6246

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269
    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);

6270 6271
    virResetLastError();

6272 6273 6274 6275 6276 6277 6278
    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__);
6279
        goto error;
6280 6281
    }

6282 6283 6284 6285 6286 6287 6288
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6289 6290

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6291 6292 6293 6294

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6295 6296 6297 6298
    return -1;
}


6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325
/**
 * 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)
{
6326 6327 6328 6329
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

6330 6331
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6332
        goto error;
6333 6334 6335
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6336
        goto error;
6337 6338
    }

6339 6340
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6341
        goto error;
6342 6343
    }

6344 6345 6346 6347 6348 6349 6350
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
6351 6352

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

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


6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375
/**
 * 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);

6376 6377
    virResetLastError();

6378 6379 6380 6381 6382 6383
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6384
        goto error;
6385 6386
    }

6387 6388 6389 6390 6391 6392 6393
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6394 6395

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6396 6397 6398 6399

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418
    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);

6419 6420
    virResetLastError();

6421 6422 6423 6424 6425 6426
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6427
        goto error;
6428 6429
    }

6430 6431 6432 6433 6434 6435 6436
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6437 6438 6439

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6440 6441 6442 6443
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457
}


/**
 * 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,
6458
                                 const char *uuidstr)
6459 6460 6461 6462
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

6463 6464
    virResetLastError();

6465 6466 6467 6468 6469 6470
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6471
        goto error;
6472 6473 6474 6475
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6476
        goto error;
6477 6478 6479
    }

    return virStoragePoolLookupByUUID(conn, uuid);
6480 6481 6482 6483 6484

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500
}


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

6501 6502 6503
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
6504 6505 6506 6507
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

6508 6509 6510 6511 6512 6513 6514
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
6515 6516 6517

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

6518 6519 6520 6521
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6522 6523 6524 6525 6526 6527
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
6528
 * @flags: future flags, use 0 for now
6529 6530
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
6531
 * pool is not persistent, so its definition will disappear
6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542
 * 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);

6543 6544
    virResetLastError();

6545 6546 6547 6548 6549 6550
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6551
        goto error;
6552 6553 6554
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6555
        goto error;
6556 6557
    }

6558 6559 6560 6561 6562 6563 6564
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6565 6566

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6567 6568 6569 6570

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6571 6572 6573 6574 6575 6576 6577
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
6578
 * @flags: future flags, use 0 for now
6579 6580
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
6581
 * pool is persistent, until explicitly undefined.
6582 6583 6584 6585 6586 6587 6588 6589 6590 6591
 *
 * 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);

6592 6593
    virResetLastError();

6594 6595 6596 6597 6598 6599
    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__);
6600
        goto error;
6601 6602 6603
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6604
        goto error;
6605 6606
    }

6607 6608 6609 6610 6611 6612 6613
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
6614 6615 6616

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6617 6618 6619 6620
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6621 6622 6623 6624 6625
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
6626
 * @flags: future flags, use 0 for now
6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638
 *
 * 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);

6639 6640
    virResetLastError();

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

6651 6652 6653 6654 6655 6656 6657
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6658 6659 6660

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6661 6662 6663 6664
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681
}


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

6682 6683
    virResetLastError();

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

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

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6704 6705 6706 6707
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6708 6709 6710 6711 6712 6713
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
6714
 * @flags: future flags, use 0 for now
6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726
 *
 * 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);

6727 6728
    virResetLastError();

6729 6730 6731 6732 6733 6734 6735
    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__);
6736
        goto error;
6737 6738
    }

6739 6740 6741 6742 6743 6744 6745
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6746 6747 6748

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6749 6750 6751 6752
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773
}


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

6774 6775
    virResetLastError();

6776 6777 6778 6779 6780 6781 6782 6783
    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__);
6784
        goto error;
6785 6786
    }

6787 6788 6789 6790 6791 6792 6793
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6794 6795

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6796 6797 6798 6799

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820
    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);

6821 6822
    virResetLastError();

6823 6824 6825 6826 6827 6828 6829 6830
    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__);
6831
        goto error;
6832 6833
    }

6834 6835 6836 6837 6838 6839 6840
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6841 6842

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6843 6844 6845 6846

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864
    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);

6865 6866 6867
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6868 6869 6870 6871 6872 6873 6874 6875 6876 6877
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


6878 6879
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
6880
 * @pool: the pool to hold a reference on
6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891
 *
 * 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 已提交
6892 6893
 *
 * Returns 0 in case of success, -1 in case of failure.
6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908
 */
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;
}

6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926
/**
 * 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);

6927 6928
    virResetLastError();

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

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

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969
    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);

6970 6971
    virResetLastError();

6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994
    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);

6995 6996
    virResetLastError();

6997 6998 6999 7000 7001 7002
    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__);
7003
        goto error;
7004 7005 7006 7007 7008 7009
    }

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

    return (0);

7010 7011 7012 7013
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031
}

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

7032 7033
    virResetLastError();

7034 7035 7036 7037 7038 7039
    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__);
7040
        goto error;
7041 7042 7043
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
7044
        goto error;
7045 7046 7047 7048

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

7049 7050 7051 7052
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072
}


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

7073 7074
    virResetLastError();

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

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

    conn = pool->conn;

7088 7089 7090 7091 7092 7093 7094
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7095 7096 7097

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7098 7099 7100 7101
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7102 7103 7104 7105 7106 7107
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
7108
 * @flags: flags for XML format options (set of virDomainXMLFlags)
7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122
 *
 * 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);

7123 7124 7125
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7126 7127 7128 7129 7130
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7131
        goto error;
7132 7133 7134 7135
    }

    conn = pool->conn;

7136 7137 7138 7139 7140 7141 7142
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
7143 7144 7145

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7146 7147 7148 7149
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return NULL;
7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169
}


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

7170 7171 7172
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7173 7174 7175 7176 7177
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7178
        goto error;
7179 7180 7181 7182
    }

    conn = pool->conn;

7183 7184 7185 7186 7187 7188 7189
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7190 7191

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7192 7193 7194 7195

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215
    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);

7216 7217 7218
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7219
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7220
        goto error;
7221 7222
    }

7223 7224
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7225
        goto error;
7226 7227
    }

7228 7229
    conn = pool->conn;

7230 7231 7232 7233 7234 7235 7236
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7237 7238

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7239 7240 7241 7242

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259
    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);

7260 7261
    virResetLastError();

7262 7263 7264 7265 7266
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

7267 7268 7269 7270 7271 7272 7273
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7274 7275

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7276 7277 7278 7279

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301
    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);

7302 7303
    virResetLastError();

7304 7305 7306 7307 7308 7309 7310
    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__);
7311
        goto error;
7312 7313
    }

7314 7315 7316 7317 7318 7319 7320
    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;
    }
7321 7322

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7323 7324 7325 7326

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7327 7328 7329 7330 7331 7332
    return -1;
}


/**
 * virStorageVolGetConnect:
7333
 * @vol: pointer to a pool
7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349
 *
 * 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);

7350 7351
    virResetLastError();

7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375
    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);

7376 7377
    virResetLastError();

7378 7379 7380 7381 7382 7383
    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__);
7384
        goto error;
7385 7386
    }

7387 7388 7389 7390 7391 7392 7393
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
7394 7395

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7396 7397 7398 7399

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420
    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);

7421 7422
    virResetLastError();

7423 7424 7425 7426 7427 7428
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7429
        goto error;
7430 7431
    }

7432 7433 7434 7435 7436 7437 7438
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
7439 7440

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7441 7442 7443 7444

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463
    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);

7464 7465
    virResetLastError();

7466 7467 7468 7469 7470 7471
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7472
        goto error;
7473 7474
    }

7475 7476 7477 7478 7479 7480 7481
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
7482 7483

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7484 7485 7486 7487

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505
    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);

7506 7507
    virResetLastError();

7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520
    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
7521
 * unique, so the same volume will have the same
7522 7523 7524 7525 7526 7527 7528 7529 7530
 * 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);

7531 7532
    virResetLastError();

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

7560 7561
    virResetLastError();

7562
    if (!VIR_IS_STORAGE_POOL(pool)) {
7563
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7564 7565 7566 7567 7568
        return (NULL);
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7569
        goto error;
7570 7571
    }

7572 7573 7574 7575 7576 7577 7578
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7579 7580

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7581 7582 7583 7584

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7585 7586 7587 7588
    return NULL;
}


7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647
/**
 * virStorageVolCreateXMLFrom:
 * @pool: pointer to parent pool for the new volume
 * @xmldesc: description of volume to create
 * @clonevol: storage volume to use as input
 * @flags: flags for creation (unused, pass 0)
 *
 * Create a storage volume in the parent pool, using the
 * 'clonevol' volume as input. Information for the new
 * volume (name, perms)  are passed via a typical volume
 * XML description.
 *
 * return the storage volume, or NULL on error
 */
virStorageVolPtr
virStorageVolCreateXMLFrom(virStoragePoolPtr pool,
                           const char *xmldesc,
                           virStorageVolPtr clonevol,
                           unsigned int flags)
{
    DEBUG("pool=%p, flags=%u, clonevol=%p", pool, flags, clonevol);

    virResetLastError();

    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }

    if (!VIR_IS_STORAGE_VOL(clonevol)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

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

    if (pool->conn->storageDriver &&
        pool->conn->storageDriver->volCreateXMLFrom) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXMLFrom (pool, xmldesc,
                                                           clonevol, flags);
        if (!ret)
            goto error;
        return ret;
    }

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

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


7648 7649 7650
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
7651
 * @flags: future flags, use 0 for now
7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663
 *
 * 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);

7664 7665
    virResetLastError();

7666 7667 7668 7669 7670 7671 7672 7673
    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__);
7674
        goto error;
7675 7676
    }

7677 7678 7679 7680 7681 7682 7683
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7684 7685

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7686 7687 7688 7689

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7690 7691 7692 7693 7694 7695 7696 7697 7698
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
7699
 * storage volume continues to exist.
7700 7701 7702 7703 7704 7705 7706 7707
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

7708 7709
    virResetLastError();

7710 7711 7712 7713 7714 7715 7716 7717 7718 7719
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


7720 7721
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
7722
 * @vol: the vol to hold a reference on
7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733
 *
 * 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 已提交
7734 7735
 *
 * Returns 0 in case of success, -1 in case of failure.
7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750
 */
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;
}

7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767
/**
 * 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);

7768 7769
    virResetLastError();

7770 7771 7772 7773 7774 7775
    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__);
7776
        goto error;
7777 7778 7779 7780 7781 7782
    }

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

    conn = vol->conn;

7783 7784 7785 7786 7787 7788 7789
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7790 7791

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7792 7793 7794 7795

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816
    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);

7817 7818
    virResetLastError();

7819 7820 7821 7822 7823 7824
    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__);
7825
        goto error;
7826 7827 7828 7829
    }

    conn = vol->conn;

7830 7831 7832 7833 7834 7835 7836
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
7837 7838 7839

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7840 7841 7842 7843
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864
}


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

7865 7866
    virResetLastError();

7867 7868 7869 7870 7871 7872 7873
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

7874 7875 7876 7877 7878 7879 7880
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
7881 7882

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7883 7884 7885 7886

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7887 7888
    return NULL;
}
7889 7890


7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906
/**
 * 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 已提交
7907
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
7908

7909 7910
    virResetLastError();

7911 7912 7913 7914 7915 7916
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7917
        goto error;
7918 7919
    }

7920 7921 7922 7923 7924 7925 7926
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7927 7928

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7929 7930 7931 7932

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960
    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);

7961 7962
    virResetLastError();

7963 7964 7965 7966 7967 7968
    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__);
7969
        goto error;
7970 7971
    }

7972 7973 7974 7975 7976 7977 7978
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7979 7980

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7981 7982 7983 7984

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001
    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);

8002 8003
    virResetLastError();

8004 8005 8006 8007 8008 8009 8010
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8011
        goto error;
8012 8013
    }

8014 8015 8016 8017 8018 8019 8020
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8021 8022

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8023 8024 8025 8026

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044
    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);

8045 8046
    virResetLastError();

8047 8048 8049 8050 8051
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

8052 8053 8054 8055 8056 8057 8058
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
8059 8060

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8061 8062 8063 8064

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8065 8066 8067 8068 8069 8070 8071 8072
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8073 8074 8075
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092
 */
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 已提交
8093 8094
 * Accessor for the parent of the device
 *
8095 8096 8097 8098 8099 8100 8101
 * 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);

8102 8103
    virResetLastError();

8104 8105 8106 8107 8108
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

8109 8110 8111 8112 8113
    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__);
8114
            virSetConnError(dev->conn);
8115 8116 8117 8118
            return NULL;
        }
    }
    return dev->parent;
8119 8120 8121 8122 8123 8124
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8125 8126
 * Accessor for the number of capabilities supported by the device.
 *
8127 8128 8129 8130 8131 8132
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

8133 8134
    virResetLastError();

8135 8136 8137 8138 8139
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8140 8141 8142 8143 8144 8145 8146
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
8147 8148

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8149 8150 8151 8152

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172
    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);

8173 8174
    virResetLastError();

8175 8176 8177 8178 8179
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8180 8181 8182 8183 8184 8185 8186
    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;
    }
8187 8188

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8189 8190 8191 8192

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209
    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);

8210 8211
    virResetLastError();

8212 8213 8214 8215 8216 8217 8218 8219 8220 8221
    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);
}


8222 8223
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
8224
 * @dev: the dev to hold a reference on
8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235
 *
 * 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 已提交
8236 8237
 *
 * Returns 0 in case of success, -1 in case of failure.
8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252
 */
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;
}

8253
/**
D
Daniel Veillard 已提交
8254
 * virNodeDeviceDettach:
8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268
 * @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 已提交
8269 8270
 *
 * Returns 0 in case of success, -1 in case of failure.
8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311
 */
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 已提交
8312 8313
 *
 * Returns 0 in case of success, -1 in case of failure.
8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356
 */
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 已提交
8357 8358
 *
 * Returns 0 in case of success, -1 in case of failure.
8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387
 */
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);
}

8388

8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485
/**
 * 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;
}


8486 8487 8488 8489 8490 8491 8492 8493 8494
/*
 * 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 已提交
8495
 * @freecb: optional function to deallocate opaque when not used anymore
8496 8497 8498 8499
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
8500 8501 8502 8503 8504 8505 8506
 * 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.
 *
8507 8508 8509 8510 8511
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
8512 8513
                              void *opaque,
                              virFreeCallback freecb)
8514
{
8515 8516
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
8517 8518 8519 8520 8521 8522 8523

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8524
        goto error;
8525 8526
    }

8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538
    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);
8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556
    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)
{
8557 8558 8559
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
8560 8561 8562 8563 8564 8565 8566

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8567 8568 8569 8570 8571 8572 8573 8574
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
8575 8576
    }

8577 8578 8579 8580
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8581 8582
    return -1;
}