libvirt.c 225.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_VBOX
#include "vbox/vbox_driver.h"
#endif
61
#endif
62

63 64
#define VIR_FROM_THIS VIR_FROM_NONE

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

71 72
#define MAX_DRIVERS 10

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

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
#if defined(POLKIT_AUTH)
static int virConnectAuthGainPolkit(const char *privilege) {
    const char *const args[] = {
        POLKIT_AUTH, "--obtain", privilege, NULL
    };
    int childpid, status, ret;

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

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

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

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

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

    return 0;
}
#endif

122 123 124 125 126 127 128 129
static int virConnectAuthCallbackDefault(virConnectCredentialPtr cred,
                                         unsigned int ncred,
                                         void *cbdata ATTRIBUTE_UNUSED) {
    int i;

    for (i = 0 ; i < ncred ; i++) {
        char buf[1024];
        char *bufptr = buf;
130
        size_t len;
131 132

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

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

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

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

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

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

        default:
            return -1;
185 186
        }

D
Daniel P. Berrange 已提交
187 188 189 190 191 192 193 194 195
        if (cred[i].type != VIR_CRED_EXTERNAL) {
            if (STREQ(bufptr, "") && cred[i].defresult)
                cred[i].result = strdup(cred[i].defresult);
            else
                cred[i].result = strdup(bufptr);
            if (!cred[i].result)
                return -1;
            cred[i].resultlen = strlen(cred[i].result);
        }
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
    }

    return 0;
}

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

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

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

233 234 235 236 237 238 239 240 241 242
#if HAVE_WINSOCK2_H
static int
winsock_init (void)
{
    WORD winsock_version, err;
    WSADATA winsock_data;

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

247 248 249 250 251 252 253 254 255 256 257 258
/**
 * virInitialize:
 *
 * Initialize the library. It's better to call this routine at startup
 * in multithreaded applications to avoid potential race when initializing
 * the library.
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virInitialize(void)
{
259 260 261
#ifdef ENABLE_DEBUG
    char *debugEnv;
#endif
262 263
    if (initialized)
        return(0);
264

265
    initialized = 1;
266

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

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

    DEBUG0("register drivers");

294 295 296 297
#if HAVE_WINSOCK2_H
    if (winsock_init () == -1) return -1;
#endif

298 299 300
    if (!bindtextdomain(GETTEXT_PACKAGE, LOCALEBASEDIR))
        return (-1);

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

334 335 336
    return(0);
}

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


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

D
Daniel Veillard 已提交
385 386 387
    if (error == VIR_ERR_OK)
        return;

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

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

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

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

D
Daniel Veillard 已提交
429 430 431
    if (error == VIR_ERR_OK)
        return;

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

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

    if (error == VIR_ERR_OK)
        return;

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

D
Daniel Veillard 已提交
466 467 468 469 470 471 472 473 474
/**
 * virLibInterfaceError:
 * @conn: the connection if available
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the connection level
 */
static void
475
virLibInterfaceError(virInterfacePtr iface, virErrorNumber error,
D
Daniel Veillard 已提交
476 477 478 479 480 481 482 483 484 485
                   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) {
486
        conn = iface->conn;
D
Daniel Veillard 已提交
487 488 489 490 491
    }
    virRaiseError(conn, NULL, NULL, VIR_FROM_INTERFACE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
}

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

510
    errmsg = virErrorMsg(error, info);
511 512 513
    if (error != VIR_ERR_INVALID_STORAGE_POOL)
        conn = pool->conn;

514 515
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
516 517 518 519 520
}

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

536
    errmsg = virErrorMsg(error, info);
537 538 539
    if (error != VIR_ERR_INVALID_STORAGE_VOL)
        conn = vol->conn;

540 541
    virRaiseError(conn, NULL, NULL, VIR_FROM_STORAGE, error, VIR_ERR_ERROR,
                  errmsg, info, NULL, 0, 0, errmsg, info);
542 543
}

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

570 571 572 573 574 575 576 577 578 579 580
/**
 * 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)
{
581 582 583 584 585
    if (virInitialize() < 0)
      return -1;

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

    if (virNetworkDriverTabCount >= MAX_DRIVERS) {
590 591
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
592 593
    }

594 595 596
    DEBUG ("registering %s as network driver %d",
           driver->name, virNetworkDriverTabCount);

597 598
    virNetworkDriverTab[virNetworkDriverTabCount] = driver;
    return virNetworkDriverTabCount++;
599 600
}

D
Daniel Veillard 已提交
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
/**
 * 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++;
}

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

656 657 658
    DEBUG ("registering %s as storage driver %d",
           driver->name, virStorageDriverTabCount);

659 660 661 662
    virStorageDriverTab[virStorageDriverTabCount] = driver;
    return virStorageDriverTabCount++;
}

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

687 688 689
    DEBUG ("registering %s as device driver %d",
           driver->name, virDeviceMonitorTabCount);

690 691 692 693
    virDeviceMonitorTab[virDeviceMonitorTabCount] = driver;
    return virDeviceMonitorTabCount++;
}

694 695 696 697 698 699 700 701 702 703 704
/**
 * 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)
{
705 706 707 708 709
    if (virInitialize() < 0)
      return -1;

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

    if (virDriverTabCount >= MAX_DRIVERS) {
714 715
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
716 717
    }

718
    if (driver->no < 0) {
719
        virLibConnError
720 721 722 723 724
            (NULL, VIR_ERR_INVALID_ARG,
             "virRegisterDriver: tried to register an internal Xen driver");
        return -1;
    }

725 726 727
    DEBUG ("registering %s as driver %d",
           driver->name, virDriverTabCount);

728 729
    virDriverTab[virDriverTabCount] = driver;
    return virDriverTabCount++;
730 731
}

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

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

761 762 763 764 765 766 767
/**
 * virStateInitialize:
 *
 * Initialize all virtualization drivers.
 *
 * Return 0 if all succeed, -1 upon any failure.
 */
D
Daniel P. Berrange 已提交
768
int virStateInitialize(void) {
769 770 771 772 773 774
    int i, ret = 0;

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

    for (i = 0 ; i < virStateDriverTabCount ; i++) {
775 776
        if (virStateDriverTab[i]->initialize &&
            virStateDriverTab[i]->initialize() < 0)
777 778 779 780 781
            ret = -1;
    }
    return ret;
}

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

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

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

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

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

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

A
Atsushi SAKAI 已提交
836
#endif
837

838 839


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

861
    if (!initialized)
862
        if (virInitialize() < 0)
863
            return -1;
864

865
    if (libVer == NULL)
866
        return (-1);
