libvirt.c 229.6 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_PHYP
#include "phyp/phyp_driver.h"
#endif
61 62 63
#ifdef WITH_VBOX
#include "vbox/vbox_driver.h"
#endif
64 65 66
#ifdef WITH_ESX
#include "esx/esx_driver.h"
#endif
67
#endif
68

69 70
#define VIR_FROM_THIS VIR_FROM_NONE

D
Daniel Veillard 已提交
71 72 73
/*
 * TODO:
 * - use lock to protect against concurrent accesses ?
D
Daniel Veillard 已提交
74
 * - use reference counting to guarantee coherent pointer state ?
D
Daniel Veillard 已提交
75 76
 */

77 78
#define MAX_DRIVERS 10

79
static virDriverPtr virDriverTab[MAX_DRIVERS];
80
static int virDriverTabCount = 0;
81
static virNetworkDriverPtr virNetworkDriverTab[MAX_DRIVERS];
82
static int virNetworkDriverTabCount = 0;
D
Daniel Veillard 已提交
83 84
static virInterfaceDriverPtr virInterfaceDriverTab[MAX_DRIVERS];
static int virInterfaceDriverTabCount = 0;
85 86
static virStorageDriverPtr virStorageDriverTab[MAX_DRIVERS];
static int virStorageDriverTabCount = 0;
87 88
static virDeviceMonitorPtr virDeviceMonitorTab[MAX_DRIVERS];
static int virDeviceMonitorTabCount = 0;
A
Atsushi SAKAI 已提交
89
#ifdef WITH_LIBVIRTD
90 91
static virStateDriverPtr virStateDriverTab[MAX_DRIVERS];
static int virStateDriverTabCount = 0;
A
Atsushi SAKAI 已提交
92
#endif
93 94
static int initialized = 0;

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 122 123 124 125 126 127
#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

128 129 130 131 132 133 134 135
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;
136
        size_t len;
137 138

        switch (cred[i].type) {
139 140 141 142
        case VIR_CRED_EXTERNAL: {
            if (STRNEQ(cred[i].challenge, "PolicyKit"))
                return -1;

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

156 157 158 159
        case VIR_CRED_USERNAME:
        case VIR_CRED_AUTHNAME:
        case VIR_CRED_ECHOPROMPT:
        case VIR_CRED_REALM:
160 161 162 163 164
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

165 166 167 168 169 170 171
            if (!fgets(buf, sizeof(buf), stdin)) {
                if (feof(stdin)) { /* Treat EOF as "" */
                    buf[0] = '\0';
                    break;
                }
                return -1;
            }
172 173 174
            len = strlen(buf);
            if (len != 0 && buf[len-1] == '\n')
                buf[len-1] = '\0';
175 176 177 178
            break;

        case VIR_CRED_PASSPHRASE:
        case VIR_CRED_NOECHOPROMPT:
179 180 181 182 183
            if (printf("%s:", cred[i].prompt) < 0)
                return -1;
            if (fflush(stdout) != 0)
                return -1;

184 185 186 187
            bufptr = getpass("");
            if (!bufptr)
                return -1;
            break;
188 189 190

        default:
            return -1;
191 192
        }

D
Daniel P. Berrange 已提交
193 194 195 196 197 198 199 200 201
        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);
        }
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
    }

    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,
217
    VIR_CRED_EXTERNAL,
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
};

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;

239 240 241 242 243 244 245 246 247 248
#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 已提交
249
    return err == 0 ? 0 : -1;
250 251 252
}
#endif

253 254 255 256 257 258 259 260 261 262 263 264
/**
 * 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)
{
265
    char *debugEnv;
266 267
    if (initialized)
        return(0);
268

269
    initialized = 1;
270

271
    if (virThreadInitialize() < 0 ||
272 273
        virErrorInitialize() < 0 ||
        virRandomInitialize(time(NULL) ^ getpid()))
274 275
        return -1;

276
    debugEnv = getenv("LIBVIRT_DEBUG");
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
    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);
293 294 295

    DEBUG0("register drivers");

296 297 298 299
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

300 301 302
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

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

343 344 345
    return(0);
}

346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
#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
379 380


D
Daniel Veillard 已提交
381 382 383
/**
 * virLibConnError:
 * @conn: the connection if available
384
 * @error: the error number
D
Daniel Veillard 已提交
385 386 387 388 389
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
390 391
virLibConnError(virConnectPtr conn, virErrorNumber error, const char *info)
{
D
Daniel Veillard 已提交
392
    const char *errmsg;
393

D
Daniel Veillard 已提交
394 395 396
    if (error == VIR_ERR_OK)
        return;

397 398 399
    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 已提交
400 401 402
}

/**
403
 * virLibConnWarning:
D
Daniel Veillard 已提交
404
 * @conn: the connection if available
405 406 407 408 409 410 411 412 413 414 415 416 417
 * @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;

418 419 420
    errmsg = virErrorMsg(error, info);
    virRaiseError(conn, NULL, NULL, VIR_FROM_NONE, error, VIR_ERR_WARNING,
                  errmsg, info, NULL, 0, 0, errmsg, info);
421 422 423 424 425 426
}

/**
 * virLibDomainError:
 * @domain: the domain if available
 * @error: the error number
D
Daniel Veillard 已提交
427 428 429 430 431
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
432 433 434
virLibDomainError(virDomainPtr domain, virErrorNumber error,
                  const char *info)
{
D
Daniel Veillard 已提交
435 436
    virConnectPtr conn = NULL;
    const char *errmsg;
437

D
Daniel Veillard 已提交
438 439 440
    if (error == VIR_ERR_OK)
        return;

441
    errmsg = virErrorMsg(error, info);
D
Daniel Veillard 已提交
442 443 444
    if (error != VIR_ERR_INVALID_DOMAIN) {
        conn = domain->conn;
    }
445 446
    virRaiseError(conn, domain, NULL, VIR_FROM_DOM, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
D
Daniel Veillard 已提交
447 448
}

449
/**
450 451
 * virLibNetworkError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
452
 * @error: the error number
453
 * @info: extra information string
454
 *
455
 * Handle an error at the connection level
456
 */
457 458 459 460 461 462 463 464 465 466
static void
virLibNetworkError(virNetworkPtr network, virErrorNumber error,
                   const char *info)
{
    virConnectPtr conn = NULL;
    const char *errmsg;

    if (error == VIR_ERR_OK)
        return;

467
    errmsg = virErrorMsg(error, info);
468 469 470
    if (error != VIR_ERR_INVALID_NETWORK) {
        conn = network->conn;
    }
471 472
    virRaiseError(conn, NULL, network, VIR_FROM_NET, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
473 474
}

D
Daniel Veillard 已提交
475 476 477 478 479 480 481 482 483
/**
 * virLibInterfaceError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
484
virLibInterfaceError(virInterfacePtr iface, virErrorNumber error,
D
Daniel Veillard 已提交
485 486 487 488 489 490 491 492 493 494
                   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) {
495
        conn = iface->conn;
D
Daniel Veillard 已提交
496 497 498 499 500
    }
    virRaiseError(conn, NULL, NULL, VIR_FROM_INTERFACE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

501 502 503
/**
 * virLibStoragePoolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
504
 * @error: the error number
505 506 507 508 509 510 511 512 513 514 515 516 517 518
 * @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;

519
    errmsg = virErrorMsg(error, info);
520 521 522
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

523 524
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
525 526 527 528 529
}

/**
 * virLibStorageVolError:
 * @conn: the connection if available
D
Daniel Veillard 已提交
530
 * @error: the error number
531 532 533 534 535 536 537 538 539 540 541 542 543 544
 * @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;

545
    errmsg = virErrorMsg(error, info);
546 547 548
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

549 550
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
551 552
}

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
/**
 * 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);
}

579 580 581 582 583 584 585 586 587 588 589
/**
 * 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)
{
590 591 592 593 594
    if (virInitialize() < 0)
      return -1;

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

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
599 600
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
601 602
    }

603 604 605
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

606 607
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
608 609
}

D
Daniel Veillard 已提交
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
/**
 * 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++;
}

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
/**
 * 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) {
661
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
662 663 664
        return(-1);
    }

665 666 667
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

668 669 670 671
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
/**
 * 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);
    }

696 697 698
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

699 700 701 702
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

703 704 705 706 707 708 709 710 711 712 713
/**
 * 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)
{
714 715 716 717 718
    if (virInitialize() < 0)
      return -1;

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

    if (virDriverTabCount >= MAX_DRIVERS) {
723 724
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
725 726
    }

727
    if (driver->no < 0) {
728
        virLibConnError
729 730 731 732 733
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

734 735 736
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

737 738
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
739 740
}

A
Atsushi SAKAI 已提交
741
#ifdef WITH_LIBVIRTD
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
/**
 * 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) {
762
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
763 764 765 766 767 768 769
        return(-1);
    }

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

770 771
/**
 * virStateInitialize:
772
 * @privileged: set to 1 if running with root priviledge, 0 otherwise
773 774 775 776 777
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
778
int virStateInitialize(int privileged) {
779 780 781 782 783 784
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
785
        if (virStateDriverTab[i]->initialize &&
786
            virStateDriverTab[i]->initialize(privileged) < 0)
787 788 789 790 791
            ret = -1;
    }
    return ret;
}

792 793 794 795 796 797 798
/**
 * virStateCleanup:
 *
 * Run each virtualization driver's cleanup method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
799
int virStateCleanup(void) {
800 801 802
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
803 804
        if (virStateDriverTab[i]->cleanup &&
            virStateDriverTab[i]->cleanup() < 0)
805 806 807 808 809
            ret = -1;
    }
    return ret;
}

810 811 812 813 814 815 816
/**
 * virStateReload:
 *
 * Run each virtualization driver's reload method.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
817
int virStateReload(void) {
818 819 820
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
821 822
        if (virStateDriverTab[i]->reload &&
            virStateDriverTab[i]->reload() < 0)
823 824 825 826 827
            ret = -1;
    }
    return ret;
}

828 829 830 831 832 833 834
/**
 * virStateActive:
 *
 * Run each virtualization driver's "active" method.
 *
 * Return 0 if none are active, 1 if at least one is.
 */
D
Daniel P. Berrange 已提交
835
int virStateActive(void) {
836 837 838
    int i, ret = 0;

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
839 840
        if (virStateDriverTab[i]->active &&
            virStateDriverTab[i]->active())
841 842 843 844 845
            ret = 1;
    }
    return ret;
}

A
Atsushi SAKAI 已提交
846
#endif
847

848 849


850 851 852
/**
 * virGetVersion:
 * @libVer: return value for the library version (OUT)
853
 * @type: the type of connection/driver looked at
854 855 856 857 858
 * @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 已提交
859
 * @type is unknown or not available, an error code will be returned and
860 861 862 863 864 865
 * @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
866 867 868
virGetVersion(unsigned long *libVer, const char *type,
              unsigned long *typeVer)
{
869
    DEBUG("libVir=%p, type=%s, typeVer=%p", libVer, type, typeVer);
870

871
    if (!initialized)
872
        if (virInitialize() < 0)
873
            return -1;
874

875
    if (libVer == NULL)
876
        return (-1);
877 878 879
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
880
        if (type == NULL)
881
            type = "Xen";
882 883 884 885 886

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

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
#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
905 906 907 908
#if WITH_PHYP
        if (STRCASEEQ(type, "phyp"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
909 910 911 912
#if WITH_OPENVZ
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
913 914 915 916
#if WITH_VBOX
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
917 918 919 920
#if WITH_UML
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
D
Daniel Veillard 已提交
921 922 923 924
#if WITH_ONE
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
925 926 927 928
#if WITH_ESX
        if (STRCASEEQ(type, "ESX"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
929 930 931 932 933
#if WITH_REMOTE
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
#endif
        if (*typeVer == 0) {
934
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
935 936
            return (-1);
        }
937
#endif /* WITH_DRIVER_MODULES */
938 939
    }
    return (0);