867 868 869
    *libVer = LIBVIR_VERSION_NUMBER;

    if (typeVer != NULL) {
870
        if (type == NULL)
871
            type = "Xen";
872 873 874 875 876

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

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
#if WITH_XEN
        if (STRCASEEQ(type, "Xen"))
            *typeVer = xenUnifiedVersion();
#endif
#if WITH_TEST
        if (STRCASEEQ(type, "Test"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_QEMU
        if (STRCASEEQ(type, "QEMU"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_LXC
        if (STRCASEEQ(type, "LXC"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
#if WITH_OPENVZ
        if (STRCASEEQ(type, "OpenVZ"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
899 900 901 902
#if WITH_VBOX
        if (STRCASEEQ(type, "VBox"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
903 904 905 906
#if WITH_UML
        if (STRCASEEQ(type, "UML"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
D
Daniel Veillard 已提交
907 908 909 910
#if WITH_ONE
        if (STRCASEEQ(type, "ONE"))
            *typeVer = LIBVIR_VERSION_NUMBER;
#endif
911 912 913 914 915
#if WITH_REMOTE
        if (STRCASEEQ(type, "Remote"))
            *typeVer = remoteVersion();
#endif
        if (*typeVer == 0) {
916
            virLibConnError(NULL, VIR_ERR_NO_SUPPORT, type);
917 918
            return (-1);
        }
919
#endif /* WITH_DRIVER_MODULES */
920 921
    }
    return (0);
922 923
}

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

932 933
    virResetLastError();

934 935 936
    ret = virGetConnect();
    if (ret == NULL)
        return NULL;
937

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

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

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

988 989 990
    /* Cleansing flags */
    ret->flags = flags & VIR_CONNECT_RO;

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

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

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

D
Daniel Veillard 已提交
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
#if 0
    /* TODO: reactivate once we have an interface driver */

    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;
        }
    }
#endif
1054 1055 1056

    /* Secondary driver for storage. Optional */
    for (i = 0; i < virStorageDriverTabCount; i++) {
1057
        res = virStorageDriverTab[i]->open (ret, auth, flags);
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
#ifdef ENABLE_DEBUG
        DEBUG("storage driver %d %s returned %s",
              i, virStorageDriverTab[i]->name,
              res == VIR_DRV_OPEN_SUCCESS ? "SUCCESS" :
              (res == VIR_DRV_OPEN_DECLINED ? "DECLINED" :
               (res == VIR_DRV_OPEN_ERROR ? "ERROR" : "unknown status")));
#endif
        if (res == VIR_DRV_OPEN_ERROR) {
            if (0 && STREQ(virStorageDriverTab[i]->name, "remote")) {
                virLibConnWarning (NULL, VIR_WAR_NO_STORAGE,
                                   "Is the daemon running ?");
            }
            break;
         } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->storageDriver = virStorageDriverTab[i];
            break;
        }
    }

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
    /* 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;
1091 1092
                if (virAsprintf(&msg, "Is the %s daemon running?",
                                virDeviceMonitorTab[i]->name) > 0) {
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
                    virLibConnWarning (NULL, VIR_WAR_NO_NODE, msg);
                    VIR_FREE(msg);
                }
            }
            break;
        } else if (res == VIR_DRV_OPEN_SUCCESS) {
            ret->deviceMonitor = virDeviceMonitorTab[i];
            break;
        }
    }

1104
    return ret;
1105 1106

failed:
1107
    if (ret->driver) ret->driver->close (ret);
1108

1109 1110
    /* Ensure a global error is set in case driver forgot */
    virSetGlobalError();
1111 1112 1113

    virUnrefConnect(ret);

1114
    return NULL;
1115 1116
}

1117 1118
/**
 * virConnectOpen:
1119
 * @name: URI of the hypervisor
1120
 *
1121
 * This function should be called first to get a connection to the
1122 1123 1124
 * Hypervisor and xen store
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
1125 1126
 *
 * URIs are documented at http://libvirt.org/uri.html
1127 1128 1129 1130
 */
virConnectPtr
virConnectOpen (const char *name)
{
1131 1132 1133 1134
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

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

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

1158
    DEBUG("name=%s", name);
1159 1160 1161 1162 1163 1164 1165 1166 1167
    return do_open (name, NULL, VIR_CONNECT_RO);
}

/**
 * virConnectOpenAuth:
 * @name: URI of the hypervisor
 * @auth: Authenticate callback parameters
 * @flags: Open flags
 *
1168
 * This function should be called first to get a connection to the
1169
 * Hypervisor. If necessary, authentication will be performed fetching
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
 * credentials via the callback
 *
 * Returns a pointer to the hypervisor connection or NULL in case of error
 *
 * URIs are documented at http://libvirt.org/uri.html
 */
virConnectPtr
virConnectOpenAuth(const char *name,
                   virConnectAuthPtr auth,
                   int flags)
{
1181 1182 1183 1184
    if (!initialized)
        if (virInitialize() < 0)
            return NULL;

1185
    DEBUG("name=%s, auth=%p, flags=%d", NULLSTR(name), auth, flags);
1186
    return do_open (name, auth, flags);
D
Daniel Veillard 已提交
1187 1188 1189
}

/**
1190
 * virConnectClose:
D
Daniel Veillard 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
 * @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
1201 1202
virConnectClose(virConnectPtr conn)
{
1203 1204
    DEBUG("conn=%p", conn);

1205 1206 1207 1208
    virResetLastError();

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1209
        return (-1);
1210
    }
1211 1212 1213

    if (conn->networkDriver)
        conn->networkDriver->close (conn);
D
Daniel Veillard 已提交
1214 1215
    if (conn->interfaceDriver)
        conn->interfaceDriver->close (conn);
1216 1217
    if (conn->storageDriver)
        conn->storageDriver->close (conn);
1218 1219
    if (conn->deviceMonitor)
        conn->deviceMonitor->close (conn);
1220
    conn->driver->close (conn);
1221

1222
    if (virUnrefConnect(conn) < 0)
1223
        return (-1);
1224
    return (0);
D
Daniel Veillard 已提交
1225 1226
}

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

1268 1269 1270 1271
    virResetLastError();

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

1275 1276 1277 1278
    ret = VIR_DRV_SUPPORTS_FEATURE (conn->driver, conn, feature);
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return ret;
1279 1280
}

1281 1282 1283 1284 1285 1286 1287
/**
 * 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.
1288 1289 1290
 *
 * See also:
 * http://www.redhat.com/archives/libvir-list/2007-February/msg00096.html
1291 1292
 */
const char *
1293 1294
virConnectGetType(virConnectPtr conn)
{
1295
    const char *ret;
1296
    DEBUG("conn=%p", conn);
1297

1298 1299
    virResetLastError();

D
Daniel Veillard 已提交
1300
    if (!VIR_IS_CONNECT(conn)) {
1301
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1302
        return (NULL);
D
Daniel Veillard 已提交
1303
    }
1304 1305 1306 1307

    if (conn->driver->type) {
        ret = conn->driver->type (conn);
        if (ret) return ret;
1308
    }
1309
    return conn->driver->name;
1310 1311
}

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

1330 1331
    virResetLastError();

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

D
Daniel Veillard 已提交
1337 1338
    if (hvVer == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1339
        goto error;
D
Daniel Veillard 已提交
1340
    }
1341

1342 1343 1344 1345 1346 1347
    if (conn->driver->version) {
        int ret = conn->driver->version (conn, hvVer);
        if (ret < 0)
            goto error;
        return ret;
    }
D
Daniel P. Berrange 已提交
1348

1349
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1350 1351 1352 1353

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

1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
/**
 * 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)
{
1372 1373
    DEBUG("conn=%p", conn);

1374 1375
    virResetLastError();

1376
    if (!VIR_IS_CONNECT(conn)) {
1377
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1378 1379 1380
        return NULL;
    }

1381 1382 1383 1384 1385 1386
    if (conn->driver->getHostname) {
        char *ret = conn->driver->getHostname (conn);
        if (!ret)
            goto error;
        return ret;
    }
1387 1388

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1389 1390 1391 1392

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
    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)
{
1414
    char *name;
1415 1416
    DEBUG("conn=%p", conn);

1417 1418
    virResetLastError();

1419
    if (!VIR_IS_CONNECT(conn)) {
1420
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1421 1422 1423
        return NULL;
    }

1424
    name = (char *)xmlSaveUri(conn->uri);
1425
    if (!name) {
1426
        virReportOOMError (conn);
1427
        goto error;
1428 1429
    }
    return name;
1430 1431 1432 1433 1434

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

1437 1438 1439 1440 1441
/**
 * virConnectGetMaxVcpus:
 * @conn: pointer to the hypervisor connection
 * @type: value of the 'type' attribute in the <domain> element
 *
1442
 * Provides the maximum number of virtual CPUs supported for a guest VM of a
1443 1444 1445 1446 1447 1448 1449 1450 1451
 * 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)
{
1452 1453
    DEBUG("conn=%p, type=%s", conn, type);

1454 1455
    virResetLastError();

1456
    if (!VIR_IS_CONNECT(conn)) {
1457
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1458
        return -1;
1459 1460
    }

1461 1462 1463 1464 1465 1466
    if (conn->driver->getMaxVcpus) {
        int ret = conn->driver->getMaxVcpus (conn, type);
        if (ret < 0)
            goto error;
        return ret;
    }
1467

1468
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1469 1470 1471
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1472
    return -1;
1473 1474
}

1475
/**
1476
 * virConnectListDomains:
1477 1478 1479 1480 1481 1482 1483 1484 1485
 * @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
1486 1487
virConnectListDomains(virConnectPtr conn, int *ids, int maxids)
{
1488 1489
    DEBUG("conn=%p, ids=%p, maxids=%d", conn, ids, maxids);

1490 1491
    virResetLastError();

D
Daniel Veillard 已提交
1492
    if (!VIR_IS_CONNECT(conn)) {
1493
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1494
        return -1;
D
Daniel Veillard 已提交
1495
    }
1496

1497
    if ((ids == NULL) || (maxids < 0)) {
D
Daniel Veillard 已提交
1498
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1499
        goto error;
D
Daniel Veillard 已提交
1500
    }
1501

1502 1503 1504 1505 1506 1507
    if (conn->driver->listDomains) {
        int ret = conn->driver->listDomains (conn, ids, maxids);
        if (ret < 0)
            goto error;
        return ret;
    }
1508

1509
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1510 1511 1512
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1513
    return -1;
D
Daniel Veillard 已提交
1514 1515
}

K
 
Karel Zak 已提交
1516 1517 1518 1519
/**
 * virConnectNumOfDomains:
 * @conn: pointer to the hypervisor connection
 *
1520 1521
 * Provides the number of active domains.
 *
K
 
Karel Zak 已提交
1522 1523 1524
 * Returns the number of domain found or -1 in case of error
 */
int
1525 1526
virConnectNumOfDomains(virConnectPtr conn)
{
1527 1528
    DEBUG("conn=%p", conn);

1529 1530
    virResetLastError();

D
Daniel Veillard 已提交
1531
    if (!VIR_IS_CONNECT(conn)) {
1532
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1533
        goto error;
D
Daniel Veillard 已提交
1534
    }
K
Karel Zak 已提交
1535

1536 1537 1538 1539 1540 1541
    if (conn->driver->numOfDomains) {
        int ret = conn->driver->numOfDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
1542

1543
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1544 1545 1546
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1547
    return -1;
K
 
Karel Zak 已提交
1548 1549
}

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

1569 1570 1571
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
1572
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1573 1574 1575 1576 1577
        return NULL;
    }
    return dom->conn;
}

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

1599 1600
    virResetLastError();

D
Daniel Veillard 已提交
1601
    if (!VIR_IS_CONNECT(conn)) {
1602
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1603
        return (NULL);
D
Daniel Veillard 已提交
1604 1605 1606
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1607
        goto error;
D
Daniel Veillard 已提交
1608
    }
1609 1610
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1611
        goto error;
1612
    }
D
Daniel Veillard 已提交
1613

1614 1615 1616 1617 1618 1619 1620
    if (conn->driver->domainCreateXML) {
        virDomainPtr ret;
        ret = conn->driver->domainCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
1621 1622

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1623 1624 1625
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1626
    return NULL;
D
Daniel Veillard 已提交
1627 1628
}

1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
/**
 * 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));
}
1647

1648
/**
1649
 * virDomainLookupByID:
1650 1651 1652 1653
 * @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 已提交
1654 1655
 * 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.
1656
 *
1657 1658
 * 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.
1659
 */
1660
virDomainPtr
1661 1662
virDomainLookupByID(virConnectPtr conn, int id)
{
1663 1664
    DEBUG("conn=%p, id=%d", conn, id);

1665 1666
    virResetLastError();

D
Daniel Veillard 已提交
1667
    if (!VIR_IS_CONNECT(conn)) {
1668
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1669
        return (NULL);
D
Daniel Veillard 已提交
1670 1671 1672
    }
    if (id < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1673
        goto error;
D
Daniel Veillard 已提交
1674
    }
1675

1676 1677 1678 1679 1680 1681 1682
    if (conn->driver->domainLookupByID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByID (conn, id);
        if (!ret)
            goto error;
        return ret;
    }
1683

1684
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1685 1686 1687 1688

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1689
    return NULL;
1690 1691 1692 1693 1694
}

/**
 * virDomainLookupByUUID:
 * @conn: pointer to the hypervisor connection
K
Karel Zak 已提交
1695
 * @uuid: the raw UUID for the domain
1696 1697 1698
 *
 * Try to lookup a domain on the given hypervisor based on its UUID.
 *
1699 1700
 * 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.
1701 1702
 */
virDomainPtr
1703 1704
virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
1705 1706
    DEBUG("conn=%p, uuid=%s", conn, uuid);

1707 1708
    virResetLastError();

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

1718 1719 1720 1721 1722 1723 1724
    if (conn->driver->domainLookupByUUID) {
        virDomainPtr ret;
        ret = conn->driver->domainLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
1725

1726
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1727 1728 1729 1730

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

K
Karel Zak 已提交
1734 1735 1736 1737 1738 1739 1740
/**
 * 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.
 *
1741 1742
 * 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 已提交
1743 1744 1745 1746
 */
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
1747 1748
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
K
Karel Zak 已提交
1749 1750
    int ret;

1751 1752
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

1753 1754
    virResetLastError();

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

1777
    if (ret!=VIR_UUID_BUFLEN) {
1778
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1779
        goto error;
K
Karel Zak 已提交
1780
    }
1781
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
K
Karel Zak 已提交
1782
        uuid[i] = raw[i] & 0xFF;
1783

K
Karel Zak 已提交
1784
    return virDomainLookupByUUID(conn, &uuid[0]);
1785 1786 1787 1788 1789

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

1792 1793 1794 1795 1796
/**
 * virDomainLookupByName:
 * @conn: pointer to the hypervisor connection
 * @name: name for the domain
 *
1797
 * Try to lookup a domain on the given hypervisor based on its name.
1798
 *
1799 1800
 * 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.
1801 1802
 */
virDomainPtr
1803 1804
virDomainLookupByName(virConnectPtr conn, const char *name)
{
1805 1806
    DEBUG("conn=%p, name=%s", conn, name);

1807 1808
    virResetLastError();

D
Daniel Veillard 已提交
1809
    if (!VIR_IS_CONNECT(conn)) {
1810
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
1811
        return (NULL);
D
Daniel Veillard 已提交
1812 1813 1814
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
1815
        goto error;
D
Daniel Veillard 已提交
1816
    }
1817

1818 1819 1820 1821 1822 1823 1824
    if (conn->driver->domainLookupByName) {
        virDomainPtr dom;
        dom = conn->driver->domainLookupByName (conn, name);
        if (!dom)
            goto error;
        return dom;
    }
1825 1826

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1827 1828 1829 1830

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

D
Daniel Veillard 已提交
1834
/**
1835
 * virDomainDestroy:
D
Daniel Veillard 已提交
1836 1837 1838
 * @domain: a domain object
 *
 * Destroy the domain object. The running instance is shutdown if not down
1839 1840 1841
 * 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 已提交
1842 1843
 *
 * Returns 0 in case of success and -1 in case of failure.
1844
 */
D
Daniel Veillard 已提交
1845
int
1846 1847
virDomainDestroy(virDomainPtr domain)
{
1848
    virConnectPtr conn;
1849

1850 1851
    DEBUG("domain=%p", domain);

1852 1853
    virResetLastError();

D
Daniel Veillard 已提交
1854
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1855
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1856
        return (-1);
D
Daniel Veillard 已提交
1857
    }
1858

1859
    conn = domain->conn;
1860 1861
    if (conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1862
        goto error;
1863
    }
1864

1865 1866 1867 1868 1869 1870 1871
    if (conn->driver->domainDestroy) {
        int ret;
        ret = conn->driver->domainDestroy (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1872

1873
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1874 1875 1876 1877

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
1878
    return -1;
1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
}

/**
 * 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
1891 1892
virDomainFree(virDomainPtr domain)
{
1893 1894
    DEBUG("domain=%p", domain);

1895 1896 1897
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1898
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1899
        return (-1);
D
Daniel Veillard 已提交
1900
    }
1901
    if (virUnrefDomain(domain) < 0)
1902
        return -1;
1903
    return(0);
D
Daniel Veillard 已提交
1904 1905
}

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

1956 1957
    virResetLastError();

D
Daniel Veillard 已提交
1958
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
1959
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
1960
        return (-1);
D
Daniel Veillard 已提交
1961
    }
1962 1963
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
1964
        goto error;
1965
    }
D
Daniel Veillard 已提交
1966

1967 1968
    conn = domain->conn;

1969 1970 1971 1972 1973 1974 1975
    if (conn->driver->domainSuspend) {
        int ret;
        ret = conn->driver->domainSuspend (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
1976

1977
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
1978 1979 1980 1981

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

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

2001 2002
    virResetLastError();

D
Daniel Veillard 已提交
2003
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2004
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2005
        return (-1);
D
Daniel Veillard 已提交
2006
    }
2007 2008
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2009
        goto error;
2010
    }
D
Daniel Veillard 已提交
2011

2012 2013
    conn = domain->conn;

2014 2015 2016 2017 2018 2019 2020
    if (conn->driver->domainResume) {
        int ret;
        ret = conn->driver->domainResume (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2021

2022
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2023 2024 2025 2026

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

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

2049 2050
    virResetLastError();

D
Daniel Veillard 已提交
2051
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2052
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2053
        return (-1);
D
Daniel Veillard 已提交
2054
    }
2055 2056
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2057
        goto error;
2058
    }
2059
    conn = domain->conn;
D
Daniel Veillard 已提交
2060 2061
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2062
        goto error;
D
Daniel Veillard 已提交
2063
    }
2064

2065 2066 2067 2068 2069
    /*
     * 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] != '/') {
2070
        unsigned int len, t;
2071

2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
        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];
2082 2083 2084

    }

2085 2086 2087 2088 2089 2090 2091
    if (conn->driver->domainSave) {
        int ret;
        ret = conn->driver->domainSave (domain, to);
        if (ret < 0)
            goto error;
        return ret;
    }
2092

2093
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2094 2095 2096 2097

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2098
    return -1;
2099 2100 2101 2102
}

/**
 * virDomainRestore:
2103
 * @conn: pointer to the hypervisor connection
2104
 * @from: path to the
2105 2106 2107 2108 2109 2110
 *
 * This method will restore a domain saved to disk by virDomainSave().
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
2111 2112
virDomainRestore(virConnectPtr conn, const char *from)
{
2113
    char filepath[4096];
2114
    DEBUG("conn=%p, from=%s", conn, from);
2115

2116 2117
    virResetLastError();

D
Daniel Veillard 已提交
2118
    if (!VIR_IS_CONNECT(conn)) {
2119
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
2120
        return (-1);
D
Daniel Veillard 已提交
2121
    }
2122 2123
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2124
        goto error;
2125
    }
D
Daniel Veillard 已提交
2126 2127
    if (from == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
2128
        goto error;
D
Daniel Veillard 已提交
2129 2130
    }

2131 2132 2133 2134 2135
    /*
     * 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] != '/') {
2136 2137 2138
        unsigned int len, t;

        t = strlen(from);
2139 2140 2141 2142 2143
        if (getcwd(filepath, sizeof(filepath) - (t + 3)) == NULL) {
            virLibConnError(conn, VIR_ERR_SYSTEM_ERROR,
                            _("cannot get working directory"));
            goto error;
        }
2144 2145
        len = strlen(filepath);
        /* that should be covered by getcwd() semantic, but be 100% sure */
2146 2147 2148 2149 2150
        if (len > sizeof(filepath) - (t + 3)) {
            virLibConnError(conn, VIR_ERR_INTERNAL_ERROR,
                            _("path too long"));
            goto error;
        }
2151 2152 2153 2154 2155
        filepath[len] = '/';
        strcpy(&filepath[len + 1], from);
        from = &filepath[0];
    }

2156 2157 2158 2159 2160 2161 2162
    if (conn->driver->domainRestore) {
        int ret;
        ret = conn->driver->domainRestore (conn, from);
        if (ret < 0)
            goto error;
        return ret;
    }
2163

2164
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2165 2166 2167 2168

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
2169
    return -1;
D
Daniel Veillard 已提交
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
}

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

2191 2192
    virResetLastError();

D
Daniel Veillard 已提交
2193
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2194
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
D
Daniel Veillard 已提交
2195 2196 2197 2198
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2199
        goto error;
D
Daniel Veillard 已提交
2200 2201 2202 2203
    }
    conn = domain->conn;
    if (to == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2204
        goto error;
D
Daniel Veillard 已提交
2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
    }

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

    }

2233 2234 2235 2236 2237 2238 2239
    if (conn->driver->domainCoreDump) {
        int ret;
        ret = conn->driver->domainCoreDump (domain, to, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2240

2241
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2242 2243 2244 2245

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

2249 2250 2251 2252 2253
/**
 * virDomainShutdown:
 * @domain: a domain object
 *
 * Shutdown a domain, the domain object is still usable there after but
2254 2255
 * the domain OS is being stopped. Note that the guest OS may ignore the
 * request.
2256 2257 2258 2259 2260 2261 2262
 *
 * 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
2263 2264
virDomainShutdown(virDomainPtr domain)
{
2265
    virConnectPtr conn;
2266
    DEBUG("domain=%p", domain);
2267

2268 2269
    virResetLastError();

D
Daniel Veillard 已提交
2270
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2271
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2272
        return (-1);
D
Daniel Veillard 已提交
2273
    }
2274 2275
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2276
        goto error;
2277
    }
2278

2279 2280
    conn = domain->conn;

2281 2282 2283 2284 2285 2286 2287
    if (conn->driver->domainShutdown) {
        int ret;
        ret = conn->driver->domainShutdown (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
2288

2289
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2290 2291 2292 2293

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

2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
/**
 * 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)
{
2311
    virConnectPtr conn;
2312
    DEBUG("domain=%p, flags=%u", domain, flags);
2313

2314 2315
    virResetLastError();

2316
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2317
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2318 2319
        return (-1);
    }
2320 2321
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2322
        goto error;
2323
    }
2324

2325 2326
    conn = domain->conn;

2327 2328 2329 2330 2331 2332 2333
    if (conn->driver->domainReboot) {
        int ret;
        ret = conn->driver->domainReboot (domain, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
2334

2335
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2336 2337 2338 2339

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

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

2357 2358
    virResetLastError();

D
Daniel Veillard 已提交
2359
    if (!VIR_IS_DOMAIN(domain)) {
2360
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2361
        return (NULL);
D
Daniel Veillard 已提交
2362
    }
2363
    return (domain->name);
2364 2365
}

2366 2367 2368
/**
 * virDomainGetUUID:
 * @domain: a domain object
2369
 * @uuid: pointer to a VIR_UUID_BUFLEN bytes array
2370 2371 2372 2373 2374 2375
 *
 * Get the UUID for a domain
 *
 * Returns -1 in case of error, 0 in case of success
 */
int
2376 2377
virDomainGetUUID(virDomainPtr domain, unsigned char *uuid)
{
2378 2379
    DEBUG("domain=%p, uuid=%p", domain, uuid);

2380 2381
    virResetLastError();

D
Daniel Veillard 已提交
2382
    if (!VIR_IS_DOMAIN(domain)) {
2383
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2384
        return (-1);
D
Daniel Veillard 已提交
2385 2386 2387
    }
    if (uuid == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2388 2389
        /* Copy to connection error object for back compatability */
        virSetConnError(domain->conn);
2390
        return (-1);
D
Daniel Veillard 已提交
2391 2392
    }

2393 2394
    memcpy(uuid, &domain->uuid[0], VIR_UUID_BUFLEN);

2395
    return (0);
2396 2397
}

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

2414 2415
    virResetLastError();

K
Karel Zak 已提交
2416
    if (!VIR_IS_DOMAIN(domain)) {
2417
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
K
Karel Zak 已提交
2418 2419 2420 2421
        return (-1);
    }
    if (buf == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2422
        goto error;
K
Karel Zak 已提交
2423
    }
2424

K
Karel Zak 已提交
2425
    if (virDomainGetUUID(domain, &uuid[0]))
2426
        goto error;
K
Karel Zak 已提交
2427

2428
    virUUIDFormat(uuid, buf);
K
Karel Zak 已提交
2429
    return (0);
2430 2431 2432 2433 2434

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

2437
/**
2438
 * virDomainGetID:
2439 2440 2441 2442 2443 2444 2445
 * @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
2446 2447
virDomainGetID(virDomainPtr domain)
{
2448 2449
    DEBUG("domain=%p", domain);

2450 2451
    virResetLastError();

D
Daniel Veillard 已提交
2452
    if (!VIR_IS_DOMAIN(domain)) {
2453
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2454
        return ((unsigned int) -1);
D
Daniel Veillard 已提交
2455
    }
2456
    return (domain->id);
2457 2458
}

2459 2460 2461 2462 2463 2464
/**
 * virDomainGetOSType:
 * @domain: a domain object
 *
 * Get the type of domain operation system.
 *
2465 2466
 * Returns the new string or NULL in case of error, the string must be
 *         freed by the caller.
2467 2468
 */
char *
2469 2470
virDomainGetOSType(virDomainPtr domain)
{
2471
    virConnectPtr conn;
2472
    DEBUG("domain=%p", domain);
2473

2474 2475 2476
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2477
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2478
        return (NULL);
D
Daniel Veillard 已提交
2479
    }
2480

2481 2482
    conn = domain->conn;

2483 2484 2485 2486 2487 2488 2489
    if (conn->driver->domainGetOSType) {
        char *ret;
        ret = conn->driver->domainGetOSType (domain);
        if (!ret)
            goto error;
        return ret;
    }
2490

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

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

2499
/**
2500
 * virDomainGetMaxMemory:
2501
 * @domain: a domain object or NULL
2502
 *
2503 2504 2505 2506 2507 2508 2509
 * 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
2510 2511
virDomainGetMaxMemory(virDomainPtr domain)
{
2512
    virConnectPtr conn;
2513
    DEBUG("domain=%p", domain);
2514

2515 2516
    virResetLastError();

D
Daniel Veillard 已提交
2517
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2518
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2519
        return (0);
D
Daniel Veillard 已提交
2520
    }
2521

2522 2523
    conn = domain->conn;

2524 2525 2526 2527 2528 2529 2530
    if (conn->driver->domainGetMaxMemory) {
        unsigned long ret;
        ret = conn->driver->domainGetMaxMemory (domain);
        if (ret == 0)
            goto error;
        return ret;
    }
2531

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
2537
    return 0;
2538 2539
}

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

2558 2559
    virResetLastError();

2560
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2561
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2562
        return (-1);
2563
    }
2564 2565
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2566
        goto error;
2567 2568 2569
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2570
        goto error;
2571
    }
2572
    conn = domain->conn;
2573

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

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

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

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

2608 2609
    virResetLastError();

2610
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2611
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2612
        return (-1);
2613
    }
2614 2615
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2616
        goto error;
2617 2618 2619
    }
    if (memory < 4096) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2620
        goto error;
2621 2622 2623
    }

    conn = domain->conn;
2624

2625 2626 2627 2628 2629 2630 2631
    if (conn->driver->domainSetMemory) {
        int ret;
        ret = conn->driver->domainSetMemory (domain, memory);
        if (ret < 0)
            goto error;
        return ret;
    }
2632

2633
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2634 2635 2636 2637

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

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

2658 2659
    virResetLastError();

D
Daniel Veillard 已提交
2660
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2661
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2662
        return (-1);
D
Daniel Veillard 已提交
2663 2664 2665
    }
    if (info == NULL) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
2666
        goto error;
D
Daniel Veillard 已提交
2667
    }
2668

2669
    memset(info, 0, sizeof(virDomainInfo));
2670

2671 2672
    conn = domain->conn;

2673 2674 2675 2676 2677 2678 2679
    if (conn->driver->domainGetInfo) {
        int ret;
        ret = conn->driver->domainGetInfo (domain, info);
        if (ret < 0)
            goto error;
        return ret;
    }
2680

2681
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2682 2683 2684 2685

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

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

2706 2707 2708
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
2709
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2710
        return (NULL);
D
Daniel Veillard 已提交
2711
    }
2712

2713 2714
    conn = domain->conn;

2715 2716 2717 2718 2719 2720
    if ((conn->flags & VIR_CONNECT_RO) && (flags & VIR_DOMAIN_XML_SECURE)) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED,
                        _("virDomainGetXMLDesc with secure flag"));
        goto error;
    }

2721 2722 2723 2724 2725 2726 2727
    if (conn->driver->domainDumpXML) {
        char *ret;
        ret = conn->driver->domainDumpXML (domain, flags);
        if (!ret)
            goto error;
        return ret;
    }
2728

2729
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2730 2731 2732 2733

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

2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841
/**
 * 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;
}


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 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
/**
 * 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 已提交
2902 2903
    char *dom_xml = NULL;
    int cookielen = 0, ret, version = 0;
2904
    DEBUG("domain=%p, dconn=%p, flags=%lu, dname=%s, uri=%s, bandwidth=%lu",
2905
          domain, dconn, flags, NULLSTR(dname), NULLSTR(uri), bandwidth);
2906

2907 2908 2909
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
2910
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
2911 2912 2913 2914 2915
        return NULL;
    }
    conn = domain->conn;        /* Source connection. */
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
2916
        goto error;
2917 2918
    }

2919 2920
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2921
        goto error;
2922 2923 2924 2925
    }
    if (dconn->flags & VIR_CONNECT_RO) {
        /* NB, delibrately report error against source object, not dest here */
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
2926
        goto error;
2927 2928
    }

2929
    /* Check that migration is supported by both drivers. */
D
Daniel Veillard 已提交
2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940
    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 {
2941
        virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
2942
        goto error;
2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
    }

    /* 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 已提交
2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968
    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);
2969
    }
D
Daniel Veillard 已提交
2970 2971 2972 2973 2974 2975 2976
    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__);
2977
            goto error;
D
Daniel Veillard 已提交
2978 2979 2980
        }
        dom_xml = conn->driver->domainDumpXML (domain,
                                               VIR_DOMAIN_XML_SECURE);
2981

D
Daniel Veillard 已提交
2982
        if (!dom_xml)
2983
            goto error;
D
Daniel Veillard 已提交
2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998

        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);
    }
2999 3000 3001 3002 3003 3004 3005

    /* 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 已提交
3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027
    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);
    }
3028 3029

 done:
3030 3031
    free (uri_out);
    free (cookie);
3032
    return ddomain;
3033 3034 3035 3036 3037

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

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

3058 3059
    virResetLastError();

3060
    if (!VIR_IS_CONNECT (dconn)) {
3061
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3062 3063 3064
        return -1;
    }

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

3070 3071 3072 3073 3074 3075 3076 3077 3078
    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;
    }
3079 3080

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3085 3086 3087
    return -1;
}

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

3106 3107 3108
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN (domain)) {
3109
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3110 3111 3112 3113
        return -1;
    }
    conn = domain->conn;

3114 3115
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3116
        goto error;
3117 3118
    }

3119 3120 3121 3122 3123 3124 3125 3126 3127
    if (conn->driver->domainMigratePerform) {
        int ret;
        ret = conn->driver->domainMigratePerform (domain, cookie, cookielen,
                                                  uri,
                                                  flags, dname, bandwidth);
        if (ret < 0)
            goto error;
        return ret;
    }
3128 3129

    virLibDomainError (domain, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3130 3131 3132 3133

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

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

3153 3154
    virResetLastError();

3155
    if (!VIR_IS_CONNECT (dconn)) {
3156
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3157 3158 3159
        return NULL;
    }

3160 3161
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3162
        goto error;
3163 3164
    }

3165 3166 3167 3168 3169 3170 3171 3172 3173
    if (dconn->driver->domainMigrateFinish) {
        virDomainPtr ret;
        ret = dconn->driver->domainMigrateFinish (dconn, dname,
                                                  cookie, cookielen,
                                                  uri, flags);
        if (!ret)
            goto error;
        return ret;
    }
3174 3175

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3176 3177 3178 3179

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
3180
    return NULL;
D
Daniel Veillard 已提交
3181 3182 3183
}


D
Daniel Veillard 已提交
3184 3185
/*
 * Not for public use.  This function is part of the internal
D
Daniel Veillard 已提交
3186 3187 3188
 * implementation of migration in the remote case.
 */
int
D
Daniel P. Berrange 已提交
3189 3190 3191 3192 3193 3194 3195 3196 3197
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 已提交
3198
{
J
John Levon 已提交
3199 3200 3201 3202
    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 已提交
3203

3204 3205
    virResetLastError();

D
Daniel Veillard 已提交
3206 3207 3208 3209 3210
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return -1;
    }

3211 3212
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3213
        goto error;
3214 3215
    }

3216 3217 3218 3219 3220 3221 3222 3223 3224 3225
    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 已提交
3226 3227

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3228 3229 3230 3231

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

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

3252 3253
    virResetLastError();

D
Daniel Veillard 已提交
3254 3255 3256 3257 3258
    if (!VIR_IS_CONNECT (dconn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

3259 3260
    if (dconn->flags & VIR_CONNECT_RO) {
        virLibConnError(dconn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3261
        goto error;
3262 3263
    }

3264 3265 3266 3267 3268 3269 3270 3271 3272 3273
    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 已提交
3274 3275

    virLibConnError (dconn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3276 3277 3278 3279

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dconn);
D
Daniel Veillard 已提交
3280
    return NULL;
3281 3282 3283
}


3284 3285 3286 3287
/**
 * virNodeGetInfo:
 * @conn: pointer to the hypervisor connection
 * @info: pointer to a virNodeInfo structure allocated by the user
3288
 *
3289 3290 3291 3292 3293
 * Extract hardware information about the node.
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
3294 3295
virNodeGetInfo(virConnectPtr conn, virNodeInfoPtr info)
{
3296 3297
    DEBUG("conn=%p, info=%p", conn, info);

3298 3299
    virResetLastError();

3300
    if (!VIR_IS_CONNECT(conn)) {
3301
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3302 3303 3304 3305
        return (-1);
    }
    if (info == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3306
        goto error;
3307 3308
    }

3309 3310 3311 3312 3313 3314 3315
    if (conn->driver->nodeGetInfo) {
        int ret;
        ret = conn->driver->nodeGetInfo (conn, info);
        if (ret < 0)
            goto error;
        return ret;
    }
3316

3317
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3318 3319 3320 3321

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

3325 3326 3327 3328 3329 3330
/**
 * virConnectGetCapabilities:
 * @conn: pointer to the hypervisor connection
 *
 * Provides capabilities of the hypervisor / driver.
 *
3331 3332
 * Returns NULL in case of error, or an XML string
 * defining the capabilities.
3333 3334 3335 3336 3337
 * The client must free the returned string after use.
 */
char *
virConnectGetCapabilities (virConnectPtr conn)
{
3338 3339
    DEBUG("conn=%p", conn);

3340 3341
    virResetLastError();

3342
    if (!VIR_IS_CONNECT (conn)) {
3343
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3344 3345 3346
        return NULL;
    }

3347 3348 3349 3350 3351 3352 3353
    if (conn->driver->getCapabilities) {
        char *ret;
        ret = conn->driver->getCapabilities (conn);
        if (!ret)
            goto error;
        return ret;
    }
3354

3355
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3356 3357 3358 3359

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

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

3378 3379
    virResetLastError();

3380 3381 3382 3383 3384
    if (!VIR_IS_CONNECT (conn)) {
        virLibConnError (NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return 0;
    }

3385 3386 3387 3388 3389 3390 3391
    if (conn->driver->getFreeMemory) {
        unsigned long long ret;
        ret = conn->driver->getFreeMemory (conn);
        if (ret == 0)
            goto error;
        return ret;
    }
3392 3393

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3394 3395 3396 3397

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3398 3399 3400
    return 0;
}

3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414
/**
 * 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;
3415
    DEBUG("domain=%p, nparams=%p", domain, nparams);
3416

3417 3418
    virResetLastError();

3419
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3420
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3421 3422 3423 3424 3425 3426
        return NULL;
    }
    conn = domain->conn;

    if (conn->driver->domainGetSchedulerType){
        schedtype = conn->driver->domainGetSchedulerType (domain, nparams);
3427 3428
        if (!schedtype)
            goto error;
3429 3430 3431
        return schedtype;
    }

3432
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3433 3434 3435 3436

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456
    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,
3457
                                virSchedParameterPtr params, int *nparams)
3458 3459
{
    virConnectPtr conn;
3460
    DEBUG("domain=%p, params=%p, nparams=%p", domain, params, nparams);
3461

3462 3463
    virResetLastError();

3464
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3465
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3466 3467 3468 3469
        return -1;
    }
    conn = domain->conn;

3470 3471 3472 3473 3474 3475 3476
    if (conn->driver->domainGetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainGetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3477

3478
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3479 3480 3481 3482

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498
    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
3499
virDomainSetSchedulerParameters(virDomainPtr domain,
3500
                                virSchedParameterPtr params, int nparams)
3501 3502
{
    virConnectPtr conn;
3503
    DEBUG("domain=%p, params=%p, nparams=%d", domain, params, nparams);
3504

3505 3506
    virResetLastError();

3507
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3508
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3509 3510
        return -1;
    }
3511 3512
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3513
        goto error;
3514
    }
3515 3516
    conn = domain->conn;

3517 3518 3519 3520 3521 3522 3523
    if (conn->driver->domainSetSchedulerParameters) {
        int ret;
        ret = conn->driver->domainSetSchedulerParameters (domain, params, nparams);
        if (ret < 0)
            goto error;
        return ret;
    }
3524

3525
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3526 3527 3528 3529

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3530 3531 3532 3533
    return -1;
}


3534
/**
3535
 * virDomainBlockStats:
3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564
 * @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);

3565 3566
    virResetLastError();

3567
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3568
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3569 3570
        return -1;
    }
3571 3572 3573 3574
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3575 3576 3577 3578
    conn = dom->conn;

    if (conn->driver->domainBlockStats) {
        if (conn->driver->domainBlockStats (dom, path, &stats2) == -1)
3579
            goto error;
3580 3581 3582 3583 3584 3585

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3586 3587 3588 3589

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dom->conn);
3590 3591 3592 3593
    return -1;
}

/**
3594
 * virDomainInterfaceStats:
3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622
 * @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);

3623 3624
    virResetLastError();

3625
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
3626
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3627 3628
        return -1;
    }
3629 3630 3631 3632
    if (!stats || size > sizeof stats2) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG, __FUNCTION__);
        goto error;
    }
3633 3634 3635 3636
    conn = dom->conn;

    if (conn->driver->domainInterfaceStats) {
        if (conn->driver->domainInterfaceStats (dom, path, &stats2) == -1)
3637
            goto error;
3638 3639 3640 3641 3642 3643

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

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3644 3645 3646 3647

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

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

3702 3703
    virResetLastError();

R
Richard W.M. Jones 已提交
3704 3705 3706 3707 3708
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;
3709

3710 3711
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3712
        goto error;
3713 3714
    }

R
Richard W.M. Jones 已提交
3715 3716 3717
    if (!path) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("path is NULL"));
3718
        goto error;
R
Richard W.M. Jones 已提交
3719 3720 3721 3722 3723
    }

    if (flags != 0) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags must be zero"));
3724
        goto error;
R
Richard W.M. Jones 已提交
3725 3726 3727 3728 3729 3730
    }

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

3734 3735 3736 3737 3738 3739 3740 3741
    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 已提交
3742 3743

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3744 3745 3746 3747

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

R
Richard W.M. Jones 已提交
3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792
/**
 * 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);

3793 3794
    virResetLastError();

R
Richard W.M. Jones 已提交
3795 3796 3797 3798 3799 3800
    if (!VIR_IS_CONNECTED_DOMAIN (dom)) {
        virLibDomainError (NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
        return -1;
    }
    conn = dom->conn;

3801 3802
    if (dom->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(dom, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3803
        goto error;
3804 3805
    }

R
Richard W.M. Jones 已提交
3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829
    /* Flags must be VIR_MEMORY_VIRTUAL at the moment.
     *
     * Note on access to physical memory: A VIR_MEMORY_PHYSICAL flag is
     * a possibility.  However it isn't really useful unless the caller
     * can also access registers, particularly CR3 on x86 in order to
     * get the Page Table Directory.  Since registers are different on
     * every architecture, that would imply another call to get the
     * machine registers.
     *
     * The QEMU driver handles only VIR_MEMORY_VIRTUAL, mapping it
     * to the qemu 'memsave' command which does the virtual to physical
     * mapping inside qemu.
     *
     * At time of writing there is no Xen driver.  However the Xen
     * hypervisor only lets you map physical pages from other domains,
     * and so the Xen driver would have to do the virtual to physical
     * mapping by chasing 2, 3 or 4-level page tables from the PTD.
     * There is example code in libxc (xc_translate_foreign_address)
     * which does this, although we cannot copy this code directly
     * because of incompatible licensing.
     */
    if (flags != VIR_MEMORY_VIRTUAL) {
        virLibDomainError (dom, VIR_ERR_INVALID_ARG,
                           _("flags parameter must be VIR_MEMORY_VIRTUAL"));
3830
        goto error;
R
Richard W.M. Jones 已提交
3831 3832 3833 3834 3835 3836
    }

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

3840 3841 3842 3843 3844 3845 3846 3847
    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 已提交
3848 3849

    virLibDomainError (dom, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3850 3851 3852 3853

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

3857

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

3880 3881
    virResetLastError();

3882
    if (!VIR_IS_CONNECT(conn)) {
3883
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3884 3885
        return (NULL);
    }
3886 3887
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3888
        goto error;
3889
    }
3890 3891
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
3892
        goto error;
3893 3894
    }

3895 3896 3897 3898 3899 3900 3901
    if (conn->driver->domainDefineXML) {
        virDomainPtr ret;
        ret = conn->driver->domainDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
3902

3903
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3904 3905 3906 3907

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3908
    return NULL;
3909 3910 3911 3912 3913 3914
}

/**
 * virDomainUndefine:
 * @domain: pointer to a defined domain
 *
3915
 * Undefine a domain but does not stop it if it is running
3916 3917 3918 3919 3920
 *
 * Returns 0 in case of success, -1 in case of error
 */
int
virDomainUndefine(virDomainPtr domain) {
3921
    virConnectPtr conn;
3922
    DEBUG("domain=%p", domain);
3923

3924 3925
    virResetLastError();

3926
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
3927
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
3928 3929
        return (-1);
    }
3930 3931
    conn = domain->conn;
    if (conn->flags & VIR_CONNECT_RO) {
3932
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
3933
        goto error;
3934 3935
    }

3936 3937 3938 3939 3940 3941 3942
    if (conn->driver->domainUndefine) {
        int ret;
        ret = conn->driver->domainUndefine (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
3943

3944
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3945 3946 3947 3948

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
3949
    return -1;
3950 3951 3952 3953 3954 3955
}

/**
 * virConnectNumOfDefinedDomains:
 * @conn: pointer to the hypervisor connection
 *
3956
 * Provides the number of defined but inactive domains.
3957 3958 3959 3960 3961 3962
 *
 * Returns the number of domain found or -1 in case of error
 */
int
virConnectNumOfDefinedDomains(virConnectPtr conn)
{
3963 3964
    DEBUG("conn=%p", conn);

3965 3966
    virResetLastError();

3967
    if (!VIR_IS_CONNECT(conn)) {
3968
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
3969 3970 3971
        return (-1);
    }

3972 3973 3974 3975 3976 3977 3978
    if (conn->driver->numOfDefinedDomains) {
        int ret;
        ret = conn->driver->numOfDefinedDomains (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
3979

3980
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
3981 3982 3983 3984

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
3985
    return -1;
3986 3987 3988 3989 3990 3991 3992 3993
}

/**
 * virConnectListDefinedDomains:
 * @conn: pointer to the hypervisor connection
 * @names: pointer to an array to store the names
 * @maxnames: size of the array
 *
3994 3995
 * list the defined but inactive domains, stores the pointers to the names
 * in @names
3996
 *
3997 3998 3999
 * Returns the number of names provided in the array or -1 in case of error
 */
int
4000
virConnectListDefinedDomains(virConnectPtr conn, char **const names,
4001
                             int maxnames) {
4002 4003
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4004 4005
    virResetLastError();

4006
    if (!VIR_IS_CONNECT(conn)) {
4007
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4008 4009 4010
        return (-1);
    }

4011
    if ((names == NULL) || (maxnames < 0)) {
4012
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4013
        goto error;
4014 4015
    }

4016 4017 4018 4019 4020 4021 4022
    if (conn->driver->listDefinedDomains) {
        int ret;
        ret = conn->driver->listDefinedDomains (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4023

4024
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4025 4026 4027 4028

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4029
    return -1;
4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042
}

/**
 * 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) {
4043
    virConnectPtr conn;
4044
    DEBUG("domain=%p", domain);
4045

4046 4047
    virResetLastError();

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

4058 4059 4060 4061 4062 4063 4064
    if (conn->driver->domainCreate) {
        int ret;
        ret = conn->driver->domainCreate (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4065

4066
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4067 4068 4069 4070

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

4074 4075 4076
/**
 * virDomainGetAutostart:
 * @domain: a domain object
4077
 * @autostart: the value returned
4078
 *
4079
 * Provides a boolean value indicating whether the domain
4080 4081 4082 4083 4084 4085 4086
 * 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,
4087 4088 4089
                      int *autostart)
{
    virConnectPtr conn;
4090
    DEBUG("domain=%p, autostart=%p", domain, autostart);
4091

4092 4093 4094
    virResetLastError();

    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4095
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4096 4097 4098 4099
        return (-1);
    }
    if (!autostart) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4100
        goto error;
4101 4102
    }

4103 4104
    conn = domain->conn;

4105 4106 4107 4108 4109 4110 4111
    if (conn->driver->domainGetAutostart) {
        int ret;
        ret = conn->driver->domainGetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4112

4113
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4114 4115 4116 4117

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4118
    return -1;
4119 4120 4121 4122 4123
}

/**
 * virDomainSetAutostart:
 * @domain: a domain object
4124
 * @autostart: whether the domain should be automatically started 0 or 1
4125 4126 4127 4128 4129 4130 4131 4132
 *
 * 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,
4133 4134 4135
                      int autostart)
{
    virConnectPtr conn;
4136
    DEBUG("domain=%p, autostart=%d", domain, autostart);
4137

4138 4139 4140
    virResetLastError();

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

4145 4146
    conn = domain->conn;

4147 4148
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4149
        goto error;
4150 4151
    }

4152 4153 4154 4155 4156 4157 4158
    if (conn->driver->domainSetAutostart) {
        int ret;
        ret = conn->driver->domainSetAutostart (domain, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
4159

4160
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4161 4162 4163 4164

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

4168 4169 4170 4171 4172 4173 4174 4175
/**
 * 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.
4176
 * This function requires privileged access to the hypervisor.
4177 4178 4179 4180 4181 4182 4183
 *
 * Returns 0 in case of success, -1 in case of failure.
 */

int
virDomainSetVcpus(virDomainPtr domain, unsigned int nvcpus)
{
4184
    virConnectPtr conn;
4185
    DEBUG("domain=%p, nvcpus=%u", domain, nvcpus);
4186

4187 4188
    virResetLastError();

4189
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4190
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4191 4192
        return (-1);
    }
4193 4194
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4195
        goto error;
4196
    }
4197

4198 4199
    if (nvcpus < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4200
        goto error;
4201
    }
4202
    conn = domain->conn;
4203

4204 4205 4206 4207 4208 4209 4210
    if (conn->driver->domainSetVcpus) {
        int ret;
        ret = conn->driver->domainSetVcpus (domain, nvcpus);
        if (ret < 0)
            goto error;
        return ret;
    }
4211

4212
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4213 4214 4215 4216

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4217
    return -1;
4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231
}

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

4245 4246
    virResetLastError();

4247
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4248
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4249 4250
        return (-1);
    }
4251 4252
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4253
        goto error;
4254
    }
4255

4256
    if ((vcpu > 32000) || (cpumap == NULL) || (maplen < 1)) {
4257
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4258
       goto error;
4259
    }
4260

4261 4262
    conn = domain->conn;

4263 4264 4265 4266 4267 4268 4269
    if (conn->driver->domainPinVcpu) {
        int ret;
        ret = conn->driver->domainPinVcpu (domain, vcpu, cpumap, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4270

4271
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4272 4273 4274 4275

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4276
    return -1;
4277 4278 4279 4280 4281 4282 4283 4284 4285
}

/**
 * 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 已提交
4286
 *	If cpumaps is NULL, then no cpumap information is returned by the API.
4287 4288 4289 4290 4291 4292 4293
 *	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...).
4294
 *
4295
 * Extract information about virtual CPUs of domain, store it in info array
D
Daniel Veillard 已提交
4296
 * and also in cpumaps if this pointer isn't NULL.
4297 4298 4299 4300 4301
 *
 * Returns the number of info filled in case of success, -1 in case of failure.
 */
int
virDomainGetVcpus(virDomainPtr domain, virVcpuInfoPtr info, int maxinfo,
4302
                  unsigned char *cpumaps, int maplen)
4303
{
4304
    virConnectPtr conn;
4305
    DEBUG("domain=%p, info=%p, maxinfo=%d, cpumaps=%p, maplen=%d", domain, info, maxinfo, cpumaps, maplen);
4306

4307 4308
    virResetLastError();

4309
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4310
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4311 4312 4313 4314
        return (-1);
    }
    if ((info == NULL) || (maxinfo < 1)) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4315
        goto error;
4316 4317 4318
    }
    if (cpumaps != NULL && maplen < 1) {
        virLibDomainError(domain, VIR_ERR_INVALID_ARG, __FUNCTION__);
4319
        goto error;
4320
    }
4321

4322 4323
    conn = domain->conn;

4324 4325 4326 4327 4328 4329 4330 4331
    if (conn->driver->domainGetVcpus) {
        int ret;
        ret = conn->driver->domainGetVcpus (domain, info, maxinfo,
                                            cpumaps, maplen);
        if (ret < 0)
            goto error;
        return ret;
    }
4332

4333
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4334 4335 4336 4337

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

4341 4342 4343
/**
 * virDomainGetMaxVcpus:
 * @domain: pointer to domain object
4344
 *
4345 4346 4347 4348 4349
 * 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.
4350 4351 4352 4353
 *
 * Returns the maximum of virtual CPU or -1 in case of error.
 */
int
4354 4355
virDomainGetMaxVcpus(virDomainPtr domain)
{
4356
    virConnectPtr conn;
4357
    DEBUG("domain=%p", domain);
4358

4359 4360
    virResetLastError();

4361
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4362
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4363 4364 4365 4366 4367
        return (-1);
    }

    conn = domain->conn;

4368 4369 4370 4371 4372 4373 4374
    if (conn->driver->domainGetMaxVcpus) {
        int ret;
        ret = conn->driver->domainGetMaxVcpus (domain);
        if (ret < 0)
            goto error;
        return ret;
    }
4375

4376
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4377 4378 4379 4380

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

4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415
/**
 * virDomainGetSecurityLabel:
 * @domain: a domain object
 * @seclabel: pointer to a virSecurityLabel structure
 *
 * Extract security label of an active domain.
 *
 * Returns 0 in case of success, -1 in case of failure, and -2
 * if the operation is not supported (caller decides if that's
 * an error).
 */
int
virDomainGetSecurityLabel(virDomainPtr domain, virSecurityLabelPtr seclabel)
{
    virConnectPtr conn;

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

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

    conn = domain->conn;

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

    virLibConnWarning(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4416
    return -1;
4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445
}

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

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

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

    virLibConnWarning(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4446
    return -1;
4447
}
4448

4449 4450 4451 4452
/**
 * virDomainAttachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4453
 *
4454 4455 4456 4457 4458
 * Create a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4459
virDomainAttachDevice(virDomainPtr domain, const char *xml)
4460 4461
{
    virConnectPtr conn;
4462
    DEBUG("domain=%p, xml=%s", domain, xml);
4463

4464 4465
    virResetLastError();

4466
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4467
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4468 4469 4470 4471
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4472
        goto error;
4473 4474 4475
    }
    conn = domain->conn;

4476 4477 4478 4479 4480 4481 4482
    if (conn->driver->domainAttachDevice) {
        int ret;
        ret = conn->driver->domainAttachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4483

4484
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4485 4486 4487 4488

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(domain->conn);
4489
    return -1;
4490 4491 4492 4493 4494 4495
}

/**
 * virDomainDetachDevice:
 * @domain: pointer to domain object
 * @xml: pointer to XML description of one device
4496
 *
4497 4498 4499 4500 4501
 * Destroy a virtual device attachment to backend.
 *
 * Returns 0 in case of success, -1 in case of failure.
 */
int
4502
virDomainDetachDevice(virDomainPtr domain, const char *xml)
4503 4504
{
    virConnectPtr conn;
4505
    DEBUG("domain=%p, xml=%s", domain, xml);
4506

4507 4508
    virResetLastError();

4509
    if (!VIR_IS_CONNECTED_DOMAIN(domain)) {
4510
        virLibDomainError(NULL, VIR_ERR_INVALID_DOMAIN, __FUNCTION__);
4511 4512 4513 4514
        return (-1);
    }
    if (domain->conn->flags & VIR_CONNECT_RO) {
        virLibDomainError(domain, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4515
        goto error;
4516 4517 4518
    }
    conn = domain->conn;

4519 4520 4521 4522 4523 4524 4525
    if (conn->driver->domainDetachDevice) {
        int ret;
        ret = conn->driver->domainDetachDevice (domain, xml);
        if (ret < 0)
            goto error;
        return ret;
    }
4526

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

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

4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556
/**
 * 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)
{
4557 4558 4559
    DEBUG("conn=%p, freeMems=%p, startCell=%d, maxCells=%d",
          conn, freeMems, startCell, maxCells);

4560 4561
    virResetLastError();

4562 4563 4564 4565 4566
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(conn, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

D
Daniel Veillard 已提交
4567
    if ((freeMems == NULL) || (maxCells <= 0) || (startCell < 0)) {
4568
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4569
        goto error;
4570 4571
    }

4572 4573 4574 4575 4576 4577 4578
    if (conn->driver->nodeGetCellsFreeMemory) {
        int ret;
        ret = conn->driver->nodeGetCellsFreeMemory (conn, freeMems, startCell, maxCells);
        if (ret < 0)
            goto error;
        return ret;
    }
4579 4580

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4581 4582 4583 4584

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

4588 4589 4590 4591
/**
 * virNetworkGetConnect:
 * @net: pointer to a network
 *
4592
 * Provides the connection pointer associated with a network.  The
4593 4594 4595
 * reference counter on the connection is not increased by this
 * call.
 *
4596 4597 4598 4599
 * WARNING: When writing libvirt bindings in other languages, do
 * not use this function.  Instead, store the connection and
 * the network object together.
 *
4600 4601 4602 4603 4604
 * Returns the virConnectPtr or NULL in case of failure.
 */
virConnectPtr
virNetworkGetConnect (virNetworkPtr net)
{
4605 4606
    DEBUG("net=%p", net);

4607 4608 4609
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK (net)) {
4610
        virLibNetworkError (NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
4611 4612 4613 4614 4615
        return NULL;
    }
    return net->conn;
}

4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626
/**
 * 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)
{
4627 4628
    DEBUG("conn=%p", conn);

4629 4630
    virResetLastError();

4631
    if (!VIR_IS_CONNECT(conn)) {
4632
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4633 4634 4635
        return (-1);
    }

4636 4637 4638 4639 4640 4641 4642
    if (conn->networkDriver && conn->networkDriver->numOfNetworks) {
        int ret;
        ret = conn->networkDriver->numOfNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4643

4644
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4645 4646 4647 4648

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4649
    return -1;
4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662
}

/**
 * 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
4663
virConnectListNetworks(virConnectPtr conn, char **const names, int maxnames)
4664
{
4665 4666
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4667 4668
    virResetLastError();

4669
    if (!VIR_IS_CONNECT(conn)) {
4670
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4671 4672 4673
        return (-1);
    }

4674
    if ((names == NULL) || (maxnames < 0)) {
4675
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4676
        goto error;
4677 4678
    }

4679 4680 4681 4682 4683 4684 4685
    if (conn->networkDriver && conn->networkDriver->listNetworks) {
        int ret;
        ret = conn->networkDriver->listNetworks (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4686

4687
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4688 4689 4690 4691

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4692
    return -1;
4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705
}

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

4708 4709
    virResetLastError();

4710
    if (!VIR_IS_CONNECT(conn)) {
4711
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4712 4713 4714
        return (-1);
    }

4715 4716 4717 4718 4719 4720 4721
    if (conn->networkDriver && conn->networkDriver->numOfDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->numOfDefinedNetworks (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
4722

4723
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4724 4725 4726 4727

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4728
    return -1;
4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741
}

/**
 * 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
4742
virConnectListDefinedNetworks(virConnectPtr conn, char **const names,
4743 4744
                              int maxnames)
{
4745 4746
    DEBUG("conn=%p, names=%p, maxnames=%d", conn, names, maxnames);

4747 4748
    virResetLastError();

4749
    if (!VIR_IS_CONNECT(conn)) {
4750
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4751 4752 4753
        return (-1);
    }

4754
    if ((names == NULL) || (maxnames < 0)) {
4755
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4756
        goto error;
4757 4758
    }

4759 4760 4761 4762 4763 4764 4765 4766
    if (conn->networkDriver && conn->networkDriver->listDefinedNetworks) {
        int ret;
        ret = conn->networkDriver->listDefinedNetworks (conn,
                                                        names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
4767

4768
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4769 4770 4771 4772

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4773
    return -1;
4774 4775 4776 4777 4778 4779 4780 4781 4782
}

/**
 * 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.
 *
4783 4784
 * 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.
4785 4786 4787 4788
 */
virNetworkPtr
virNetworkLookupByName(virConnectPtr conn, const char *name)
{
4789 4790
    DEBUG("conn=%p, name=%s", conn, name);

4791 4792
    virResetLastError();

4793
    if (!VIR_IS_CONNECT(conn)) {
4794
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4795 4796 4797 4798
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4799
        goto  error;
4800 4801
    }

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

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

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

/**
 * 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.
 *
4825 4826
 * 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.
4827 4828 4829 4830
 */
virNetworkPtr
virNetworkLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
{
4831 4832
    DEBUG("conn=%p, uuid=%s", conn, uuid);

4833 4834
    virResetLastError();

4835
    if (!VIR_IS_CONNECT(conn)) {
4836
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4837 4838 4839 4840
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4841
        goto error;
4842 4843
    }

4844 4845 4846 4847 4848 4849 4850
    if (conn->networkDriver && conn->networkDriver->networkLookupByUUID){
        virNetworkPtr ret;
        ret = conn->networkDriver->networkLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
4851

4852
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4853 4854 4855 4856

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4857
    return NULL;
4858 4859 4860 4861 4862 4863 4864 4865 4866
}

/**
 * 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.
 *
4867 4868
 * 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.
4869 4870 4871 4872 4873 4874 4875
 */
virNetworkPtr
virNetworkLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
{
    int raw[VIR_UUID_BUFLEN], i;
    unsigned char uuid[VIR_UUID_BUFLEN];
    int ret;
4876
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);
4877

4878 4879
    virResetLastError();

4880
    if (!VIR_IS_CONNECT(conn)) {
4881
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4882 4883 4884 4885
        return (NULL);
    }
    if (uuidstr == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4886
        goto error;
4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903
    }

    /* 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) {
4904
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4905
        goto error;
4906 4907 4908 4909 4910
    }
    for (i = 0; i < VIR_UUID_BUFLEN; i++)
        uuid[i] = raw[i] & 0xFF;

    return virNetworkLookupByUUID(conn, &uuid[0]);
4911 4912 4913 4914 4915

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930
}

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

4933 4934
    virResetLastError();

4935
    if (!VIR_IS_CONNECT(conn)) {
4936
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4937 4938 4939 4940
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4941
        goto error;
4942 4943 4944
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4945
        goto error;
4946 4947
    }

4948 4949 4950 4951 4952 4953 4954
    if (conn->networkDriver && conn->networkDriver->networkCreateXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkCreateXML (conn, xmlDesc);
        if (!ret)
            goto error;
        return ret;
    }
4955

4956
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
4957 4958 4959 4960

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
4961
    return NULL;
4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973
}

/**
 * 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
4974 4975
virNetworkDefineXML(virConnectPtr conn, const char *xml)
{
4976 4977
    DEBUG("conn=%p, xml=%s", conn, xml);

4978 4979
    virResetLastError();

4980
    if (!VIR_IS_CONNECT(conn)) {
4981
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
4982 4983 4984 4985
        return (NULL);
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
4986
        goto error;
4987 4988 4989
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
4990
        goto error;
4991 4992
    }

4993 4994 4995 4996 4997 4998 4999
    if (conn->networkDriver && conn->networkDriver->networkDefineXML) {
        virNetworkPtr ret;
        ret = conn->networkDriver->networkDefineXML (conn, xml);
        if (!ret)
            goto error;
        return ret;
    }
5000

5001
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5002 5003 5004 5005

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
5006
    return NULL;
5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019
}

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

5022 5023
    virResetLastError();

5024
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5025
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5026 5027 5028 5029 5030
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5031
        goto error;
5032 5033
    }

5034 5035 5036 5037 5038 5039 5040
    if (conn->networkDriver && conn->networkDriver->networkUndefine) {
        int ret;
        ret = conn->networkDriver->networkUndefine (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5041

5042
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5043 5044 5045 5046

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5047
    return -1;
5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059
}

/**
 * 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
5060 5061
virNetworkCreate(virNetworkPtr network)
{
5062
    virConnectPtr conn;
5063 5064
    DEBUG("network=%p", network);

5065 5066
    virResetLastError();

5067
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5068
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5069 5070 5071 5072 5073
        return (-1);
    }
    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5074
        goto error;
5075 5076
    }

5077 5078 5079 5080 5081 5082 5083
    if (conn->networkDriver && conn->networkDriver->networkCreate) {
        int ret;
        ret = conn->networkDriver->networkCreate (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5084

5085
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5086 5087 5088 5089

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5090
    return -1;
5091 5092 5093 5094 5095 5096 5097
}

/**
 * virNetworkDestroy:
 * @network: a network object
 *
 * Destroy the network object. The running instance is shutdown if not down
5098 5099 5100
 * 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
5101 5102 5103 5104 5105 5106 5107
 *
 * Returns 0 in case of success and -1 in case of failure.
 */
int
virNetworkDestroy(virNetworkPtr network)
{
    virConnectPtr conn;
5108
    DEBUG("network=%p", network);
5109

5110 5111
    virResetLastError();

5112
    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5113
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5114 5115 5116 5117 5118 5119
        return (-1);
    }

    conn = network->conn;
    if (conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5120
        goto error;
5121 5122
    }

5123 5124 5125 5126 5127 5128 5129
    if (conn->networkDriver && conn->networkDriver->networkDestroy) {
        int ret;
        ret = conn->networkDriver->networkDestroy (network);
        if (ret < 0)
            goto error;
        return ret;
    }
5130

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

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

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

5153 5154 5155
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5156
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5157 5158
        return (-1);
    }
5159
    if (virUnrefNetwork(network) < 0)
5160 5161 5162 5163
        return (-1);
    return(0);
}

5164 5165
/**
 * virNetworkRef:
D
Daniel Veillard 已提交
5166
 * @network: the network to hold a reference on
5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
 *
 * 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 已提交
5178 5179
 *
 * Returns 0 in case of success, -1 in case of failure.
5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194
 */
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;
}

5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206
/**
 * 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)
{
5207 5208
    DEBUG("network=%p", network);

5209 5210
    virResetLastError();

5211
    if (!VIR_IS_NETWORK(network)) {
5212
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229
        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)
{
5230 5231
    DEBUG("network=%p, uuid=%p", network, uuid);

5232 5233
    virResetLastError();

5234
    if (!VIR_IS_NETWORK(network)) {
5235
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5236 5237 5238 5239
        return (-1);
    }
    if (uuid == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5240
        goto error;
5241 5242 5243 5244 5245
    }

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

    return (0);
5246 5247 5248 5249 5250

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
    return -1;
5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266
}

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

5269 5270
    virResetLastError();

5271
    if (!VIR_IS_NETWORK(network)) {
5272
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5273 5274 5275 5276
        return (-1);
    }
    if (buf == NULL) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5277
        goto error;
5278 5279 5280
    }

    if (virNetworkGetUUID(network, &uuid[0]))
5281
        return (-1);
5282

5283
    virUUIDFormat(uuid, buf);
5284
    return (0);
5285 5286 5287 5288 5289

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

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

5309 5310 5311
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5312
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5313 5314 5315 5316
        return (NULL);
    }
    if (flags != 0) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5317
        goto error;
5318 5319
    }

5320 5321
    conn = network->conn;

5322 5323 5324 5325 5326 5327 5328
    if (conn->networkDriver && conn->networkDriver->networkDumpXML) {
        char *ret;
        ret = conn->networkDriver->networkDumpXML (network, flags);
        if (!ret)
            goto error;
        return ret;
    }
5329

5330
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5331 5332 5333 5334

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5335
    return NULL;
5336
}
5337 5338 5339 5340 5341

/**
 * virNetworkGetBridgeName:
 * @network: a network object
 *
5342
 * Provides a bridge interface name to which a domain may connect
5343 5344 5345 5346 5347 5348 5349 5350
 * 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)
{
5351
    virConnectPtr conn;
5352
    DEBUG("network=%p", network);
5353

5354 5355 5356
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5357
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5358 5359 5360
        return (NULL);
    }

5361 5362
    conn = network->conn;

5363 5364 5365 5366 5367 5368 5369
    if (conn->networkDriver && conn->networkDriver->networkGetBridgeName) {
        char *ret;
        ret = conn->networkDriver->networkGetBridgeName (network);
        if (!ret)
            goto error;
        return ret;
    }
5370

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

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5376
    return NULL;
5377
}
5378 5379 5380 5381

/**
 * virNetworkGetAutostart:
 * @network: a network object
5382
 * @autostart: the value returned
5383
 *
5384
 * Provides a boolean value indicating whether the network
5385 5386 5387 5388 5389 5390 5391
 * 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,
5392 5393 5394
                       int *autostart)
{
    virConnectPtr conn;
5395
    DEBUG("network=%p, autostart=%p", network, autostart);
5396

5397 5398 5399
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5400
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5401 5402 5403 5404
        return (-1);
    }
    if (!autostart) {
        virLibNetworkError(network, VIR_ERR_INVALID_ARG, __FUNCTION__);
5405
        goto error;
5406 5407
    }

5408 5409
    conn = network->conn;

5410 5411 5412 5413 5414 5415 5416
    if (conn->networkDriver && conn->networkDriver->networkGetAutostart) {
        int ret;
        ret = conn->networkDriver->networkGetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5417

5418
    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
5419 5420 5421 5422

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(network->conn);
5423
    return -1;
5424 5425 5426 5427 5428
}

/**
 * virNetworkSetAutostart:
 * @network: a network object
5429
 * @autostart: whether the network should be automatically started 0 or 1
5430 5431 5432 5433 5434 5435 5436 5437
 *
 * 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,
5438 5439 5440
                       int autostart)
{
    virConnectPtr conn;
5441
    DEBUG("network=%p, autostart=%d", network, autostart);
5442

5443 5444 5445
    virResetLastError();

    if (!VIR_IS_CONNECTED_NETWORK(network)) {
5446
        virLibNetworkError(NULL, VIR_ERR_INVALID_NETWORK, __FUNCTION__);
5447 5448 5449
        return (-1);
    }

5450 5451
    if (network->conn->flags & VIR_CONNECT_RO) {
        virLibNetworkError(network, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
5452
        goto error;
5453 5454
    }

5455 5456
    conn = network->conn;

5457 5458 5459 5460 5461 5462 5463
    if (conn->networkDriver && conn->networkDriver->networkSetAutostart) {
        int ret;
        ret = conn->networkDriver->networkSetAutostart (network, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
5464

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

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

D
Daniel Veillard 已提交
5473 5474
/**
 * virInterfaceGetConnect:
D
Daniel Veillard 已提交
5475
 * @iface: pointer to a interface
D
Daniel Veillard 已提交
5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487
 *
 * 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
5488
virInterfaceGetConnect (virInterfacePtr iface)
D
Daniel Veillard 已提交
5489
{
5490
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5491 5492 5493

    virResetLastError();

5494
    if (!VIR_IS_CONNECTED_INTERFACE (iface)) {
D
Daniel Veillard 已提交
5495 5496 5497
        virLibInterfaceError (NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return NULL;
    }
5498
    return iface->conn;
D
Daniel Veillard 已提交
5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 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 5595 5596 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 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
}

/**
 * virConnectNumOfInterfaces:
 * @conn: pointer to the hypervisor connection
 *
 * Provides the number of interfaces on the physical host.
 *
 * Returns the number of interface found or -1 in case of error
 */
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
 *
 * Collect the list of physical host interfaces, and store their names in @names
 *
 * 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;
}

/**
 * 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:
5666
 * @iface: a interface object
D
Daniel Veillard 已提交
5667 5668 5669 5670 5671 5672 5673
 *
 * 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 *
5674
virInterfaceGetName(virInterfacePtr iface)
D
Daniel Veillard 已提交
5675
{
5676
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5677 5678 5679

    virResetLastError();

5680
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5681 5682 5683
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5684
    return (iface->name);
D
Daniel Veillard 已提交
5685 5686 5687 5688
}

/**
 * virInterfaceGetMACString:
5689
 * @iface: a interface object
D
Daniel Veillard 已提交
5690 5691 5692 5693 5694 5695 5696 5697 5698
 *
 * 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 *
5699
virInterfaceGetMACString(virInterfacePtr iface)
D
Daniel Veillard 已提交
5700
{
5701
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5702 5703 5704

    virResetLastError();

5705
    if (!VIR_IS_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5706 5707 5708
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
5709
    return (iface->mac);
D
Daniel Veillard 已提交
5710 5711 5712 5713
}

/**
 * virInterfaceGetXMLDesc:
5714
 * @iface: a interface object
D
Daniel Veillard 已提交
5715 5716 5717 5718 5719 5720 5721 5722 5723
 * @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 *
5724
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5725 5726
{
    virConnectPtr conn;
5727
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5728 5729 5730

    virResetLastError();

5731
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5732 5733 5734 5735
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
5736
        virLibInterfaceError(iface, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
5737 5738 5739
        goto error;
    }

5740
    conn = iface->conn;
D
Daniel Veillard 已提交
5741 5742 5743

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceGetXMLDesc) {
        char *ret;
5744
        ret = conn->interfaceDriver->interfaceGetXMLDesc (iface, flags);
D
Daniel Veillard 已提交
5745 5746 5747 5748 5749 5750 5751 5752 5753
        if (!ret)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5754
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
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 5801 5802 5803 5804 5805
    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:
5806
 * @iface: pointer to a defined interface
D
Daniel Veillard 已提交
5807 5808 5809 5810 5811 5812 5813
 *
 * 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
5814
virInterfaceUndefine(virInterfacePtr iface) {
D
Daniel Veillard 已提交
5815
    virConnectPtr conn;
5816
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5817 5818 5819

    virResetLastError();

5820
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5821 5822 5823
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
5824
    conn = iface->conn;
D
Daniel Veillard 已提交
5825
    if (conn->flags & VIR_CONNECT_RO) {
5826
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
5827 5828 5829 5830 5831
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceUndefine) {
        int ret;
5832
        ret = conn->interfaceDriver->interfaceUndefine (iface);
D
Daniel Veillard 已提交
5833 5834 5835 5836 5837 5838 5839 5840 5841
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5842
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5843 5844 5845 5846 5847
    return -1;
}

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

    virResetLastError();

5863
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5864 5865 5866
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
5867
    conn = iface->conn;
D
Daniel Veillard 已提交
5868
    if (conn->flags & VIR_CONNECT_RO) {
5869
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
5870 5871 5872 5873 5874
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceCreate) {
        int ret;
5875
        ret = conn->interfaceDriver->interfaceCreate (iface, flags);
D
Daniel Veillard 已提交
5876 5877 5878 5879 5880 5881 5882 5883 5884
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5885
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5886 5887 5888 5889 5890
    return -1;
}

/**
 * virInterfaceDestroy:
5891
 * @iface: an interface object
D
Daniel Veillard 已提交
5892 5893 5894 5895 5896 5897 5898 5899 5900
 * @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
5901
virInterfaceDestroy(virInterfacePtr iface, unsigned int flags)
D
Daniel Veillard 已提交
5902 5903
{
    virConnectPtr conn;
5904
    DEBUG("iface=%p, flags=%d", iface, flags);
D
Daniel Veillard 已提交
5905 5906 5907

    virResetLastError();

5908
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5909 5910 5911 5912
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }

5913
    conn = iface->conn;
D
Daniel Veillard 已提交
5914
    if (conn->flags & VIR_CONNECT_RO) {
5915
        virLibInterfaceError(iface, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
D
Daniel Veillard 已提交
5916 5917 5918 5919 5920
        goto error;
    }

    if (conn->interfaceDriver && conn->interfaceDriver->interfaceDestroy) {
        int ret;
5921
        ret = conn->interfaceDriver->interfaceDestroy (iface, flags);
D
Daniel Veillard 已提交
5922 5923 5924 5925 5926 5927 5928 5929 5930
        if (ret < 0)
            goto error;
        return ret;
    }

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

error:
    /* Copy to connection error object for back compatability */
5931
    virSetConnError(iface->conn);
D
Daniel Veillard 已提交
5932 5933 5934 5935 5936
    return -1;
}

/**
 * virInterfaceRef:
5937
 * @iface: the interface to hold a reference on
D
Daniel Veillard 已提交
5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952
 *
 * 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
5953
virInterfaceRef(virInterfacePtr iface)
D
Daniel Veillard 已提交
5954
{
5955
    if ((!VIR_IS_CONNECTED_INTERFACE(iface))) {
D
Daniel Veillard 已提交
5956 5957 5958
        virLibConnError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
        return(-1);
    }
5959 5960 5961 5962
    virMutexLock(&iface->conn->lock);
    DEBUG("iface=%p refs=%d", iface, iface->refs);
    iface->refs++;
    virMutexUnlock(&iface->conn->lock);
D
Daniel Veillard 已提交
5963 5964 5965 5966 5967
    return 0;
}

/**
 * virInterfaceFree:
5968
 * @iface: a interface object
D
Daniel Veillard 已提交
5969 5970 5971 5972 5973 5974 5975
 *
 * 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
5976
virInterfaceFree(virInterfacePtr iface)
D
Daniel Veillard 已提交
5977
{
5978
    DEBUG("iface=%p", iface);
D
Daniel Veillard 已提交
5979 5980 5981

    virResetLastError();

5982
    if (!VIR_IS_CONNECTED_INTERFACE(iface)) {
D
Daniel Veillard 已提交
5983 5984 5985
        virLibInterfaceError(NULL, VIR_ERR_INVALID_INTERFACE, __FUNCTION__);
        return (-1);
    }
5986
    if (virUnrefInterface(iface) < 0)
D
Daniel Veillard 已提交
5987 5988 5989 5990
        return (-1);
    return(0);
}

5991 5992 5993

/**
 * virStoragePoolGetConnect:
5994
 * @pool: pointer to a pool
5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010
 *
 * 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);

6011 6012 6013
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL (pool)) {
6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032
        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);

6033 6034
    virResetLastError();

6035 6036 6037 6038 6039
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6040 6041 6042 6043 6044 6045 6046
    if (conn->storageDriver && conn->storageDriver->numOfPools) {
        int ret;
        ret = conn->storageDriver->numOfPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6047 6048

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6049 6050 6051 6052

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074
    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);

6075 6076
    virResetLastError();

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

6087 6088 6089 6090 6091 6092 6093
    if (conn->storageDriver && conn->storageDriver->listPools) {
        int ret;
        ret = conn->storageDriver->listPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6094 6095 6096

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6097 6098 6099 6100
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return -1;
6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116
}


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

6117 6118
    virResetLastError();

6119 6120 6121 6122 6123
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }

6124 6125 6126 6127 6128 6129 6130
    if (conn->storageDriver && conn->storageDriver->numOfDefinedPools) {
        int ret;
        ret = conn->storageDriver->numOfDefinedPools (conn);
        if (ret < 0)
            goto error;
        return ret;
    }
6131 6132

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6133 6134 6135 6136

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159
    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);

6160 6161
    virResetLastError();

6162 6163 6164 6165 6166 6167 6168
    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__);
6169
        goto error;
6170 6171
    }

6172 6173 6174 6175 6176 6177 6178
    if (conn->storageDriver && conn->storageDriver->listDefinedPools) {
        int ret;
        ret = conn->storageDriver->listDefinedPools (conn, names, maxnames);
        if (ret < 0)
            goto error;
        return ret;
    }
6179 6180

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6181 6182 6183 6184

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6185 6186 6187 6188
    return -1;
}


6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215
/**
 * 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)
{
6216 6217 6218 6219
    DEBUG("conn=%p, type=%s, src=%s, flags=%u", conn, type ? type : "", srcSpec ? srcSpec : "", flags);

    virResetLastError();

6220 6221
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
6222
        goto error;
6223 6224 6225
    }
    if (type == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6226
        goto error;
6227 6228
    }

6229 6230
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6231
        goto error;
6232 6233
    }

6234 6235 6236 6237 6238 6239 6240
    if (conn->storageDriver && conn->storageDriver->findPoolSources) {
        char *ret;
        ret = conn->storageDriver->findPoolSources(conn, type, srcSpec, flags);
        if (!ret)
            goto error;
        return ret;
    }
6241 6242

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

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


6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265
/**
 * 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);

6266 6267
    virResetLastError();

6268 6269 6270 6271 6272 6273
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6274
        goto error;
6275 6276
    }

6277 6278 6279 6280 6281 6282 6283
    if (conn->storageDriver && conn->storageDriver->poolLookupByName) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
6284 6285

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6286 6287 6288 6289

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308
    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);

6309 6310
    virResetLastError();

6311 6312 6313 6314 6315 6316
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (uuid == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6317
        goto error;
6318 6319
    }

6320 6321 6322 6323 6324 6325 6326
    if (conn->storageDriver && conn->storageDriver->poolLookupByUUID) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolLookupByUUID (conn, uuid);
        if (!ret)
            goto error;
        return ret;
    }
6327 6328 6329

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


/**
 * 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,
6348
                                 const char *uuidstr)
6349 6350 6351 6352
{
    unsigned char uuid[VIR_UUID_BUFLEN];
    DEBUG("conn=%p, uuidstr=%s", conn, uuidstr);

6353 6354
    virResetLastError();

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

    if (virUUIDParse(uuidstr, uuid) < 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6366
        goto error;
6367 6368 6369
    }

    return virStoragePoolLookupByUUID(conn, uuid);
6370 6371 6372 6373 6374

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390
}


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

6391 6392 6393
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_VOL(vol)) {
6394 6395 6396 6397
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }

6398 6399 6400 6401 6402 6403 6404
    if (vol->conn->storageDriver && vol->conn->storageDriver->poolLookupByVolume) {
        virStoragePoolPtr ret;
        ret = vol->conn->storageDriver->poolLookupByVolume (vol);
        if (!ret)
            goto error;
        return ret;
    }
6405 6406 6407

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

6408 6409 6410 6411
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
6412 6413 6414 6415 6416 6417
}

/**
 * virStoragePoolCreateXML:
 * @conn: pointer to hypervisor connection
 * @xmlDesc: XML description for new pool
6418
 * @flags: future flags, use 0 for now
6419 6420
 *
 * Create a new storage based on its XML description. The
D
Daniel Veillard 已提交
6421
 * pool is not persistent, so its definition will disappear
6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432
 * 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);

6433 6434
    virResetLastError();

6435 6436 6437 6438 6439 6440
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (xmlDesc == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6441
        goto error;
6442 6443 6444
    }
    if (conn->flags & VIR_CONNECT_RO) {
        virLibConnError(conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
6445
        goto error;
6446 6447
    }

6448 6449 6450 6451 6452 6453 6454
    if (conn->storageDriver && conn->storageDriver->poolCreateXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolCreateXML (conn, xmlDesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
6455 6456

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6457 6458 6459 6460

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
6461 6462 6463 6464 6465 6466 6467
    return NULL;
}

/**
 * virStoragePoolDefineXML:
 * @conn: pointer to hypervisor connection
 * @xml: XML description for new pool
6468
 * @flags: future flags, use 0 for now
6469 6470
 *
 * Define a new inactive storage pool based on its XML description. The
D
Daniel Veillard 已提交
6471
 * pool is persistent, until explicitly undefined.
6472 6473 6474 6475 6476 6477 6478 6479 6480 6481
 *
 * 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);

6482 6483
    virResetLastError();

6484 6485 6486 6487 6488 6489
    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__);
6490
        goto error;
6491 6492 6493
    }
    if (xml == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
6494
        goto error;
6495 6496
    }

6497 6498 6499 6500 6501 6502 6503
    if (conn->storageDriver && conn->storageDriver->poolDefineXML) {
        virStoragePoolPtr ret;
        ret = conn->storageDriver->poolDefineXML (conn, xml, flags);
        if (!ret)
            goto error;
        return ret;
    }
6504 6505 6506

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6507 6508 6509 6510
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
    return NULL;
6511 6512 6513 6514 6515
}

/**
 * virStoragePoolBuild:
 * @pool: pointer to storage pool
6516
 * @flags: future flags, use 0 for now
6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528
 *
 * 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);

6529 6530
    virResetLastError();

6531 6532 6533 6534 6535 6536 6537
    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__);
6538
        goto error;
6539 6540
    }

6541 6542 6543 6544 6545 6546 6547
    if (conn->storageDriver && conn->storageDriver->poolBuild) {
        int ret;
        ret = conn->storageDriver->poolBuild (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6548 6549 6550

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6551 6552 6553 6554
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571
}


/**
 * virStoragePoolUndefine:
 * @pool: pointer to storage pool
 *
 * Undefine an inactive storage pool
 *
 * Returns a virStoragePoolPtr object, or NULL if creation failed
 */
int
virStoragePoolUndefine(virStoragePoolPtr pool)
{
    virConnectPtr conn;
    DEBUG("pool=%p", pool);

6572 6573
    virResetLastError();

6574 6575 6576 6577 6578 6579 6580
    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__);
6581
        goto error;
6582 6583
    }

6584 6585 6586 6587 6588 6589 6590
    if (conn->storageDriver && conn->storageDriver->poolUndefine) {
        int ret;
        ret = conn->storageDriver->poolUndefine (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
6591 6592 6593

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6594 6595 6596 6597
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6598 6599 6600 6601 6602 6603
}


/**
 * virStoragePoolCreate:
 * @pool: pointer to storage pool
6604
 * @flags: future flags, use 0 for now
6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616
 *
 * 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);

6617 6618
    virResetLastError();

6619 6620 6621 6622 6623 6624 6625
    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__);
6626
        goto error;
6627 6628
    }

6629 6630 6631 6632 6633 6634 6635
    if (conn->storageDriver && conn->storageDriver->poolCreate) {
        int ret;
        ret = conn->storageDriver->poolCreate (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6636 6637 6638

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6639 6640 6641 6642
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663
}


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

6664 6665
    virResetLastError();

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

6677 6678 6679 6680 6681 6682 6683
    if (conn->storageDriver && conn->storageDriver->poolDestroy) {
        int ret;
        ret = conn->storageDriver->poolDestroy (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
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);
6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710
    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);

6711 6712
    virResetLastError();

6713 6714 6715 6716 6717 6718 6719 6720
    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__);
6721
        goto error;
6722 6723
    }

6724 6725 6726 6727 6728 6729 6730
    if (conn->storageDriver && conn->storageDriver->poolDelete) {
        int ret;
        ret = conn->storageDriver->poolDelete (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6731 6732

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6733 6734 6735 6736

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754
    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);

6755 6756 6757
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
6758 6759 6760 6761 6762 6763 6764 6765 6766 6767
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStoragePool(pool) < 0)
        return (-1);
    return(0);

}


6768 6769
/**
 * virStoragePoolRef:
D
Daniel Veillard 已提交
6770
 * @pool: the pool to hold a reference on
6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781
 *
 * 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 已提交
6782 6783
 *
 * Returns 0 in case of success, -1 in case of failure.
6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798
 */
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;
}

6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816
/**
 * 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);

6817 6818
    virResetLastError();

6819 6820 6821 6822 6823 6824 6825 6826
    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__);
6827
        goto error;
6828 6829
    }

6830 6831 6832 6833 6834 6835 6836
    if (conn->storageDriver && conn->storageDriver->poolRefresh) {
        int ret;
        ret = conn->storageDriver->poolRefresh (pool, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
6837 6838

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
6839 6840 6841 6842

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

6860 6861
    virResetLastError();

6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884
    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);

6885 6886
    virResetLastError();

6887 6888 6889 6890 6891 6892
    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__);
6893
        goto error;
6894 6895 6896 6897 6898 6899
    }

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

    return (0);

6900 6901 6902 6903
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921
}

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

6922 6923
    virResetLastError();

6924 6925 6926 6927 6928 6929
    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__);
6930
        goto error;
6931 6932 6933
    }

    if (virStoragePoolGetUUID(pool, &uuid[0]))
6934
        goto error;
6935 6936 6937 6938

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

6939 6940 6941 6942
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962
}


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

6963 6964
    virResetLastError();

6965 6966 6967 6968 6969 6970
    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__);
6971
        goto error;
6972 6973 6974 6975 6976 6977
    }

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

    conn = pool->conn;

6978 6979 6980 6981 6982 6983 6984
    if (conn->storageDriver->poolGetInfo) {
        int ret;
        ret = conn->storageDriver->poolGetInfo (pool, info);
        if (ret < 0)
            goto error;
        return ret;
    }
6985 6986 6987

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

6988 6989 6990 6991
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
    return -1;
6992 6993 6994 6995 6996 6997
}


/**
 * virStoragePoolGetXMLDesc:
 * @pool: pointer to storage pool
6998
 * @flags: flags for XML format options (set of virDomainXMLFlags)
6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012
 *
 * 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);

7013 7014 7015
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7016 7017 7018 7019 7020
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (NULL);
    }
    if (flags != 0) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7021
        goto error;
7022 7023 7024 7025
    }

    conn = pool->conn;

7026 7027 7028 7029 7030 7031 7032
    if (conn->storageDriver && conn->storageDriver->poolGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->poolGetXMLDesc (pool, flags);
        if (!ret)
            goto error;
        return ret;
    }
7033 7034 7035

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

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


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

7060 7061 7062
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7063 7064 7065 7066 7067
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }
    if (!autostart) {
        virLibStoragePoolError(pool, VIR_ERR_INVALID_ARG, __FUNCTION__);
7068
        goto error;
7069 7070 7071 7072
    }

    conn = pool->conn;

7073 7074 7075 7076 7077 7078 7079
    if (conn->storageDriver && conn->storageDriver->poolGetAutostart) {
        int ret;
        ret = conn->storageDriver->poolGetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7080 7081

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7082 7083 7084 7085

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105
    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);

7106 7107 7108
    virResetLastError();

    if (!VIR_IS_CONNECTED_STORAGE_POOL(pool)) {
7109
        virLibStoragePoolError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7110
        goto error;
7111 7112
    }

7113 7114
    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibStoragePoolError(pool, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7115
        goto error;
7116 7117
    }

7118 7119
    conn = pool->conn;

7120 7121 7122 7123 7124 7125 7126
    if (conn->storageDriver && conn->storageDriver->poolSetAutostart) {
        int ret;
        ret = conn->storageDriver->poolSetAutostart (pool, autostart);
        if (ret < 0)
            goto error;
        return ret;
    }
7127 7128

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7129 7130 7131 7132

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149
    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);

7150 7151
    virResetLastError();

7152 7153 7154 7155 7156
    if (!VIR_IS_STORAGE_POOL(pool)) {
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
        return (-1);
    }

7157 7158 7159 7160 7161 7162 7163
    if (pool->conn->storageDriver && pool->conn->storageDriver->poolNumOfVolumes) {
        int ret;
        ret = pool->conn->storageDriver->poolNumOfVolumes (pool);
        if (ret < 0)
            goto error;
        return ret;
    }
7164 7165

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7166 7167 7168 7169

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

7192 7193
    virResetLastError();

7194 7195 7196 7197 7198 7199 7200
    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__);
7201
        goto error;
7202 7203
    }

7204 7205 7206 7207 7208 7209 7210
    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;
    }
7211 7212

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7213 7214 7215 7216

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7217 7218 7219 7220 7221 7222
    return -1;
}


/**
 * virStorageVolGetConnect:
7223
 * @vol: pointer to a pool
7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239
 *
 * 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);

7240 7241
    virResetLastError();

7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265
    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);

7266 7267
    virResetLastError();

7268 7269 7270 7271 7272 7273
    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__);
7274
        goto error;
7275 7276
    }

7277 7278 7279 7280 7281 7282 7283
    if (pool->conn->storageDriver && pool->conn->storageDriver->volLookupByName) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volLookupByName (pool, name);
        if (!ret)
            goto error;
        return ret;
    }
7284 7285

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7286 7287 7288 7289

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(pool->conn);
7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310
    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);

7311 7312
    virResetLastError();

7313 7314 7315 7316 7317 7318
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (key == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7319
        goto error;
7320 7321
    }

7322 7323 7324 7325 7326 7327 7328
    if (conn->storageDriver && conn->storageDriver->volLookupByKey) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByKey (conn, key);
        if (!ret)
            goto error;
        return ret;
    }
7329 7330

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7331 7332 7333 7334

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353
    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);

7354 7355
    virResetLastError();

7356 7357 7358 7359 7360 7361
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (NULL);
    }
    if (path == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7362
        goto error;
7363 7364
    }

7365 7366 7367 7368 7369 7370 7371
    if (conn->storageDriver && conn->storageDriver->volLookupByPath) {
        virStorageVolPtr ret;
        ret = conn->storageDriver->volLookupByPath (conn, path);
        if (!ret)
            goto error;
        return ret;
    }
7372 7373

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7374 7375 7376 7377

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395
    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);

7396 7397
    virResetLastError();

7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410
    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
7411
 * unique, so the same volume will have the same
7412 7413 7414 7415 7416 7417 7418 7419 7420
 * 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);

7421 7422
    virResetLastError();

7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449
    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);

7450 7451
    virResetLastError();

7452
    if (!VIR_IS_STORAGE_POOL(pool)) {
7453
        virLibConnError(NULL, VIR_ERR_INVALID_STORAGE_POOL, __FUNCTION__);
7454 7455 7456 7457 7458
        return (NULL);
    }

    if (pool->conn->flags & VIR_CONNECT_RO) {
        virLibConnError(pool->conn, VIR_ERR_OPERATION_DENIED, __FUNCTION__);
7459
        goto error;
7460 7461
    }

7462 7463 7464 7465 7466 7467 7468
    if (pool->conn->storageDriver && pool->conn->storageDriver->volCreateXML) {
        virStorageVolPtr ret;
        ret = pool->conn->storageDriver->volCreateXML (pool, xmldesc, flags);
        if (!ret)
            goto error;
        return ret;
    }
7469 7470

    virLibConnError (pool->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7471 7472 7473 7474

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


7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537
/**
 * 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;
}


7538 7539 7540
/**
 * virStorageVolDelete:
 * @vol: pointer to storage volume
7541
 * @flags: future flags, use 0 for now
7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553
 *
 * 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);

7554 7555
    virResetLastError();

7556 7557 7558 7559 7560 7561 7562 7563
    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__);
7564
        goto error;
7565 7566
    }

7567 7568 7569 7570 7571 7572 7573
    if (conn->storageDriver && conn->storageDriver->volDelete) {
        int ret;
        ret = conn->storageDriver->volDelete (vol, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7574 7575

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7576 7577 7578 7579

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7580 7581 7582 7583 7584 7585 7586 7587 7588
    return -1;
}


/**
 * virStorageVolFree:
 * @vol: pointer to storage volume
 *
 * Release the storage volume handle. The underlying
7589
 * storage volume continues to exist.
7590 7591 7592 7593 7594 7595 7596 7597
 *
 * Return 0 on success, or -1 on error
 */
int
virStorageVolFree(virStorageVolPtr vol)
{
    DEBUG("vol=%p", vol);

7598 7599
    virResetLastError();

7600 7601 7602 7603 7604 7605 7606 7607 7608 7609
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (-1);
    }
    if (virUnrefStorageVol(vol) < 0)
        return (-1);
    return(0);
}


7610 7611
/**
 * virStorageVolRef:
D
Daniel Veillard 已提交
7612
 * @vol: the vol to hold a reference on
7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623
 *
 * 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 已提交
7624 7625
 *
 * Returns 0 in case of success, -1 in case of failure.
7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640
 */
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;
}

7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657
/**
 * 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);

7658 7659
    virResetLastError();

7660 7661 7662 7663 7664 7665
    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__);
7666
        goto error;
7667 7668 7669 7670 7671 7672
    }

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

    conn = vol->conn;

7673 7674 7675 7676 7677 7678 7679
    if (conn->storageDriver->volGetInfo){
        int ret;
        ret = conn->storageDriver->volGetInfo (vol, info);
        if (ret < 0)
            goto error;
        return ret;
    }
7680 7681

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7682 7683 7684 7685

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706
    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);

7707 7708
    virResetLastError();

7709 7710 7711 7712 7713 7714
    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__);
7715
        goto error;
7716 7717 7718 7719
    }

    conn = vol->conn;

7720 7721 7722 7723 7724 7725 7726
    if (conn->storageDriver && conn->storageDriver->volGetXMLDesc) {
        char *ret;
        ret = conn->storageDriver->volGetXMLDesc (vol, flags);
        if (!ret)
            goto error;
        return ret;
    }
7727 7728 7729

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);

7730 7731 7732 7733
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
    return NULL;
7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754
}


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

7755 7756
    virResetLastError();

7757 7758 7759 7760 7761 7762 7763
    if (!VIR_IS_STORAGE_VOL(vol)) {
        virLibStorageVolError(NULL, VIR_ERR_INVALID_STORAGE_VOL, __FUNCTION__);
        return (NULL);
    }

    conn = vol->conn;

7764 7765 7766 7767 7768 7769 7770
    if (conn->storageDriver && conn->storageDriver->volGetPath) {
        char *ret;
        ret = conn->storageDriver->volGetPath (vol);
        if (!ret)
            goto error;
        return ret;
    }
7771 7772

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7773 7774 7775 7776

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(vol->conn);
7777 7778
    return NULL;
}
7779 7780


7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796
/**
 * 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 已提交
7797
    DEBUG("conn=%p, cap=%s, flags=%d", conn, NULLSTR(cap), flags);
7798

7799 7800
    virResetLastError();

7801 7802 7803 7804 7805 7806
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (flags != 0) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7807
        goto error;
7808 7809
    }

7810 7811 7812 7813 7814 7815 7816
    if (conn->deviceMonitor && conn->deviceMonitor->numOfDevices) {
        int ret;
        ret = conn->deviceMonitor->numOfDevices (conn, cap, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7817 7818

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7819 7820 7821 7822

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850
    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);

7851 7852
    virResetLastError();

7853 7854 7855 7856 7857 7858
    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__);
7859
        goto error;
7860 7861
    }

7862 7863 7864 7865 7866 7867 7868
    if (conn->deviceMonitor && conn->deviceMonitor->listDevices) {
        int ret;
        ret = conn->deviceMonitor->listDevices (conn, cap, names, maxnames, flags);
        if (ret < 0)
            goto error;
        return ret;
    }
7869 7870

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7871 7872 7873 7874

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891
    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);

7892 7893
    virResetLastError();

7894 7895 7896 7897 7898 7899 7900
    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return NULL;
    }

    if (name == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
7901
        goto error;
7902 7903
    }

7904 7905 7906 7907 7908 7909 7910
    if (conn->deviceMonitor && conn->deviceMonitor->deviceLookupByName) {
        virNodeDevicePtr ret;
        ret = conn->deviceMonitor->deviceLookupByName (conn, name);
        if (!ret)
            goto error;
        return ret;
    }
7911 7912

    virLibConnError (conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7913 7914 7915 7916

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934
    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);

7935 7936
    virResetLastError();

7937 7938 7939 7940 7941
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7942 7943 7944 7945 7946 7947 7948
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceDumpXML) {
        char *ret;
        ret = dev->conn->deviceMonitor->deviceDumpXML (dev, flags);
        if (!ret)
            goto error;
        return ret;
    }
7949 7950

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
7951 7952 7953 7954

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
7955 7956 7957 7958 7959 7960 7961 7962
    return NULL;
}


/**
 * virNodeDeviceGetName:
 * @dev: the device
 *
D
Daniel Veillard 已提交
7963 7964 7965
 * Just return the device name
 *
 * Returns the device name or NULL in case of error
7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982
 */
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 已提交
7983 7984
 * Accessor for the parent of the device
 *
7985 7986 7987 7988 7989 7990 7991
 * 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);

7992 7993
    virResetLastError();

7994 7995 7996 7997 7998
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return NULL;
    }

7999 8000 8001 8002 8003
    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__);
8004
            virSetConnError(dev->conn);
8005 8006 8007 8008
            return NULL;
        }
    }
    return dev->parent;
8009 8010 8011 8012 8013 8014
}

/**
 * virNodeDeviceNumOfCaps:
 * @dev: the device
 *
D
Daniel Veillard 已提交
8015 8016
 * Accessor for the number of capabilities supported by the device.
 *
8017 8018 8019 8020 8021 8022
 * Returns the number of capabilities supported by the device.
 */
int virNodeDeviceNumOfCaps(virNodeDevicePtr dev)
{
    DEBUG("dev=%p, conn=%p", dev, dev ? dev->conn : NULL);

8023 8024
    virResetLastError();

8025 8026 8027 8028 8029
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8030 8031 8032 8033 8034 8035 8036
    if (dev->conn->deviceMonitor && dev->conn->deviceMonitor->deviceNumOfCaps) {
        int ret;
        ret = dev->conn->deviceMonitor->deviceNumOfCaps (dev);
        if (ret < 0)
            goto error;
        return ret;
    }
8037 8038

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8039 8040 8041 8042

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062
    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);

8063 8064
    virResetLastError();

8065 8066 8067 8068 8069
    if (!VIR_IS_CONNECTED_NODE_DEVICE(dev)) {
        virLibNodeDeviceError(NULL, VIR_ERR_INVALID_NODE_DEVICE, __FUNCTION__);
        return -1;
    }