940 941
}

942
static virConnectPtr
943 944 945
do_open (const char *name,
         virConnectAuthPtr auth,
         int flags)
946
{
947
    int i, res;
948 949
    virConnectPtr ret;

950 951
    virResetLastError();

952 953 954
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
955

956 957 958 959 960 961 962 963
    /*
     *  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) {
964
            DEBUG("Using LIBVIRT_DEFAULT_URI %s", defname);
965 966
            name = defname;
        } else {
967
            name = NULL;
968
        }
969
    }
970

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987
    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;
        }
988

989 990 991 992 993 994 995 996 997
        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,
998 999 1000 1001
              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));
1002 1003
    } else {
        DEBUG0("no name, allowing driver auto-select");
1004 1005
    }

1006 1007 1008
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

1009
    for (i = 0; i < virDriverTabCount; i++) {
1010 1011
        DEBUG("trying driver %d (%s) ...",
              i, virDriverTab[i]->name);
1012
        res = virDriverTab[i]->open (ret, auth, flags);
1013 1014 1015 1016 1017
        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")));
1018 1019 1020 1021 1022
        if (res == VIR_DRV_OPEN_ERROR) goto failed;
        else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->driver = virDriverTab[i];
            break;
        }
1023 1024
    }

1025
    if (!ret->driver) {
1026 1027
        /* If we reach here, then all drivers declined the connection. */
        virLibConnError (NULL, VIR_ERR_NO_CONNECT, name);
1028
        goto failed;
1029 1030
    }

1031
    for (i = 0; i < virNetworkDriverTabCount; i++) {
1032
        res = virNetworkDriverTab[i]->open (ret, auth, flags);
1033 1034 1035 1036 1037
        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")));
1038
        if (res == VIR_DRV_OPEN_ERROR) {
1039
            if (STREQ(virNetworkDriverTab[i]->name, "remote")) {
1040
                virLibConnWarning (NULL, VIR_WAR_NO_NETWORK,
1041 1042
                                   "Is the daemon running ?");
            }
1043 1044
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
1045 1046 1047
            ret->networkDriver = virNetworkDriverTab[i];
            break;
        }
1048
    }
1049

D
Daniel Veillard 已提交
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
    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;
        }
    }
1068 1069 1070

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1071
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
        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;
        }
    }

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
    /* 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;
1103 1104
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1116
    return ret;
1117 1118

failed:
1119
    if (ret->driver) ret->driver->close (ret);
1120

1121 1122
    /* Ensure a global error is set in case driver forgot */
    virSetGlobalError();
1123 1124 1125

    virUnrefConnect(ret);

1126
    return NULL;
1127 1128
}

1129 1130
/**
 * virConnectOpen:
1131
 * @name: URI of the hypervisor
1132
 *
1133
 * This function should be called first to get a connection to the
1134 1135 1136
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1137
 *
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
 * 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
 *
1149
 * URIs are documented at http://libvirt.org/uri.html
1150 1151 1152 1153
 */
virConnectPtr
virConnectOpen (const char *name)
{
1154 1155 1156 1157
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1158
    DEBUG("name=%s", name);
1159
    return do_open (name, NULL, 0);
1160 1161
}

1162
/**
1163
 * virConnectOpenReadOnly:
1164
 * @name: URI of the hypervisor
1165
 *
1166
 * This function should be called first to get a restricted connection to the
D
Daniel Veillard 已提交
1167
 * library functionalities. The set of APIs usable are then restricted
1168
 * on the available methods to control the domains.
1169
 *
1170 1171 1172
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1173
 * Returns a pointer to the hypervisor connection or NULL in case of error
1174 1175
 *
 * URIs are documented at http://libvirt.org/uri.html
1176
 */
1177
virConnectPtr
1178 1179
virConnectOpenReadOnly(const char *name)
{
1180 1181 1182 1183
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1184
    DEBUG("name=%s", name);
1185 1186 1187 1188 1189 1190 1191 1192 1193
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1194
 * This function should be called first to get a connection to the
1195
 * Hypervisor. If necessary, authentication will be performed fetching
1196 1197
 * credentials via the callback
 *
1198 1199 1200
 * See virConnectOpen for notes about environment variables which can
 * have an effect on opening drivers
 *
1201 1202 1203 1204 1205 1206 1207 1208 1209
 * 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)
{
1210 1211 1212 1213
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1214
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1215
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1216 1217 1218
}

/**
1219
 * virConnectClose:
D
Daniel Veillard 已提交
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
 * @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
1230 1231
virConnectClose(virConnectPtr conn)
{
1232 1233
    DEBUG("conn=%p", conn);

1234 1235 1236 1237
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1238
        return (-1);
1239
    }
1240 1241 1242

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
D
Daniel Veillard 已提交
1243 1244
    if (conn->interfaceDriver)
        conn->interfaceDriver->close (conn);
1245 1246
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1247 1248
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1249
    conn->driver->close (conn);
1250

1251
    if (virUnrefConnect(conn) < 0)
1252
        return (-1);
1253
    return (0);
D
Daniel Veillard 已提交
1254 1255
}

1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
/**
 * 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 已提交
1270 1271
 *
 * Returns 0 in case of success, -1 in case of failure
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
 */
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 已提交
1287 1288
/*
 * Not for public use.  This function is part of the internal
1289 1290 1291
 * implementation of driver features in the remote case.
 */
int
D
Daniel P. Berrange 已提交
1292
virDrvSupportsFeature (virConnectPtr conn, int feature)
1293
{
1294
    int ret;
1295 1296
    DEBUG("conn=%p, feature=%d", conn, feature);

1297 1298 1299 1300
    virResetLastError();

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

1304 1305 1306 1307
    ret = VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return ret;
1308 1309
}

1310 1311 1312 1313 1314 1315 1316
/**
 * 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.
1317 1318 1319
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1320 1321
 */
const char *
1322 1323
virConnectGetType(virConnectPtr conn)
{
1324
    const char *ret;
1325
    DEBUG("conn=%p", conn);
1326

1327 1328
    virResetLastError();

D
Daniel Veillard 已提交
1329
    if (!VIR_IS_CONNECT(conn)) {
1330
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1331
        return (NULL);
D
Daniel Veillard 已提交
1332
    }
1333 1334 1335 1336

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1337
    }
1338
    return conn->driver->name;
1339 1340
}

D
Daniel Veillard 已提交
1341
/**
1342
 * virConnectGetVersion:
D
Daniel Veillard 已提交
1343
 * @conn: pointer to the hypervisor connection
1344
 * @hvVer: return value for the version of the running hypervisor (OUT)
D
Daniel Veillard 已提交
1345
 *
1346
 * Get the version level of the Hypervisor running. This may work only with
1347
 * hypervisor call, i.e. with privileged access to the hypervisor, not
1348
 * with a Read-Only connection.
D
Daniel Veillard 已提交
1349
 *
1350 1351 1352
 * 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 已提交
1353
 */
1354
int
1355 1356
virConnectGetVersion(virConnectPtr conn, unsigned long *hvVer)
{
1357 1358
    DEBUG("conn=%p, hvVer=%p", conn, hvVer);

1359 1360
    virResetLastError();

D
Daniel Veillard 已提交
1361
    if (!VIR_IS_CONNECT(conn)) {
1362
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1363
        return -1;
D
Daniel Veillard 已提交
1364
    }
1365

D
Daniel Veillard 已提交
1366 1367
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1368
        goto error;
D
Daniel Veillard 已提交
1369
    }
1370

1371 1372 1373 1374 1375 1376
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1377

1378
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1379 1380 1381 1382

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

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
/**
 * 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)
{
1401 1402
    DEBUG("conn=%p", conn);

1403 1404
    virResetLastError();

1405
    if (!VIR_IS_CONNECT(conn)) {
1406
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1407 1408 1409
        return NULL;
    }

1410 1411 1412 1413 1414 1415
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1416 1417

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1418 1419 1420 1421

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442
    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)
{
1443
    char *name;
1444 1445
    DEBUG("conn=%p", conn);

1446 1447
    virResetLastError();

1448
    if (!VIR_IS_CONNECT(conn)) {
1449
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1450 1451 1452
        return NULL;
    }

1453
    name = (char *)xmlSaveUri(conn->uri);
1454
    if (!name) {
1455
        virReportOOMError (conn);
1456
        goto error;
1457 1458
    }
    return name;
1459 1460 1461 1462 1463

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

1466 1467 1468 1469 1470
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1471
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1472 1473 1474 1475 1476 1477 1478 1479 1480
 * 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)
{
1481 1482
    DEBUG("conn=%p, type=%s", conn, type);

1483 1484
    virResetLastError();

1485
    if (!VIR_IS_CONNECT(conn)) {
1486
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1487
        return -1;
1488 1489
    }

1490 1491 1492 1493 1494 1495
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1496

1497
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1498 1499 1500
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1501
    return -1;
1502 1503
}

1504
/**
1505
 * virConnectListDomains:
1506 1507 1508 1509 1510 1511 1512 1513 1514
 * @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
1515 1516
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1517 1518
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1519 1520
    virResetLastError();

D
Daniel Veillard 已提交
1521
    if (!VIR_IS_CONNECT(conn)) {
1522
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1523
        return -1;
D
Daniel Veillard 已提交
1524
    }
1525

1526
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1527
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1528
        goto error;
D
Daniel Veillard 已提交
1529
    }
1530

1531 1532 1533 1534 1535 1536
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1537

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

K
 
Karel Zak 已提交
1545 1546 1547 1548
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1549 1550
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1551 1552 1553
 * Returns the number of domain found or -1 in case of error
 */
int
1554 1555
virConnectNumOfDomains(virConnectPtr conn)
{
1556 1557
    DEBUG("conn=%p", conn);

1558 1559
    virResetLastError();

D
Daniel Veillard 已提交
1560
    if (!VIR_IS_CONNECT(conn)) {
1561
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1562
        goto error;
D
Daniel Veillard 已提交
1563
    }
K
Karel Zak 已提交
1564

1565 1566 1567 1568 1569 1570
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1571

1572
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1573 1574 1575
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1576
    return -1;
K
 
Karel Zak 已提交
1577 1578
}

1579 1580 1581 1582
/**
 * virDomainGetConnect:
 * @dom: pointer to a domain
 *
1583
 * Provides the connection pointer associated with a domain.  The
1584 1585 1586
 * reference counter on the connection is not increased by this
 * call.
 *
1587 1588 1589 1590
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the domain object together.
 *
1591 1592 1593 1594 1595
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virDomainGetConnect (virDomainPtr dom)
{
1596 1597
    DEBUG("dom=%p", dom);

1598 1599 1600
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1601
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1602 1603 1604 1605 1606
        return NULL;
    }
    return dom->conn;
}

D
Daniel Veillard 已提交
1607
/**
1608
 * virDomainCreateXML:
D
Daniel Veillard 已提交
1609
 * @conn: pointer to the hypervisor connection
D
Daniel Veillard 已提交
1610
 * @xmlDesc: string containing an XML description of the domain
1611
 * @flags: callers should always pass 0
D
Daniel Veillard 已提交
1612
 *
1613
 * Launch a new guest domain, based on an XML description similar
1614
 * to the one returned by virDomainGetXMLDesc()
1615
 * This function may requires privileged access to the hypervisor.
1616 1617 1618
 * 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).
1619
 *
D
Daniel Veillard 已提交
1620 1621
 * Returns a new domain object or NULL in case of failure
 */
1622
virDomainPtr
1623 1624
virDomainCreateXML(virConnectPtr conn, const char *xmlDesc,
                   unsigned int flags)
1625
{
1626 1627
    DEBUG("conn=%p, xmlDesc=%s, flags=%d", conn, xmlDesc, flags);

1628 1629
    virResetLastError();

D
Daniel Veillard 已提交
1630
    if (!VIR_IS_CONNECT(conn)) {
1631
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1632
        return (NULL);
D
Daniel Veillard 已提交
1633 1634 1635
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1636
        goto error;
D
Daniel Veillard 已提交
1637
    }
1638 1639
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1640
        goto error;
1641
    }
D
Daniel Veillard 已提交
1642

1643 1644 1645 1646 1647 1648 1649
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1650 1651

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1652 1653 1654
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1655
    return NULL;
D
Daniel Veillard 已提交
1656 1657
}

1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
/**
 * 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));
}
1676

1677
/**
1678
 * virDomainLookupByID:
1679 1680 1681 1682
 * @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 已提交
1683 1684
 * 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.
1685
 *
1686 1687
 * 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.
1688
 */
1689
virDomainPtr
1690 1691
virDomainLookupByID(virConnectPtr conn, int id)
{
1692 1693
    DEBUG("conn=%p, id=%d", conn, id);

1694 1695
    virResetLastError();

D
Daniel Veillard 已提交
1696
    if (!VIR_IS_CONNECT(conn)) {
1697
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1698
        return (NULL);
D
Daniel Veillard 已提交
1699 1700 1701
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1702
        goto error;
D
Daniel Veillard 已提交
1703
    }
1704

1705 1706 1707 1708 1709 1710 1711
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1712

1713
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1714 1715 1716 1717

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1718
    return NULL;
1719 1720 1721 1722 1723
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1724
 * @uuid: the raw UUID for the domain
1725 1726 1727
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1728 1729
 * 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.
1730 1731
 */
virDomainPtr
1732 1733
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1734 1735
    DEBUG("conn=%p, uuid=%s", conn, uuid);

1736 1737
    virResetLastError();

D
Daniel Veillard 已提交
1738
    if (!VIR_IS_CONNECT(conn)) {
1739
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1740
        return (NULL);
D
Daniel Veillard 已提交
1741 1742 1743
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1744
        goto error;
D
Daniel Veillard 已提交
1745
    }
1746

1747 1748 1749 1750 1751 1752 1753
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1754

1755
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1756 1757 1758 1759

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

K
Karel Zak 已提交
1763 1764 1765 1766 1767 1768 1769
/**
 * 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.
 *
1770 1771
 * 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 已提交
1772 1773 1774 1775
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1776 1777
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1778 1779
    int ret;

1780 1781
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1782 1783
    virResetLastError();

K
Karel Zak 已提交
1784
    if (!VIR_IS_CONNECT(conn)) {
1785
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
K
Karel Zak 已提交
1786 1787 1788 1789
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1790
        goto error;
K
Karel Zak 已提交
1791
    }
1792 1793
    /* XXX: sexpr_uuid() also supports 'xxxx-xxxx-xxxx-xxxx' format.
     *      We needn't it here. Right?
K
Karel Zak 已提交
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
     */
    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);
1805

1806
    if (ret!=VIR_UUID_BUFLEN) {
1807
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1808
        goto error;
K
Karel Zak 已提交
1809
    }
1810
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1811
        uuid[i] = raw[i] & 0xFF;
1812

K
Karel Zak 已提交
1813
    return virDomainLookupByUUID(conn, &uuid[0]);
1814 1815 1816 1817 1818

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

1821 1822 1823 1824 1825
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1826
 * Try to lookup a domain on the given hypervisor based on its name.
1827
 *
1828 1829
 * 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.
1830 1831
 */
virDomainPtr
1832 1833
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1834 1835
    DEBUG("conn=%p, name=%s", conn, name);

1836 1837
    virResetLastError();

D
Daniel Veillard 已提交
1838
    if (!VIR_IS_CONNECT(conn)) {
1839
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1840
        return (NULL);
D
Daniel Veillard 已提交
1841 1842 1843
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1844
        goto error;
D
Daniel Veillard 已提交
1845
    }
1846

1847 1848 1849 1850 1851 1852 1853
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
1854 1855

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1856 1857 1858 1859

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

D
Daniel Veillard 已提交
1863
/**
1864
 * virDomainDestroy:
D
Daniel Veillard 已提交
1865 1866 1867
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1868 1869 1870
 * 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 已提交
1871 1872
 *
 * Returns 0 in case of success and -1 in case of failure.
1873
 */
D
Daniel Veillard 已提交
1874
int
1875 1876
virDomainDestroy(virDomainPtr domain)
{
1877
    virConnectPtr conn;
1878

1879 1880
    DEBUG("domain=%p", domain);

1881 1882
    virResetLastError();

D
Daniel Veillard 已提交
1883
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1884
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1885
        return (-1);
D
Daniel Veillard 已提交
1886
    }
1887

1888
    conn = domain->conn;
1889 1890
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1891
        goto error;
1892
    }
1893

1894 1895 1896 1897 1898 1899 1900
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1901

1902
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1903 1904 1905 1906

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1907
    return -1;
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919
}

/**
 * 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
1920 1921
virDomainFree(virDomainPtr domain)
{
1922 1923
    DEBUG("domain=%p", domain);

1924 1925 1926
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1927
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1928
        return (-1);
D
Daniel Veillard 已提交
1929
    }
1930
    if (virUnrefDomain(domain) < 0)
1931
        return -1;
1932
    return(0);
D
Daniel Veillard 已提交
1933 1934
}

1935 1936
/**
 * virDomainRef:
D
Daniel Veillard 已提交
1937
 * @domain: the domain to hold a reference on
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948
 *
 * 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 已提交
1949 1950
 *
 * Returns 0 in case of success and -1 in case of failure.
1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
 */
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 已提交
1967
/**
1968
 * virDomainSuspend:
D
Daniel Veillard 已提交
1969 1970 1971
 * @domain: a domain object
 *
 * Suspends an active domain, the process is frozen without further access
1972
 * to CPU resources and I/O but the memory used by the domain at the
1973
 * hypervisor level will stay allocated. Use virDomainResume() to reactivate
D
Daniel Veillard 已提交
1974
 * the domain.
1975
 * This function may requires privileged access.
D
Daniel Veillard 已提交
1976 1977 1978 1979
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
1980 1981
virDomainSuspend(virDomainPtr domain)
{
1982
    virConnectPtr conn;
1983
    DEBUG("domain=%p", domain);
1984

1985 1986
    virResetLastError();

D
Daniel Veillard 已提交
1987
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1988
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1989
        return (-1);
D
Daniel Veillard 已提交
1990
    }
1991 1992
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1993
        goto error;
1994
    }
D
Daniel Veillard 已提交
1995

1996 1997
    conn = domain->conn;

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

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

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

/**
2015
 * virDomainResume:
D
Daniel Veillard 已提交
2016 2017 2018
 * @domain: a domain object
 *
 * Resume an suspended domain, the process is restarted from the state where
2019
 * it was frozen by calling virSuspendDomain().
2020
 * This function may requires privileged access
D
Daniel Veillard 已提交
2021 2022 2023 2024
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2025 2026
virDomainResume(virDomainPtr domain)
{
2027
    virConnectPtr conn;
2028
    DEBUG("domain=%p", domain);
2029

2030 2031
    virResetLastError();

D
Daniel Veillard 已提交
2032
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2033
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2034
        return (-1);
D
Daniel Veillard 已提交
2035
    }
2036 2037
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2038
        goto error;
2039
    }
D
Daniel Veillard 已提交
2040

2041 2042
    conn = domain->conn;

2043 2044 2045 2046 2047 2048 2049
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2050

2051
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2052 2053 2054 2055

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

2059 2060 2061 2062 2063 2064
/**
 * virDomainSave:
 * @domain: a domain object
 * @to: path for the output file
 *
 * This method will suspend a domain and save its memory contents to
2065 2066 2067
 * 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.
2068 2069 2070 2071
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2072 2073
virDomainSave(virDomainPtr domain, const char *to)
{
2074
    char filepath[4096];
2075
    virConnectPtr conn;
2076
    DEBUG("domain=%p, to=%s", domain, to);
2077

2078 2079
    virResetLastError();

D
Daniel Veillard 已提交
2080
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2081
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2082
        return (-1);
D
Daniel Veillard 已提交
2083
    }
2084 2085
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2086
        goto error;
2087
    }
2088
    conn = domain->conn;
D
Daniel Veillard 已提交
2089 2090
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2091
        goto error;
D
Daniel Veillard 已提交
2092
    }
2093

2094 2095 2096 2097 2098
    /*
     * 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] != '/') {
2099
        unsigned int len, t;
2100

2101 2102 2103 2104 2105 2106 2107 2108 2109 2110
        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];
2111 2112 2113

    }

2114 2115 2116 2117 2118 2119 2120
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2121

2122
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2123 2124 2125 2126

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2127
    return -1;
2128 2129 2130 2131
}

/**
 * virDomainRestore:
2132
 * @conn: pointer to the hypervisor connection
2133
 * @from: path to the
2134 2135 2136 2137 2138 2139
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2140 2141
virDomainRestore(virConnectPtr conn, const char *from)
{
2142
    char filepath[4096];
2143
    DEBUG("conn=%p, from=%s", conn, from);
2144

2145 2146
    virResetLastError();

D
Daniel Veillard 已提交
2147
    if (!VIR_IS_CONNECT(conn)) {
2148
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2149
        return (-1);
D
Daniel Veillard 已提交
2150
    }
2151 2152
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2153
        goto error;
2154
    }
D
Daniel Veillard 已提交
2155 2156
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2157
        goto error;
D
Daniel Veillard 已提交
2158 2159
    }

2160 2161 2162 2163 2164
    /*
     * 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] != '/') {
2165 2166 2167
        unsigned int len, t;

        t = strlen(from);
2168 2169 2170 2171 2172
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2173 2174
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2175 2176 2177 2178 2179
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2180 2181 2182 2183 2184
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2185 2186 2187 2188 2189 2190 2191
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2192

2193
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2194 2195 2196 2197

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
2198
    return -1;
D
Daniel Veillard 已提交
2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217
}

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

2220 2221
    virResetLastError();

D
Daniel Veillard 已提交
2222
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2223
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
2224 2225 2226 2227
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2228
        goto error;
D
Daniel Veillard 已提交
2229 2230 2231 2232
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2233
        goto error;
D
Daniel Veillard 已提交
2234 2235 2236 2237 2238 2239 2240 2241 2242 2243
    }

    /*
     * 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);
2244 2245 2246 2247 2248
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibDomainError(domain, VIR_ERR_SYSTEM_ERROR,
                              _("cannot get current directory"));
            goto error;
        }
D
Daniel Veillard 已提交
2249 2250
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2251 2252 2253 2254 2255
        if (len > sizeof(filepath) - (t + 3)) {
            virLibDomainError(domain, VIR_ERR_INTERNAL_ERROR,
                              _("path too long"));
            goto error;
        }
D
Daniel Veillard 已提交
2256 2257 2258 2259 2260 2261
        filepath[len] = '/';
        strcpy(&filepath[len + 1], to);
        to = &filepath[0];

    }

2262 2263 2264 2265 2266 2267 2268
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2269

2270
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2271 2272 2273 2274

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

2278 2279 2280 2281 2282
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2283 2284
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2285 2286 2287 2288 2289 2290 2291
 *
 * 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
2292 2293
virDomainShutdown(virDomainPtr domain)
{
2294
    virConnectPtr conn;
2295
    DEBUG("domain=%p", domain);
2296

2297 2298
    virResetLastError();

D
Daniel Veillard 已提交
2299
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2300
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2301
        return (-1);
D
Daniel Veillard 已提交
2302
    }
2303 2304
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2305
        goto error;
2306
    }
2307

2308 2309
    conn = domain->conn;

2310 2311 2312 2313 2314 2315 2316
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2317

2318
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2319 2320 2321 2322

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

2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339
/**
 * 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)
{
2340
    virConnectPtr conn;
2341
    DEBUG("domain=%p, flags=%u", domain, flags);
2342

2343 2344
    virResetLastError();

2345
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2346
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2347 2348
        return (-1);
    }
2349 2350
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2351
        goto error;
2352
    }
2353

2354 2355
    conn = domain->conn;

2356 2357 2358 2359 2360 2361 2362
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2363

2364
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2365 2366 2367 2368

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

2372
/**
2373
 * virDomainGetName:
2374 2375 2376 2377 2378 2379 2380 2381
 * @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 *
2382 2383
virDomainGetName(virDomainPtr domain)
{
2384 2385
    DEBUG("domain=%p", domain);

2386 2387
    virResetLastError();

D
Daniel Veillard 已提交
2388
    if (!VIR_IS_DOMAIN(domain)) {
2389
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2390
        return (NULL);
D
Daniel Veillard 已提交
2391
    }
2392
    return (domain->name);
2393 2394
}

2395 2396 2397
/**
 * virDomainGetUUID:
 * @domain: a domain object
2398
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2399 2400 2401 2402 2403 2404
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2405 2406
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2407 2408
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2409 2410
    virResetLastError();

D
Daniel Veillard 已提交
2411
    if (!VIR_IS_DOMAIN(domain)) {
2412
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2413
        return (-1);
D
Daniel Veillard 已提交
2414 2415 2416
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2417 2418
        /* Copy to connection error object for back compatability */
        virSetConnError(domain->conn);