8070 8071 8072 8073 8074 8075 8076
    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;
    }
8077 8078

    virLibConnError (dev->conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
8079 8080 8081 8082

error:
    /* Copy to connection error object for back compatability */
    virSetConnError(dev->conn);
8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099
    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);

8100 8101
    virResetLastError();

8102 8103 8104 8105 8106 8107 8108 8109 8110 8111
    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);
}


8112 8113
/**
 * virNodeDeviceRef:
D
Daniel Veillard 已提交
8114
 * @dev: the dev to hold a reference on
8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125
 *
 * 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 已提交
8126 8127
 *
 * Returns 0 in case of success, -1 in case of failure.
8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142
 */
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;
}

8143
/**
D
Daniel Veillard 已提交
8144
 * virNodeDeviceDettach:
8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158
 * @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 已提交
8159 8160
 *
 * Returns 0 in case of success, -1 in case of failure.
8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201
 */
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 已提交
8202 8203
 *
 * Returns 0 in case of success, -1 in case of failure.
8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246
 */
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 已提交
8247 8248
 *
 * Returns 0 in case of success, -1 in case of failure.
8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277
 */
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);
}

8278

8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 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 8337 8338 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
/**
 * 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;
}


8376 8377 8378 8379 8380 8381 8382 8383 8384
/*
 * 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 已提交
8385
 * @freecb: optional function to deallocate opaque when not used anymore
8386 8387 8388 8389
 *
 * Adds a Domain Event Callback.
 * Registering for a domain callback will enable delivery of the events
 *
8390 8391 8392 8393 8394 8395 8396
 * 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.
 *
8397 8398 8399 8400 8401
 * Returns 0 on success, -1 on failure
 */