2419
        return (-1);
D
Daniel Veillard 已提交
2420 2421
    }

2422 2423
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2424
    return (0);
2425 2426
}

K
Karel Zak 已提交
2427 2428 2429
/**
 * virDomainGetUUIDString:
 * @domain: a domain object
2430
 * @buf: pointer to a VIR_UUID_STRING_BUFLEN bytes array
K
Karel Zak 已提交
2431
 *
2432
 * Get the UUID for a domain as string. For more information about
K
Karel Zak 已提交
2433 2434 2435 2436 2437 2438 2439
 * UUID see RFC4122.
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
virDomainGetUUIDString(virDomainPtr domain, char *buf)
{
2440
    unsigned char uuid[VIR_UUID_BUFLEN];
2441
    DEBUG("domain=%p, buf=%p", domain, buf);
2442

2443 2444
    virResetLastError();

K
Karel Zak 已提交
2445
    if (!VIR_IS_DOMAIN(domain)) {
2446
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
2447 2448 2449 2450
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2451
        goto error;
K
Karel Zak 已提交
2452
    }
2453

K
Karel Zak 已提交
2454
    if (virDomainGetUUID(domain, &uuid[0]))
2455
        goto error;
K
Karel Zak 已提交
2456

2457
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2458
    return (0);
2459 2460 2461 2462 2463

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

2466
/**
2467
 * virDomainGetID:
2468 2469 2470 2471 2472 2473 2474
 * @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
2475 2476
virDomainGetID(virDomainPtr domain)
{
2477 2478
    DEBUG("domain=%p", domain);

2479 2480
    virResetLastError();

D
Daniel Veillard 已提交
2481
    if (!VIR_IS_DOMAIN(domain)) {
2482
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2483
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2484
    }
2485
    return (domain->id);
2486 2487
}

2488 2489 2490 2491 2492 2493
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2494 2495
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2496 2497
 */
char *
2498 2499
virDomainGetOSType(virDomainPtr domain)
{
2500
    virConnectPtr conn;
2501
    DEBUG("domain=%p", domain);
2502

2503 2504 2505
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2506
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2507
        return (NULL);
D
Daniel Veillard 已提交
2508
    }
2509

2510 2511
    conn = domain->conn;

2512 2513 2514 2515 2516 2517 2518
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2519

2520
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2521 2522 2523 2524

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

2528
/**
2529
 * virDomainGetMaxMemory:
2530
 * @domain: a domain object or NULL
2531
 *
2532 2533 2534 2535 2536 2537 2538
 * 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
2539 2540
virDomainGetMaxMemory(virDomainPtr domain)
{
2541
    virConnectPtr conn;
2542
    DEBUG("domain=%p", domain);
2543

2544 2545
    virResetLastError();

D
Daniel Veillard 已提交
2546
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2547
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2548
        return (0);
D
Daniel Veillard 已提交
2549
    }
2550

2551 2552
    conn = domain->conn;

2553 2554 2555 2556 2557 2558 2559
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2560

2561
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2562 2563 2564 2565

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2566
    return 0;
2567 2568
}

D
Daniel Veillard 已提交
2569
/**
2570
 * virDomainSetMaxMemory:
D
Daniel Veillard 已提交
2571 2572
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2573
 *
D
Daniel Veillard 已提交
2574 2575 2576
 * 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.
2577
 * This function requires privileged access to the hypervisor.
D
Daniel Veillard 已提交
2578 2579 2580 2581
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2582 2583
virDomainSetMaxMemory(virDomainPtr domain, unsigned long memory)
{
2584
    virConnectPtr conn;
2585
    DEBUG("domain=%p, memory=%lu", domain, memory);
2586

2587 2588
    virResetLastError();

2589
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2590
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2591
        return (-1);
2592
    }
2593 2594
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2595
        goto error;
2596 2597 2598
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2599
        goto error;
2600
    }
2601
    conn = domain->conn;
2602

2603 2604 2605 2606 2607 2608 2609
    if (conn->driver->domainSetMaxMemory) {
        int ret;
        ret = conn->driver->domainSetMaxMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2610

2611
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2612 2613 2614 2615

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

2619 2620 2621 2622
/**
 * virDomainSetMemory:
 * @domain: a domain object or NULL
 * @memory: the memory size in kilobytes
2623
 *
2624 2625 2626
 * 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.
2627
 * This function may requires privileged access to the hypervisor.
2628 2629 2630 2631 2632 2633 2634
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virDomainSetMemory(virDomainPtr domain, unsigned long memory)
{
    virConnectPtr conn;
2635
    DEBUG("domain=%p, memory=%lu", domain, memory);
2636

2637 2638
    virResetLastError();

2639
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2640
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2641
        return (-1);
2642
    }
2643 2644
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2645
        goto error;
2646 2647 2648
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2649
        goto error;
2650 2651 2652
    }

    conn = domain->conn;
2653

2654 2655 2656 2657 2658 2659 2660
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2661

2662
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2663 2664 2665 2666

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

2670 2671
/**
 * virDomainGetInfo:
2672
 * @domain: a domain object
2673
 * @info: pointer to a virDomainInfo structure allocated by the user
2674
 *
2675
 * Extract information about a domain. Note that if the connection
2676
 * used to get the domain is limited only a partial set of the information
2677 2678 2679 2680 2681
 * can be extracted.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2682 2683
virDomainGetInfo(virDomainPtr domain, virDomainInfoPtr info)
{
2684
    virConnectPtr conn;
2685
    DEBUG("domain=%p, info=%p", domain, info);
2686

2687 2688
    virResetLastError();

D
Daniel Veillard 已提交
2689
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2690
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2691
        return (-1);
D
Daniel Veillard 已提交
2692 2693 2694
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2695
        goto error;
D
Daniel Veillard 已提交
2696
    }
2697

2698
    memset(info, 0, sizeof(virDomainInfo));
2699

2700 2701
    conn = domain->conn;

2702 2703 2704 2705 2706 2707 2708
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2709

2710
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2711 2712 2713 2714

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

2718 2719 2720
/**
 * virDomainGetXMLDesc:
 * @domain: a domain object
2721
 * @flags: an OR'ed set of virDomainXMLFlags
2722 2723
 *
 * Provide an XML description of the domain. The description may be reused
2724
 * later to relaunch the domain with virDomainCreateXML().
2725 2726 2727 2728 2729
 *
 * Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
 *         the caller must free() the returned value.
 */
char *
2730 2731
virDomainGetXMLDesc(virDomainPtr domain, int flags)
{
2732
    virConnectPtr conn;
2733
    DEBUG("domain=%p, flags=%d", domain, flags);
2734

2735 2736 2737
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2738
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2739
        return (NULL);
D
Daniel Veillard 已提交
2740
    }
2741

2742 2743
    conn = domain->conn;

2744 2745 2746 2747 2748 2749
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

2750 2751
    flags &= VIR_DOMAIN_XML_FLAGS_MASK;

2752 2753 2754 2755 2756 2757 2758
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
2759

2760
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2761 2762 2763 2764

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2765
    return NULL;
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 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872
/**
 * 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;
}


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 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932
/**
 * 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 已提交
2933 2934
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2935
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
2936
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
2937

2938 2939 2940
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2941
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2942 2943 2944 2945 2946
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
2947
        goto error;
2948 2949
    }

2950 2951
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2952
        goto error;
2953 2954 2955 2956
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, delibrately report error against source object, not dest here */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2957
        goto error;
2958 2959
    }

2960
    /* Check that migration is supported by both drivers. */
D
Daniel Veillard 已提交
2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
    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 {
2972
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2973
        goto error;
2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986
    }

    /* 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 已提交
2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999
    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);
3000
    }
D
Daniel Veillard 已提交
3001 3002 3003 3004 3005 3006 3007
    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__);
3008
            goto error;
D
Daniel Veillard 已提交
3009 3010 3011
        }
        dom_xml = conn->driver->domainDumpXML (domain,
                                               VIR_DOMAIN_XML_SECURE);
3012

D
Daniel Veillard 已提交
3013
        if (!dom_xml)
3014
            goto error;
D
Daniel Veillard 已提交
3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029

        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);
    }
3030 3031 3032 3033 3034 3035 3036

    /* 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 已提交
3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058
    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);
    }
3059 3060

 done:
3061 3062
    free (uri_out);
    free (cookie);
3063
    return ddomain;
3064 3065 3066 3067 3068

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

D
Daniel Veillard 已提交
3071 3072
/*
 * Not for public use.  This function is part of the internal
3073 3074 3075
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3076
virDomainMigratePrepare (virConnectPtr dconn,
3077 3078 3079 3080 3081 3082 3083 3084
                           char **cookie,
                           int *cookielen,
                           const char *uri_in,
                           char **uri_out,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
J
John Levon 已提交
3085 3086 3087
    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);
3088

3089 3090
    virResetLastError();

3091
    if (!VIR_IS_CONNECT (dconn)) {
3092
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3093 3094 3095
        return -1;
    }

3096 3097
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3098
        goto error;
3099 3100
    }

3101 3102 3103 3104 3105 3106 3107 3108 3109
    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;
    }
3110 3111

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3112 3113 3114 3115

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3116 3117 3118
    return -1;
}

D
Daniel Veillard 已提交
3119 3120
/*
 * Not for public use.  This function is part of the internal
3121 3122 3123
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3124
virDomainMigratePerform (virDomainPtr domain,
3125 3126 3127 3128 3129 3130 3131 3132
                           const char *cookie,
                           int cookielen,
                           const char *uri,
                           unsigned long flags,
                           const char *dname,
                           unsigned long bandwidth)
{
    virConnectPtr conn;
J
John Levon 已提交
3133 3134 3135
    VIR_DEBUG("domain=%p, cookie=%p, cookielen=%d, uri=%s, flags=%lu, "
              "dname=%s, bandwidth=%lu", domain, cookie, cookielen, uri, flags,
              NULLSTR(dname), bandwidth);
3136

3137 3138 3139
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3140
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3141 3142 3143 3144
        return -1;
    }
    conn = domain->conn;

3145 3146
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3147
        goto error;
3148 3149
    }

3150 3151 3152 3153 3154 3155 3156 3157 3158
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3159 3160

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3161 3162 3163 3164

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

D
Daniel Veillard 已提交
3168 3169
/*
 * Not for public use.  This function is part of the internal
3170 3171 3172
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3173
virDomainMigrateFinish (virConnectPtr dconn,
3174 3175 3176 3177 3178 3179
                          const char *dname,
                          const char *cookie,
                          int cookielen,
                          const char *uri,
                          unsigned long flags)
{
J
John Levon 已提交
3180 3181 3182
    VIR_DEBUG("dconn=%p, dname=%s, cookie=%p, cookielen=%d, uri=%s, "
              "flags=%lu", dconn, NULLSTR(dname), cookie, cookielen,
              uri, flags);
3183

3184 3185
    virResetLastError();

3186
    if (!VIR_IS_CONNECT (dconn)) {
3187
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3188 3189 3190
        return NULL;
    }

3191 3192
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3193
        goto error;
3194 3195
    }

3196 3197 3198 3199 3200 3201 3202 3203 3204
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3205 3206

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3207 3208 3209 3210

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3211
    return NULL;
D
Daniel Veillard 已提交
3212 3213 3214
}


D
Daniel Veillard 已提交
3215 3216
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3217 3218 3219
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3220 3221 3222 3223 3224 3225 3226 3227 3228
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 已提交
3229
{
J
John Levon 已提交
3230 3231 3232 3233
    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 已提交
3234

3235 3236
    virResetLastError();

D
Daniel Veillard 已提交
3237 3238 3239 3240 3241
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

3242 3243
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3244
        goto error;
3245 3246
    }

3247 3248 3249 3250 3251 3252 3253 3254 3255 3256
    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 已提交
3257 3258

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3259 3260 3261 3262

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

D
Daniel Veillard 已提交
3266 3267
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3268 3269 3270
 * implementation of migration in the remote case.
 */
virDomainPtr
D
Daniel P. Berrange 已提交
3271 3272 3273 3274 3275 3276 3277
virDomainMigrateFinish2 (virConnectPtr dconn,
                         const char *dname,
                         const char *cookie,
                         int cookielen,
                         const char *uri,
                         unsigned long flags,
                         int retcode)
D
Daniel Veillard 已提交
3278
{
J
John Levon 已提交
3279 3280 3281
    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 已提交
3282

3283 3284
    virResetLastError();

D
Daniel Veillard 已提交
3285 3286 3287 3288 3289
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3290 3291
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3292
        goto error;
3293 3294
    }

3295 3296 3297 3298 3299 3300 3301 3302 3303 3304
    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 已提交
3305 3306

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3307 3308 3309 3310

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3311
    return NULL;
3312 3313 3314
}


3315 3316 3317 3318
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3319
 *
3320 3321 3322 3323 3324
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3325 3326
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3327 3328
    DEBUG("conn=%p, info=%p", conn, info);

3329 3330
    virResetLastError();

3331
    if (!VIR_IS_CONNECT(conn)) {
3332
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3333 3334 3335 3336
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3337
        goto error;
3338 3339
    }

3340 3341 3342 3343 3344 3345 3346
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3347

3348
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3349 3350 3351 3352

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

3356 3357 3358 3359 3360 3361
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
3362 3363
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
3364 3365 3366 3367 3368
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
3369 3370
    DEBUG("conn=%p", conn);

3371 3372
    virResetLastError();

3373
    if (!VIR_IS_CONNECT (conn)) {
3374
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3375 3376 3377
        return NULL;
    }

3378 3379 3380 3381 3382 3383 3384
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3385

3386
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3387 3388 3389 3390

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

3394 3395 3396
/**
 * virNodeGetFreeMemory:
 * @conn: pointer to the hypervisor connection
3397
 *
D
Daniel Veillard 已提交
3398
 * provides the free memory available on the Node
D
Daniel Veillard 已提交
3399 3400
 * Note: most libvirt APIs provide memory sizes in kilobytes, but in this
 * function the returned value is in bytes. Divide by 1024 as necessary.
3401
 *
D
Daniel Veillard 已提交
3402
 * Returns the available free memory in bytes or 0 in case of error
3403 3404 3405 3406
 */
unsigned long long
virNodeGetFreeMemory(virConnectPtr conn)
{
3407 3408
    DEBUG("conn=%p", conn);

3409 3410
    virResetLastError();

3411 3412 3413 3414 3415
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3416 3417 3418 3419 3420 3421 3422
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3423 3424

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3425 3426 3427 3428

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3429 3430 3431
    return 0;
}

3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
/**
 * 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;
3446
    DEBUG("domain=%p, nparams=%p", domain, nparams);
3447

3448 3449
    virResetLastError();

3450
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3451
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3452 3453 3454 3455 3456 3457
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3458 3459
        if (!schedtype)
            goto error;
3460 3461 3462
        return schedtype;
    }

3463
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3464 3465 3466 3467

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487
    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,
3488
                                virSchedParameterPtr params, int *nparams)
3489 3490
{
    virConnectPtr conn;
3491
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
3492

3493 3494
    virResetLastError();

3495
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3496
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3497 3498 3499 3500
        return -1;
    }
    conn = domain->conn;

3501 3502 3503 3504 3505 3506 3507
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3508

3509
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3510 3511 3512 3513

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529
    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
3530
virDomainSetSchedulerParameters(virDomainPtr domain,
3531
                                virSchedParameterPtr params, int nparams)
3532 3533
{
    virConnectPtr conn;
3534
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
3535

3536 3537
    virResetLastError();

3538
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3539
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3540 3541
        return -1;
    }
3542 3543
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3544
        goto error;
3545
    }
3546 3547
    conn = domain->conn;

3548 3549 3550 3551 3552 3553 3554
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3555

3556
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3557 3558 3559 3560

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3561 3562 3563 3564
    return -1;
}


3565
/**
3566
 * virDomainBlockStats:
3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595
 * @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);

3596 3597
    virResetLastError();

3598
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3599
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3600 3601
        return -1;
    }
3602
    if (!path || !stats || size > sizeof stats2) {
3603 3604 3605
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3606 3607 3608 3609
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3610
            goto error;
3611 3612 3613 3614 3615 3616

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3617 3618 3619 3620

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3621 3622 3623 3624
    return -1;
}

/**
3625
 * virDomainInterfaceStats:
3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653
 * @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);

3654 3655
    virResetLastError();

3656
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3657
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3658 3659
        return -1;
    }
3660
    if (!path || !stats || size > sizeof stats2) {
3661 3662 3663
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3664 3665 3666 3667
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3668
            goto error;
3669 3670 3671 3672 3673 3674

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3675 3676 3677 3678

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

R
Richard W.M. Jones 已提交
3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714
/**
 * 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 已提交
3715 3716 3717 3718
 * 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 已提交
3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732
 * 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);

3733 3734
    virResetLastError();

R
Richard W.M. Jones 已提交
3735 3736 3737 3738 3739
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3740

3741 3742
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3743
        goto error;
3744 3745
    }

R
Richard W.M. Jones 已提交
3746 3747 3748
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
3749
        goto error;
R
Richard W.M. Jones 已提交
3750 3751 3752 3753 3754
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
3755
        goto error;
R
Richard W.M. Jones 已提交
3756 3757 3758 3759 3760 3761
    }

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

3765 3766 3767 3768 3769 3770 3771 3772
    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 已提交
3773 3774

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3775 3776 3777 3778

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

R
Richard W.M. Jones 已提交
3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823
/**
 * 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);

3824 3825
    virResetLastError();

R
Richard W.M. Jones 已提交
3826 3827 3828 3829 3830 3831
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3832 3833
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3834
        goto error;
3835 3836
    }

3837
    /* Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
R
Richard W.M. Jones 已提交
3838 3839 3840 3841 3842 3843
     * 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.
     *
3844
     * The QEMU driver handles VIR_MEMORY_VIRTUAL, mapping it
R
Richard W.M. Jones 已提交
3845 3846 3847
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
3848 3849 3850
     * The QEMU driver also handles VIR_MEMORY_PHYSICAL, mapping it
     * to the qemu 'pmemsave' command.
     *
R
Richard W.M. Jones 已提交
3851 3852 3853 3854 3855 3856 3857 3858
     * 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.
     */
3859 3860

    if (flags != VIR_MEMORY_VIRTUAL && flags != VIR_MEMORY_PHYSICAL) {
R
Richard W.M. Jones 已提交
3861
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
3862
                     _("flags parameter must be VIR_MEMORY_VIRTUAL or VIR_MEMORY_PHYSICAL"));
3863
        goto error;
R
Richard W.M. Jones 已提交
3864 3865 3866 3867 3868 3869
    }

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

3873 3874 3875 3876 3877 3878 3879 3880
    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 已提交
3881 3882

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3883 3884 3885 3886

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

3890

3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901
/************************************************************************
 *									*
 *		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
 *
3902 3903
 * Define a domain, but does not start it.
 * This definition is persistent, until explicitly undefined with
3904 3905
 * virDomainUndefine(). A previous definition for this domain would be
 * overriden if it already exists.
3906 3907 3908 3909 3910
 *
 * Returns NULL in case of error, a pointer to the domain otherwise
 */
virDomainPtr
virDomainDefineXML(virConnectPtr conn, const char *xml) {
3911 3912
    DEBUG("conn=%p, xml=%s", conn, xml);

3913 3914
    virResetLastError();

3915
    if (!VIR_IS_CONNECT(conn)) {
3916
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3917 3918
        return (NULL);
    }
3919 3920
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3921
        goto error;
3922
    }
3923 3924
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3925
        goto error;
3926 3927
    }

3928 3929 3930 3931 3932 3933 3934
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3935

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3941
    return NULL;
3942 3943 3944 3945 3946 3947
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3948
 * Undefine a domain but does not stop it if it is running
3949 3950 3951 3952 3953
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3954
    virConnectPtr conn;
3955
    DEBUG("domain=%p", domain);
3956

3957 3958
    virResetLastError();

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

3969 3970 3971 3972 3973 3974 3975
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3976

3977
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3978 3979 3980 3981

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3982
    return -1;
3983 3984 3985 3986 3987 3988
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3989
 * Provides the number of defined but inactive domains.
3990 3991 3992 3993 3994 3995
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3996 3997
    DEBUG("conn=%p", conn);

3998 3999
    virResetLastError();

4000
    if (!VIR_IS_CONNECT(conn)) {
4001
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4002 4003 4004
        return (-1);
    }

4005 4006 4007 4008 4009 4010 4011
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4012

4013
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4014 4015 4016 4017

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4018
    return -1;
4019 4020 4021 4022 4023 4024 4025 4026
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
4027 4028
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
4029
 *
4030 4031 4032
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4033
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
4034
                             int maxnames) {
4035 4036
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4037 4038
    virResetLastError();

4039
    if (!VIR_IS_CONNECT(conn)) {
4040
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4041 4042 4043
        return (-1);
    }

4044
    if ((names == NULL) || (maxnames < 0)) {
4045
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4046
        goto error;
4047 4048
    }

4049 4050 4051 4052 4053 4054 4055
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4056

4057
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4058 4059 4060 4061

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4062
    return -1;
4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075
}