int
virConnectDomainEventRegister(virConnectPtr conn,
                              virConnectDomainEventCallback cb,
8402 8403
                              void *opaque,
                              virFreeCallback freecb)
8404
{
8405 8406
    DEBUG("conn=%p, cb=%p, opaque=%p, freecb=%p", conn, cb, opaque, freecb);
    virResetLastError();
8407 8408 8409 8410 8411 8412 8413

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8414
        goto error;
8415 8416
    }

8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428
    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);
8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446
    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)
{
8447 8448 8449
    DEBUG("conn=%p, cb=%p", conn, cb);

    virResetLastError();
8450 8451 8452 8453 8454 8455 8456

    if (!VIR_IS_CONNECT(conn)) {
        virLibConnError(NULL, VIR_ERR_INVALID_CONN, __FUNCTION__);
        return (-1);
    }
    if (cb == NULL) {
        virLibConnError(conn, VIR_ERR_INVALID_ARG, __FUNCTION__);
8457 8458 8459 8460 8461 8462 8463 8464
        goto error;
    }
    if ((conn->driver) && (conn->driver->domainEventDeregister)) {
        int ret;
        ret = conn->driver->domainEventDeregister (conn, cb);
        if (ret < 0)
            goto error;
        return ret;
8465 8466
    }

8467 8468 8469 8470
    virLibConnError(conn, VIR_ERR_NO_SUPPORT, __FUNCTION__);
error:
    /* Copy to connection error object for back compatability */
    virSetConnError(conn);
8471 8472
    return -1;
}