/**
 * 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) {
4076
    virConnectPtr conn;
4077
    DEBUG("domain=%p", domain);
4078

4079 4080
    virResetLastError();

4081
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4082
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4083 4084
        return (-1);
    }
4085 4086
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
4087
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4088
        goto error;
4089
    }
4090

4091 4092 4093 4094 4095 4096 4097
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4098

4099
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4100 4101 4102 4103

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

4107 4108 4109
/**
 * virDomainGetAutostart:
 * @domain: a domain object
4110
 * @autostart: the value returned
4111
 *
4112
 * Provides a boolean value indicating whether the domain
4113 4114 4115 4116 4117 4118 4119
 * 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,
4120 4121 4122
                      int *autostart)
{
    virConnectPtr conn;
4123
    DEBUG("domain=%p, autostart=%p", domain, autostart);
4124

4125 4126 4127
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4128
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4129 4130 4131 4132
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4133
        goto error;
4134 4135
    }

4136 4137
    conn = domain->conn;

4138 4139 4140 4141 4142 4143 4144
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4145

4146
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4147 4148 4149 4150

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

/**
 * virDomainSetAutostart:
 * @domain: a domain object
4157
 * @autostart: whether the domain should be automatically started 0 or 1
4158 4159 4160 4161 4162 4163 4164 4165
 *
 * 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,
4166 4167 4168
                      int autostart)
{
    virConnectPtr conn;
4169
    DEBUG("domain=%p, autostart=%d", domain, autostart);
4170

4171 4172 4173
    virResetLastError();

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

4178 4179
    conn = domain->conn;

4180 4181
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4182
        goto error;
4183 4184
    }

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

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

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

4201 4202 4203 4204 4205 4206 4207 4208
/**
 * 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.
4209
 * This function requires privileged access to the hypervisor.
4210 4211 4212 4213 4214 4215 4216
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
4217
    virConnectPtr conn;
4218
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
4219

4220 4221
    virResetLastError();

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

4231 4232
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4233
        goto error;
4234
    }
4235
    conn = domain->conn;
4236

4237 4238 4239 4240 4241 4242 4243
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4244

4245
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4246 4247 4248 4249

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4250
    return -1;
4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264
}

/**
 * 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.
4265
 *
4266
 * Dynamically change the real CPUs which can be allocated to a virtual CPU.
4267
 * This function requires privileged access to the hypervisor.
4268 4269 4270 4271 4272 4273 4274
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
virDomainPinVcpu(virDomainPtr domain, unsigned int vcpu,
                 unsigned char *cpumap, int maplen)
{
4275
    virConnectPtr conn;
4276
    DEBUG("domain=%p, vcpu=%u, cpumap=%p, maplen=%d", domain, vcpu, cpumap, maplen);
4277

4278 4279
    virResetLastError();

4280
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4281
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4282 4283
        return (-1);
    }
4284 4285
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4286
        goto error;
4287
    }
4288

4289
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4290
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4291
       goto error;
4292
    }
4293

4294 4295
    conn = domain->conn;

4296 4297 4298 4299 4300 4301 4302
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4303

4304
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4305 4306 4307 4308

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4309
    return -1;
4310 4311 4312 4313 4314 4315 4316 4317 4318
}

/**
 * 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 已提交
4319
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
4320 4321 4322 4323 4324 4325 4326
 *	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...).
4327
 *
4328
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
4329
 * and also in cpumaps if this pointer isn't NULL.
4330 4331 4332 4333 4334
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
4335
                  unsigned char *cpumaps, int maplen)
4336
{
4337
    virConnectPtr conn;
4338
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
4339

4340 4341
    virResetLastError();

4342
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4343
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4344 4345 4346 4347
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4348
        goto error;
4349 4350 4351
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4352
        goto error;
4353
    }
4354

4355 4356
    conn = domain->conn;

4357 4358 4359 4360 4361 4362 4363 4364
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4365

4366
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4367 4368 4369 4370

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

4374 4375 4376
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
4377
 *
4378 4379 4380 4381 4382
 * 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.
4383 4384 4385 4386
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
4387 4388
virDomainGetMaxVcpus(virDomainPtr domain)
{
4389
    virConnectPtr conn;
4390
    DEBUG("domain=%p", domain);
4391

4392 4393
    virResetLastError();

4394
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4395
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4396 4397 4398 4399 4400
        return (-1);
    }

    conn = domain->conn;

4401 4402 4403 4404 4405 4406 4407
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4408

4409
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4410 4411 4412 4413

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

4417 4418 4419 4420 4421
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
4422 4423 4424
 * 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.
4425
 *
4426
 * Returns 0 in case of success, -1 in case of failure
4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439
 */
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__);
4440
        goto error;
4441 4442 4443 4444
    }

    conn = domain->conn;

4445 4446 4447 4448 4449 4450 4451 4452 4453
    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__);
4454

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

/**
 * virNodeGetSecurityModel:
 * @conn: a connection object
 * @secmodel: pointer to a virSecurityModel structure
 *
4466 4467 4468
 * 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.
4469
 *
4470
 * Returns 0 in case of success, -1 in case of failure
4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481
 */
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__);
4482 4483 4484 4485 4486 4487 4488 4489 4490
        goto error;
    }

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

4493
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4494

4495 4496 4497
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4498
    return -1;
4499
}
4500

4501 4502 4503 4504
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4505
 *
4506 4507 4508 4509 4510
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4511
virDomainAttachDevice(virDomainPtr domain, const char *xml)
4512 4513
{
    virConnectPtr conn;
4514
    DEBUG("domain=%p, xml=%s", domain, xml);
4515

4516 4517
    virResetLastError();

4518
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4519
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4520 4521 4522 4523
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4524
        goto error;
4525 4526 4527
    }
    conn = domain->conn;

4528 4529 4530 4531 4532 4533 4534
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4535

4536
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4537 4538 4539 4540

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4541
    return -1;
4542 4543 4544 4545 4546 4547
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4548
 *
4549 4550 4551 4552 4553
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4554
virDomainDetachDevice(virDomainPtr domain, const char *xml)
4555 4556
{
    virConnectPtr conn;
4557
    DEBUG("domain=%p, xml=%s", domain, xml);
4558

4559 4560
    virResetLastError();

4561
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4562
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4563 4564 4565 4566
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4567
        goto error;
4568 4569 4570
    }
    conn = domain->conn;

4571 4572 4573 4574 4575 4576 4577
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4578

4579
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4580 4581 4582 4583

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

4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608
/**
 * 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)
{
4609 4610 4611
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

4612 4613
    virResetLastError();

4614 4615 4616 4617 4618
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4619
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4620
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4621
        goto error;
4622 4623
    }

4624 4625 4626 4627 4628 4629 4630
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4631 4632

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4633 4634 4635 4636

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

4640 4641 4642 4643
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
4644
 * Provides the connection pointer associated with a network.  The
4645 4646 4647
 * reference counter on the connection is not increased by this
 * call.
 *
4648 4649 4650 4651
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
4652 4653 4654 4655 4656
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
4657 4658
    DEBUG("net=%p", net);

4659 4660 4661
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4662
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4663 4664 4665 4666 4667
        return NULL;
    }
    return net->conn;
}

4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678
/**
 * 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)
{
4679 4680
    DEBUG("conn=%p", conn);

4681 4682
    virResetLastError();

4683
    if (!VIR_IS_CONNECT(conn)) {
4684
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4685 4686 4687
        return (-1);
    }

4688 4689 4690 4691 4692 4693 4694
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4695

4696
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4697 4698 4699 4700

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4701
    return -1;
4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714
}

/**
 * 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
4715
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4716
{
4717 4718
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4719 4720
    virResetLastError();

4721
    if (!VIR_IS_CONNECT(conn)) {
4722
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4723 4724 4725
        return (-1);
    }

4726
    if ((names == NULL) || (maxnames < 0)) {
4727
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4728
        goto error;
4729 4730
    }

4731 4732 4733 4734 4735 4736 4737
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4738

4739
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4740 4741 4742 4743

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4744
    return -1;
4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757
}

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

4760 4761
    virResetLastError();

4762
    if (!VIR_IS_CONNECT(conn)) {
4763
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4764 4765 4766
        return (-1);
    }

4767 4768 4769 4770 4771 4772 4773
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4774

4775
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4776 4777 4778 4779

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4780
    return -1;
4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793
}

/**
 * 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
4794
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4795 4796
                              int maxnames)
{
4797 4798
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4799 4800
    virResetLastError();

4801
    if (!VIR_IS_CONNECT(conn)) {
4802
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4803 4804 4805
        return (-1);
    }

4806
    if ((names == NULL) || (maxnames < 0)) {
4807
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4808
        goto error;
4809 4810
    }

4811 4812 4813 4814 4815 4816 4817 4818
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4819

4820
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4821 4822 4823 4824

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4825
    return -1;
4826 4827 4828 4829 4830 4831 4832 4833 4834
}

/**
 * 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.
 *
4835 4836
 * 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.
4837 4838 4839 4840
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
4841 4842
    DEBUG("conn=%p, name=%s", conn, name);

4843 4844
    virResetLastError();

4845
    if (!VIR_IS_CONNECT(conn)) {
4846
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4847 4848 4849 4850
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4851
        goto  error;
4852 4853
    }

4854 4855 4856 4857 4858 4859 4860
    if (conn->networkDriver && conn->networkDriver->networkLookupByName) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
4861

4862
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4863 4864 4865 4866

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4867
    return NULL;
4868 4869 4870 4871 4872 4873 4874 4875 4876
}

/**
 * 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.
 *
4877 4878
 * 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.
4879 4880 4881 4882
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
4883 4884
    DEBUG("conn=%p, uuid=%s", conn, uuid);

4885 4886
    virResetLastError();

4887
    if (!VIR_IS_CONNECT(conn)) {
4888
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4889 4890 4891 4892
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4893
        goto error;
4894 4895
    }

4896 4897 4898 4899 4900 4901 4902
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4903

4904
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4905 4906 4907 4908

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4909
    return NULL;
4910 4911 4912 4913 4914 4915 4916 4917 4918
}

/**
 * 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.
 *
4919 4920
 * 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.
4921 4922 4923 4924 4925 4926 4927
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
4928
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
4929

4930 4931
    virResetLastError();

4932
    if (!VIR_IS_CONNECT(conn)) {
4933
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4934 4935 4936 4937
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4938
        goto error;
4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955
    }

    /* 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) {
4956
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4957
        goto error;
4958 4959 4960 4961 4962
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

    return virNetworkLookupByUUID(conn, &uuid[0]);
4963 4964 4965 4966 4967

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982
}

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

4985 4986
    virResetLastError();

4987
    if (!VIR_IS_CONNECT(conn)) {
4988
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4989 4990 4991 4992
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4993
        goto error;
4994 4995 4996
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4997
        goto error;
4998 4999
    }

5000 5001 5002 5003 5004 5005 5006
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
5007

5008
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5009 5010 5011 5012

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5013
    return NULL;
5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025
}

/**
 * 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
5026 5027
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
5028 5029
    DEBUG("conn=%p, xml=%s", conn, xml);

5030 5031
    virResetLastError();

5032
    if (!VIR_IS_CONNECT(conn)) {
5033
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
5034 5035 5036 5037
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5038
        goto error;
5039 5040 5041
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
5042
        goto error;
5043 5044
    }

5045 5046 5047 5048 5049 5050 5051
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
5052

5053
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5054 5055 5056 5057

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5058
    return NULL;
5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071
}

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

5074 5075
    virResetLastError();

5076
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5077
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5078 5079 5080 5081 5082
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5083
        goto error;
5084 5085
    }

5086 5087 5088 5089 5090 5091 5092
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5093

5094
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5095 5096 5097 5098

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

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

5117 5118
    virResetLastError();

5119
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5120
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5121 5122 5123 5124 5125
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5126
        goto error;
5127 5128
    }

5129 5130 5131 5132 5133 5134 5135
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5136

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

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

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
5150 5151 5152
 * 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
5153 5154 5155 5156 5157 5158 5159
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
5160
    DEBUG("network=%p", network);
5161

5162 5163
    virResetLastError();

5164
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5165
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5166 5167 5168 5169 5170 5171
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5172
        goto error;
5173 5174
    }

5175 5176 5177 5178 5179 5180 5181
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5182

5183
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5184 5185 5186 5187

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5188
    return -1;
5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202
}

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

5205 5206 5207
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5208
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5209 5210
        return (-1);
    }
5211
    if (virUnrefNetwork(network) < 0)
5212 5213 5214 5215
        return (-1);
    return(0);
}

5216 5217
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
5218
 * @network: the network to hold a reference on
5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229
 *
 * 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 已提交
5230 5231
 *
 * Returns 0 in case of success, -1 in case of failure.
5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246
 */
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;
}

5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258
/**
 * 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)
{
5259 5260
    DEBUG("network=%p", network);

5261 5262
    virResetLastError();

5263
    if (!VIR_IS_NETWORK(network)) {
5264
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281
        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)
{
5282 5283
    DEBUG("network=%p, uuid=%p", network, uuid);

5284 5285
    virResetLastError();

5286
    if (!VIR_IS_NETWORK(network)) {
5287
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5288 5289 5290 5291
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5292
        goto error;
5293 5294 5295 5296 5297
    }

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

    return (0);
5298 5299 5300 5301 5302

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318
}

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

5321 5322
    virResetLastError();

5323
    if (!VIR_IS_NETWORK(network)) {
5324
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5325 5326 5327 5328
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5329
        goto error;
5330 5331 5332
    }

    if (virNetworkGetUUID(network, &uuid[0]))
5333
        return (-1);
5334

5335
    virUUIDFormat(uuid, buf);
5336
    return (0);
5337 5338 5339 5340 5341

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357
}

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

5361 5362 5363
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5364
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5365 5366 5367 5368
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5369
        goto error;
5370 5371
    }

5372 5373
    conn = network->conn;

5374 5375 5376 5377 5378 5379 5380
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5381

5382
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5383 5384 5385 5386

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5387
    return NULL;
5388
}
5389 5390 5391 5392 5393

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5394
 * Provides a bridge interface name to which a domain may connect
5395 5396 5397 5398 5399 5400 5401 5402
 * 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)
{
5403
    virConnectPtr conn;
5404
    DEBUG("network=%p", network);
5405

5406 5407 5408
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5409
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5410 5411 5412
        return (NULL);
    }

5413 5414
    conn = network->conn;

5415 5416 5417 5418 5419 5420 5421
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5422

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5428
    return NULL;
5429
}
5430 5431 5432 5433

/**
 * virNetworkGetAutostart:
 * @network: a network object
5434
 * @autostart: the value returned
5435
 *
5436
 * Provides a boolean value indicating whether the network
5437 5438 5439 5440 5441 5442 5443
 * 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,
5444 5445 5446
                       int *autostart)
{
    virConnectPtr conn;
5447
    DEBUG("network=%p, autostart=%p", network, autostart);
5448

5449 5450 5451
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5452
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5453 5454 5455 5456
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5457
        goto error;
5458 5459
    }

5460 5461
    conn = network->conn;

5462 5463 5464 5465 5466 5467 5468
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5469

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

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

/**
 * virNetworkSetAutostart:
 * @network: a network object
5481
 * @autostart: whether the network should be automatically started 0 or 1
5482 5483 5484 5485 5486 5487 5488 5489
 *
 * 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,
5490 5491 5492
                       int autostart)
{
    virConnectPtr conn;
5493
    DEBUG("network=%p, autostart=%d", network, autostart);
5494

5495 5496 5497
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5498
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5499 5500 5501
        return (-1);
    }

5502 5503
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5504
        goto error;
5505 5506
    }

5507 5508
    conn = network->conn;

5509 5510 5511 5512 5513 5514 5515
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5516

5517
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5518 5519 5520 5521

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

D
Daniel Veillard 已提交
5525 5526
/**
 * virInterfaceGetConnect:
D
Daniel Veillard 已提交
5527
 * @iface: pointer to a interface
D
Daniel Veillard 已提交
5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539
 *
 * 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
5540
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
5541
{
5542
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5543 5544 5545

    virResetLastError();

5546
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
D
Daniel Veillard 已提交
5547 5548 5549
        virLibInterfaceError (NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return NULL;
    }
5550
    return iface->conn;
D
Daniel Veillard 已提交
5551 5552 5553 5554 5555 5556
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
5557
 * Provides the number of active interfaces on the physical host.
D
Daniel Veillard 已提交
5558
 *
5559
 * Returns the number of active interfaces found or -1 in case of error
D
Daniel Veillard 已提交
5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594
 */
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
 *
5595 5596
 * Collect the list of active physical host interfaces,
 * and store their names in @names
D
Daniel Veillard 已提交
5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 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
 *
 * 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;
}

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 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
/**
 * 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 已提交
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 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800
/**
 * 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:
5801
 * @iface: a interface object
D
Daniel Veillard 已提交
5802 5803 5804 5805 5806 5807 5808
 *
 * 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 *
5809
virInterfaceGetName(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->name);
D
Daniel Veillard 已提交
5820 5821 5822 5823
}

/**
 * virInterfaceGetMACString:
5824
 * @iface: a interface object
D
Daniel Veillard 已提交
5825 5826 5827 5828 5829 5830 5831 5832 5833
 *
 * 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 *
5834
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
5835
{
5836
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5837 5838 5839

    virResetLastError();

5840
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5841 5842 5843
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5844
    return (iface->mac);
D
Daniel Veillard 已提交
5845 5846 5847 5848
}

/**
 * virInterfaceGetXMLDesc:
5849
 * @iface: a interface object
D
Daniel Veillard 已提交
5850 5851 5852 5853 5854 5855 5856 5857 5858
 * @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 *
5859
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5860 5861
{
    virConnectPtr conn;
5862
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5863 5864 5865

    virResetLastError();

5866
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5867 5868 5869 5870
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
5871
        virLibInterfaceError(iface, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
5872 5873 5874
        goto error;
    }

5875
    conn = iface->conn;
D
Daniel Veillard 已提交
5876 5877 5878

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
5879
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
5880 5881 5882 5883 5884 5885 5886 5887 5888
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5889
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
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 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940
    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:
5941
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
5942 5943 5944 5945 5946 5947 5948
 *
 * 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
5949
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
5950
    virConnectPtr conn;
5951
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5952 5953 5954

    virResetLastError();

5955
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5956 5957 5958
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
5959
    conn = iface->conn;
D
Daniel Veillard 已提交
5960
    if (conn->flags & VIR_CONNECT_RO) {
5961
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
5962 5963 5964 5965 5966
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
5967
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
5968 5969 5970 5971 5972 5973 5974 5975 5976
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5977
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5978 5979 5980 5981 5982
    return -1;
}

/**
 * virInterfaceCreate:
5983
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
5984 5985 5986 5987 5988 5989 5990
 * @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
5991
virInterfaceCreate(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5992 5993
{
    virConnectPtr conn;
5994
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5995 5996 5997

    virResetLastError();

5998
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5999 6000 6001
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
6002
    conn = iface->conn;
D
Daniel Veillard 已提交
6003
    if (conn->flags & VIR_CONNECT_RO) {
6004
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6005 6006 6007 6008 6009
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
6010
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
6011 6012 6013 6014 6015 6016 6017 6018 6019
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
6020
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
6021 6022 6023 6024 6025
    return -1;
}

/**
 * virInterfaceDestroy:
6026
 * @iface: an interface object
D
Daniel Veillard 已提交
6027 6028 6029 6030 6031 6032 6033 6034 6035
 * @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
6036
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
6037 6038
{
    virConnectPtr conn;
6039
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
6040 6041 6042

    virResetLastError();

6043
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6044 6045 6046 6047
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }

6048
    conn = iface->conn;
D
Daniel Veillard 已提交
6049
    if (conn->flags & VIR_CONNECT_RO) {
6050
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
6051 6052 6053 6054 6055
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
6056
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
6057 6058 6059 6060 6061 6062 6063 6064 6065
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
6066
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
6067 6068 6069 6070 6071
    return -1;
}

/**
 * virInterfaceRef:
6072
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087
 *
 * 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
6088
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
6089
{
6090
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
D
Daniel Veillard 已提交
6091 6092 6093
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
6094 6095 6096 6097
    virMutexLock(&iface->conn->lock);
    DEBUG("iface=%p refs=%d", iface, iface->refs);
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
6098 6099 6100 6101 6102
    return 0;
}

/**
 * virInterfaceFree:
6103
 * @iface: a interface object
D
Daniel Veillard 已提交
6104 6105 6106 6107 6108 6109 6110
 *
 * 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
6111
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
6112
{
6113
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
6114 6115 6116

    virResetLastError();

6117
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
6118 6119 6120
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
6121
    if (virUnrefInterface(iface) < 0)
D
Daniel Veillard 已提交
6122 6123 6124 6125
        return (-1);
    return(0);
}

6126 6127 6128

/**
 * virStoragePoolGetConnect:
6129
 * @pool: pointer to a pool
6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145
 *
 * 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);

6146 6147 6148
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167
        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);

6168 6169
    virResetLastError();

6170 6171 6172 6173 6174
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6175 6176 6177 6178 6179 6180 6181
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6182 6183

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6184 6185 6186 6187

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209
    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);

6210 6211
    virResetLastError();

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

6222 6223 6224 6225 6226 6227 6228
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6229 6230 6231

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

6252 6253
    virResetLastError();

6254 6255 6256 6257 6258
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6259 6260 6261 6262 6263 6264 6265
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6266 6267

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

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

6295 6296
    virResetLastError();

6297 6298 6299 6300 6301 6302 6303
    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__);
6304
        goto error;
6305 6306
    }

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

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6320 6321 6322 6323
    return -1;
}


6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350
/**
 * 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)
{
6351 6352 6353 6354
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

6355 6356
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6357
        goto error;
6358 6359 6360
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6361
        goto error;
6362 6363
    }

6364 6365
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6366
        goto error;
6367 6368
    }

6369 6370 6371 6372 6373 6374 6375
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
6376 6377

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6378 6379 6380 6381

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


6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400
/**
 * 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);

6401 6402
    virResetLastError();

6403 6404 6405 6406 6407 6408
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6409
        goto error;
6410 6411
    }

6412 6413 6414 6415 6416 6417 6418
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6419 6420

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6421 6422 6423 6424

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

6444 6445
    virResetLastError();

6446 6447 6448 6449 6450 6451
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6452
        goto error;
6453 6454
    }

6455 6456 6457 6458 6459 6460 6461
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6462 6463 6464

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6465 6466 6467 6468
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482
}


/**
 * 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,
6483
                                 const char *uuidstr)
6484 6485 6486 6487
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

6488 6489
    virResetLastError();

6490 6491 6492 6493 6494 6495
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6496
        goto error;
6497 6498 6499 6500
    }

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6501
        goto error;
6502 6503 6504
    }

    return virStoragePoolLookupByUUID(conn, uuid);
6505 6506 6507 6508 6509

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525
}


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

6526 6527 6528
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
6529 6530 6531 6532
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

6533 6534 6535 6536 6537 6538 6539
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
6540 6541 6542

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

6543 6544 6545 6546
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6547 6548 6549 6550 6551 6552
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
6553
 * @flags: future flags, use 0 for now
6554 6555
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
6556
 * pool is not persistent, so its definition will disappear
6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567
 * 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);

6568 6569
    virResetLastError();

6570 6571 6572 6573 6574 6575
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6576
        goto error;
6577 6578 6579
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6580
        goto error;
6581 6582
    }

6583 6584 6585 6586 6587 6588 6589
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6590 6591

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6592 6593 6594 6595

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6596 6597 6598 6599 6600 6601 6602
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
6603
 * @flags: future flags, use 0 for now
6604 6605
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
6606
 * pool is persistent, until explicitly undefined.
6607 6608 6609 6610 6611 6612 6613 6614 6615 6616
 *
 * 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);

6617 6618
    virResetLastError();

6619 6620 6621 6622 6623 6624
    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__);
6625
        goto error;
6626 6627 6628
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6629
        goto error;
6630 6631
    }

6632 6633 6634 6635 6636 6637 6638
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
6639 6640 6641

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6642 6643 6644 6645
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6646 6647 6648 6649 6650
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
6651
 * @flags: future flags, use 0 for now
6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663
 *
 * 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);

6664 6665
    virResetLastError();

6666 6667 6668 6669 6670 6671 6672
    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__);
6673
        goto error;
6674 6675
    }

6676 6677 6678 6679 6680 6681 6682
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6683 6684 6685

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6686 6687 6688 6689
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6690 6691 6692 6693 6694 6695 6696 6697 6698
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
6699
 * Returns 0 on success, -1 on failure
6700 6701 6702 6703 6704 6705 6706
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

6707 6708
    virResetLastError();

6709 6710 6711 6712 6713 6714 6715
    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__);
6716
        goto error;
6717 6718
    }

6719 6720 6721 6722 6723 6724 6725
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6726 6727 6728

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6729 6730 6731 6732
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6733 6734 6735 6736 6737 6738
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
6739
 * @flags: future flags, use 0 for now
6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751
 *
 * 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);

6752 6753
    virResetLastError();

6754 6755 6756 6757 6758 6759 6760
    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__);
6761
        goto error;
6762 6763
    }

6764 6765 6766 6767 6768 6769 6770
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6771 6772 6773

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6774 6775 6776 6777
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798
}


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

6799 6800
    virResetLastError();

6801 6802 6803 6804 6805 6806 6807 6808
    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__);
6809
        goto error;
6810 6811
    }

6812 6813 6814 6815 6816 6817 6818
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6819 6820

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6821 6822 6823 6824

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845
    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);

6846 6847
    virResetLastError();

6848 6849 6850 6851 6852 6853 6854 6855
    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__);
6856
        goto error;
6857 6858
    }

6859 6860 6861 6862 6863 6864 6865
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6866 6867

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6868 6869 6870 6871

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889
    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);

6890 6891 6892
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6893 6894 6895 6896 6897 6898 6899 6900 6901 6902
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


6903 6904
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
6905
 * @pool: the pool to hold a reference on
6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916
 *
 * 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 已提交
6917 6918
 *
 * Returns 0 in case of success, -1 in case of failure.
6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933
 */
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;
}

6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951
/**
 * 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);

6952 6953
    virResetLastError();

6954 6955 6956 6957 6958 6959 6960 6961
    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__);
6962
        goto error;
6963 6964
    }

6965 6966 6967 6968 6969 6970 6971
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6972 6973

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6974 6975 6976 6977

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994
    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);

6995 6996
    virResetLastError();

6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019
    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);

7020 7021
    virResetLastError();

7022 7023 7024 7025 7026 7027
    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__);
7028
        goto error;
7029 7030 7031 7032 7033 7034
    }

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

    return (0);

7035 7036 7037 7038
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056
}

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

7057 7058
    virResetLastError();

7059 7060 7061 7062 7063 7064
    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__);
7065
        goto error;
7066 7067 7068
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
7069
        goto error;
7070 7071 7072 7073

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

7074 7075 7076 7077
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097
}


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

7098 7099
    virResetLastError();

7100 7101 7102 7103 7104 7105
    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__);
7106
        goto error;
7107 7108 7109 7110 7111 7112
    }

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

    conn = pool->conn;

7113 7114 7115 7116 7117 7118 7119
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7120 7121 7122

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7123 7124 7125 7126
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
7127 7128 7129 7130 7131 7132
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
7133
 * @flags: flags for XML format options (set of virDomainXMLFlags)
7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147
 *
 * 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);

7148 7149 7150
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7151 7152 7153 7154 7155
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7156
        goto error;
7157 7158 7159 7160
    }

    conn = pool->conn;

7161 7162 7163 7164 7165 7166 7167
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
7168 7169 7170

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7171 7172 7173 7174
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return NULL;
7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194
}


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

7195 7196 7197
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7198 7199 7200 7201 7202
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7203
        goto error;
7204 7205 7206 7207
    }

    conn = pool->conn;

7208 7209 7210 7211 7212 7213 7214
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7215 7216

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7217 7218 7219 7220

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240
    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);

7241 7242 7243
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7244
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7245
        goto error;
7246 7247
    }

7248 7249
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7250
        goto error;
7251 7252
    }

7253 7254
    conn = pool->conn;

7255 7256 7257 7258 7259 7260 7261
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7262 7263

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7264 7265 7266 7267

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

7285 7286
    virResetLastError();

7287 7288 7289 7290 7291
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

7292 7293 7294 7295 7296 7297 7298
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7299 7300

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7301 7302 7303 7304

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

7327 7328
    virResetLastError();

7329 7330 7331 7332 7333 7334 7335
    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__);
7336
        goto error;
7337 7338
    }

7339 7340 7341 7342 7343 7344 7345
    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;
    }
7346 7347

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7348 7349 7350 7351

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7352 7353 7354 7355 7356 7357
    return -1;
}


/**
 * virStorageVolGetConnect:
7358
 * @vol: pointer to a pool
7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374
 *
 * 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);

7375 7376
    virResetLastError();

7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400
    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);

7401 7402
    virResetLastError();

7403 7404 7405 7406 7407 7408
    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__);
7409
        goto error;
7410 7411
    }

7412 7413 7414 7415 7416 7417 7418
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
7419 7420

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7421 7422 7423 7424

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445
    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);

7446 7447
    virResetLastError();

7448 7449 7450 7451 7452 7453
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7454
        goto error;
7455 7456
    }

7457 7458 7459 7460 7461 7462 7463
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
7464 7465

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7466 7467 7468 7469

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488
    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);

7489 7490
    virResetLastError();

7491 7492 7493 7494 7495 7496
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7497
        goto error;
7498 7499
    }

7500 7501 7502 7503 7504 7505 7506
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
7507 7508

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7509 7510 7511 7512

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530
    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);

7531 7532
    virResetLastError();

7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545
    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
7546
 * unique, so the same volume will have the same
7547 7548 7549 7550 7551 7552 7553 7554 7555
 * 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);

7556 7557
    virResetLastError();

7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584
    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);

7585 7586
    virResetLastError();

7587
    if (!VIR_IS_STORAGE_POOL(pool)) {
7588
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7589 7590 7591 7592 7593
        return (NULL);
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7594
        goto error;
7595 7596
    }

7597 7598 7599 7600 7601 7602 7603
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7604 7605

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7606 7607 7608 7609

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


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 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672
/**
 * 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;
}


7673 7674 7675
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
7676
 * @flags: future flags, use 0 for now
7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688
 *
 * 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);

7689 7690
    virResetLastError();

7691 7692 7693 7694 7695 7696 7697 7698
    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__);
7699
        goto error;
7700 7701
    }

7702 7703 7704 7705 7706 7707 7708
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7709 7710

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7711 7712 7713 7714

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7715 7716 7717 7718 7719 7720 7721 7722 7723
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
7724
 * storage volume continues to exist.
7725 7726 7727 7728 7729 7730 7731 7732
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

7733 7734
    virResetLastError();

7735 7736 7737 7738 7739 7740 7741 7742 7743 7744
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


7745 7746
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
7747
 * @vol: the vol to hold a reference on
7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758
 *
 * 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 已提交
7759 7760
 *
 * Returns 0 in case of success, -1 in case of failure.
7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775
 */
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;
}

7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792
/**
 * 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);

7793 7794
    virResetLastError();

7795 7796 7797 7798 7799 7800
    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__);
7801
        goto error;
7802 7803 7804 7805 7806 7807
    }

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

    conn = vol->conn;

7808 7809 7810 7811 7812 7813 7814
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7815 7816

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7817 7818 7819 7820

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841
    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);

7842 7843
    virResetLastError();

7844 7845 7846 7847 7848 7849
    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__);
7850
        goto error;
7851 7852 7853 7854
    }

    conn = vol->conn;

7855 7856 7857 7858 7859 7860 7861
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
7862 7863 7864

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7865 7866 7867 7868
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889
}


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

7890 7891
    virResetLastError();

7892 7893 7894 7895 7896 7897 7898
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

7899 7900 7901 7902 7903 7904 7905
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
7906 7907

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7908 7909 7910 7911

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7912 7913
    return NULL;
}
7914 7915


7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931
/**
 * 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 已提交
7932
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
7933

7934 7935
    virResetLastError();

7936 7937 7938 7939 7940 7941
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7942
        goto error;
7943 7944
    }

7945 7946 7947 7948 7949 7950 7951
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7952 7953

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7954 7955 7956 7957

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985
    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);

7986 7987
    virResetLastError();

7988 7989 7990 7991 7992 7993
    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__);
7994
        goto error;
7995 7996
    }

7997 7998 7999 8000 8001 8002 8003
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
8004 8005

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8006 8007 8008 8009

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026
    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);

8027 8028
    virResetLastError();

8029 8030 8031 8032 8033 8034 8035
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8036
        goto error;
8037 8038
    }

8039 8040 8041 8042 8043 8044 8045
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
8046 8047

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8048 8049 8050 8051

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069
    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);

8070 8071
    virResetLastError();

8072 8073 8074 8075 8076
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

8077 8078 8079 8080 8081 8082 8083
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
8084 8085

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8086 8087 8088 8089

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8090 8091 8092 8093 8094 8095 8096 8097
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8098 8099 8100
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117
 */
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 已提交
8118 8119
 * Accessor for the parent of the device
 *
8120 8121 8122 8123 8124 8125 8126
 * 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);

8127 8128
    virResetLastError();

8129 8130 8131 8132 8133
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

8134 8135 8136 8137 8138
    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__);
8139
            virSetConnError(dev->conn);
8140 8141 8142 8143
            return NULL;
        }
    }
    return dev->parent;
8144 8145 8146 8147 8148 8149
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8150 8151
 * Accessor for the number of capabilities supported by the device.
 *
8152 8153 8154 8155 8156 8157
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

8158 8159
    virResetLastError();

8160 8161 8162 8163 8164
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8165 8166 8167 8168 8169 8170 8171
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
8172 8173

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8174 8175 8176 8177

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197
    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);

8198 8199
    virResetLastError();

8200 8201 8202 8203 8204
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8205 8206 8207 8208 8209 8210 8211
    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;
    }
8212 8213

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8214 8215 8216 8217

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234
    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);

8235 8236
    virResetLastError();

8237 8238 8239 8240 8241 8242 8243 8244 8245 8246
    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);
}


8247 8248
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
8249
 * @dev: the dev to hold a reference on
8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260
 *
 * 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 已提交
8261 8262
 *
 * Returns 0 in case of success, -1 in case of failure.
8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277
 */
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;
}

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

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 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510
/**
 * 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;
}


8511 8512 8513 8514 8515 8516 8517 8518 8519
/*
 * 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 已提交
8520
 * @freecb: optional function to deallocate opaque when not used anymore
8521 8522 8523 8524
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
8525 8526 8527 8528 8529 8530 8531
 * 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.
 *
8532 8533 8534 8535 8536
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
8537 8538
                              void *opaque,
                              virFreeCallback freecb)
8539
{
8540 8541
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
8542 8543 8544 8545 8546 8547 8548

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8549
        goto error;
8550 8551
    }

8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563
    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);
8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581
    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)
{
8582 8583 8584
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
8585 8586 8587 8588 8589 8590 8591

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8592 8593 8594 8595 8596 8597 8598 8599
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
8600 8601
    }

8602 8603 8604 8605
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8606 8607
    return -1;
}